fomMgr.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 1998 MaK Technologies, Inc.
** All rights reserved.
*********************************************************************/
/*********************************************************************
** $RCSfile: fomMgr.h,v $ $Revision: 1.47 $ $State: Exp $
*********************************************************************/


#pragma once

#include <vlutil/vlFedTarget.h>

#include "attrInfo.h"
#include "spaceInfo.h"
#include "objClassInfo.h"
#include "intClassInfo.h"
#include "attrInfo.h"
#include "RIDparams.h"

#include <mtl/xmlFedReader.h>
#include <mtl/fedTargetHelper.h>
#ifdef _WIN32
#ifdef MAK_ENABLE_CRT_DEBUG
#include <vlutil/vlDebugCrt.h>
#endif
#endif

#include <vector>
#include <set>
#include <map>



class DtFomClassMgr;
class DtAttrInfo;
typedef std::vector<DtAttrInfo> DtAttrVector;
typedef DtFomClassMgr* (*DtFomClassMgrCreator)(DtRIDParameters* p);


#ifdef DDM
typedef std::vector<DtSpaceInfo> DtSpaceVector;
#endif

class DT_DLL_LRC DtFomClassMgr : public MAKRti::DtFedTarget
{
protected:

   DtFomClassMgr(DtRIDParameters* params);

   DtFomClassMgr& operator=(const DtFomClassMgr& orig);

public:

   DtFomClassMgr();

   DtFomClassMgr(const DtFomClassMgr& orig);

   virtual ~DtFomClassMgr();

   //-------------------------------------------------------------------------
   //-------------------------------------------------------------------------


   virtual void addSpace(const char* name);

   virtual void addDimension(const char* spaceName, const char* dimName);

   virtual void addDimension(const char* dimName, unsigned long upperBound,
      unsigned long defaultLowerBound, unsigned long defaultUpperBound,
      bool excluded, const MAKRti::DtString& normalization);

   virtual bool addInteractionDimension(const char* interactionName, const char* dimension);

   virtual bool addInteractionClass(const char* name, const char* baseName,
      MAKRti::DtTransportType transport, MAKRti::DtOrderType order,
      DtSharingType sharing, const MAKRti::DtString& semantics,
      const char* space=NULL);

   virtual bool addInterClass(const char* name, const char* baseName,
      MAKRti::DtTransportType transport, MAKRti::DtOrderType order,
      const char* spaceName = NULL );

   virtual bool addObjectDimension(const char* objectClassName, const char* dimension);

   virtual bool addObjectClass(const char* name, const char* baseName,
      DtSharingType sharing, const MAKRti::DtString& semantics );

   virtual bool addObjClass(const char* name, const char* baseName);

   virtual void addHandleForUnknownObjectClass(DtObjectClassHandle handle, DtObjectClassHandle baseClassHandle);

   virtual void addParameter(const char* className, const char* paramName);

   virtual void addParameter(const char* className,
      const char* paramName,
      const char* semantics );

   virtual bool addAttributeDimension(const char* className,
      const char* attributeName, const char* dimName);

   virtual void addAttribute(const char* className, const char* attrName,
      MAKRti::DtTransportType transport, MAKRti::DtOrderType order, DtSharingType sharing,
      DtFomUpdateType updateType, const MAKRti::DtString& updateCondition,
      DtOwnershipType ownershipType, const MAKRti::DtString& semantics,
      const char* spaceName=NULL );

   virtual void addAttribute(const char* className, const char* attrName,
      MAKRti::DtTransportType transport, MAKRti::DtOrderType order, const char* spaceName=NULL );

   virtual void initUpdateRates(DtRIDParameters* params) ;

   const MAKRti::DtUpdateRateSetT & getUpdateRates() const;

   float updateRateByName(const char * name);

   int positionOfRate(float rate) const;

   bool knownUpdateRate(const MAKRti::DtString& rateName) const;

   virtual DtMergeFomStatus mergeObjectClasses( DtFedTarget const& module );

   virtual DtMergeFomStatus mergeObjectInfo(DtObjectClassInfo const& classInfo, DtAttributeByHandleMap& attributesToMerge);

   virtual void mergeAttributes(DtObjectClassInfo const& classInfo, const DtAttributeByHandleMap& attributesToMerge,
      DtFomClassMgr const& module );

   virtual DtMergeFomStatus mergeInteractionClasses( DtFedTarget const& module );

   virtual DtMergeFomStatus mergeInteractionInfo( DtInteractionClassInfo const & interInfo, const char* spaceName,
      DtParameterByHandleMap& parametersToMerge);

   virtual void mergeParameters( DtInteractionClassInfo const& interInfo, const DtParameterByHandleMap& parametersToMerge);

   virtual DtMergeFomStatus mergeSpaces( DtFedTarget const& module );

   virtual DtMergeFomStatus mergeDimensions( DtSpaceInfo const& spaceInfo );

   //-------------------------------------------------------------------------
   //-------------------------------------------------------------------------

   //------------------------------------------- Object classes and attributes

   virtual DtObjectClassHandle classHandle (
      const char* theName,
      bool throwException=true) const;

   virtual const char* className (
      DtObjectClassHandle theHandle,
      const char* defaultName = "ObjectClassNotDefined") const;

   virtual DtObjectClassInfo* classByName(const char *name);
   virtual const DtObjectClassInfo* classByName(const char *name) const;

   virtual DtObjectClassInfo* classByHandle(DtObjectClassHandle handle);
   virtual const DtObjectClassInfo* classByHandle(DtObjectClassHandle handle) const;

   virtual DtObjectClassInfo* objectRootClass();
   virtual const DtObjectClassInfo* objectRootClass() const;

   virtual DtObjectClassHandle objectRootHandle() const;

   virtual int numClasses() const;

   virtual int firstFomObjectClassHandle();

   virtual int lastFomObjectClassHandle();

   virtual std::set<const DtObjectClassInfo*>& getObjectClassDifferences(const DtFomClassMgr& otherFom,
      std::set<const DtObjectClassInfo*>& diffSet) const;

   virtual std::set<const DtInteractionClassInfo*>& getInteractionClassDifferences(const DtFomClassMgr& otherFom,
      std::set<const DtInteractionClassInfo*>& diffSet) const;

   virtual DtAttributeHandle attrHandle(const char* theName, DtObjectClassHandle whichClass, bool throwException = true) const;

   virtual const char* attrName(DtAttributeHandle theHandle, DtObjectClassHandle whichClass, bool throwException = true) const;

   //------------------------------------------- Dimensions and spaces
#ifdef DDM
   virtual DtSpaceHandle spaceHandle(const char* theName, bool throwException=true) const;

   virtual const char* spaceName(DtSpaceHandle theHandle, bool throwException=true) const;

   virtual DtDimensionHandle dimHandle(const char* theName, DtSpaceHandle whichSpace, bool throwException=true) const;

   virtual const char* dimName(DtDimensionHandle   theHandle, DtSpaceHandle whichSpace, bool throwException=true) const;

   virtual unsigned long dimUpperBound(DtDimensionHandle   theHandle, DtSpaceHandle whichSpace, bool throwException=true) const;

   virtual DtDimensionHandleStdSet const& getAvailableDimensionsForObjectClass(
      DtObjectClassHandle passedInClassHandle) const;

   virtual DtDimensionHandleStdSet const & getAvailableDimensionsForClassAttribute(
      DtObjectClassHandle passedInClassHandle, DtAttributeHandle attrHandle) const;

   virtual DtDimensionHandleStdSet const& getAvailableDimensionsForInteractionClass(
      DtInteractionClassHandle passedInClassHandle) const;


   virtual DtSpaceInfo* spaceByName(const char *name);
   virtual const DtSpaceInfo* spaceByName(const char *name) const;


   virtual DtSpaceInfo* spaceByHandle(DtSpaceHandle handle);
   virtual const DtSpaceInfo* spaceByHandle(DtSpaceHandle handle) const;

   virtual int numSpaces() const;
#endif

   //------------------------------------------- Interactions and parameters


   virtual DtInteractionClassInfo* interactionByName(const char *name);
   virtual const DtInteractionClassInfo* interactionByName(const char *name) const;


   virtual DtInteractionClassInfo* interactionByHandle(DtInteractionClassHandle handle);
   virtual const DtInteractionClassInfo* interactionByHandle(DtInteractionClassHandle handle) const;


   virtual DtInteractionClassInfo* interactionRootClass();
   virtual const DtInteractionClassInfo* interactionRootClass() const;

   virtual DtInteractionClassHandle interactionRootHandle() const;

   virtual DtInteractionClassHandle interactionHandle(const char* theName, bool throwException=true) const;

   virtual const char* interactionName (DtInteractionClassHandle theHandle,
      const char* defaultName = "InteractionClassNotDefined") const;

   virtual int numInteractions() const;

   virtual int firstFomInteractionClassHandle();

   virtual int lastFomInteractionClassHandle();

   virtual void addHandleForUnknownInteractionClass(DtInteractionClassHandle handle, DtInteractionClassHandle baseClassHandle);

   virtual DtParameterHandle paramHandle(
      const char* theName,
      DtInteractionClassHandle whichClass,
      bool throwException = true);

   virtual const char* paramName(
      DtParameterHandle   theHandle,
      DtInteractionClassHandle whichClass,
      bool throwException = true);

   //-------------------------------------------------------------------------
   //-------------------------------------------------------------------------

   virtual void initDMFilteringParameters(const DtRIDParameters* params);
   virtual void printDMSubscriptions();

   //-------------------------------------------------------------------------
   //-------------------------------------------------------------------------

   virtual bool save(DtRtiSaveFile& file);

   virtual void prepareToRestore();

   virtual bool restore( DtRtiSaveFile& file );

   virtual void setExtend13and1516interop(bool enable);
   virtual bool extend13and1516interop() const;

   virtual void print() const;

   virtual DtFomClassMgr* clone();

   //-------------------------------------------------------------------------
   //-------------------------------------------------------------------------

   virtual void setConveyRegionDesignatorSets(bool value);

   virtual void addFedFileName(const MAKRti::DtString & name);
   virtual const MAKRti::DtNameVector& fedFiles() const;

   // TODO make this into a method getter/setter thingie
   unsigned long myCrc;

public:

   static DtFomClassMgr* create(DtRIDParameters* p);

   static void setCreatorFunction(DtFomClassMgrCreator fn);

protected:

   void init();

#ifdef DDM
   virtual void addSpaceSorted( const char* nameValue );
   virtual void addSpaceUnsorted( const char* nameValue );
#endif

   virtual void adjustInteractionHandlesByName(DtInteractionClassInfo* classInfo);

   virtual void adjustObjectHandlesByName(DtObjectClassInfo* classInfo);

   virtual DtMergeFomStatus mergeObjectDimensions(DtFomClassMgr const& module, DtObjectClassInfo const& objectInfo);

   virtual DtMergeFomStatus mergeInteractionDimensions(DtFomClassMgr const& module, DtInteractionClassInfo const& interInfo);



   virtual bool resolveObjectDimensions(MAKRti::DtString& errorString, bool& fomReadError);
   virtual bool resolveAttributeDimensions(MAKRti::DtString & errorString, bool& fomReadError);
   virtual bool resolveInteractionDimensions(MAKRti::DtString & errorString, bool& fomReadError);
   virtual bool resolveAttributeTransportations(MAKRti::DtString & errorString, bool& fomReadError);
   virtual bool resolveInteractionTransportations(MAKRti::DtString & errorString, bool& fomReadError);
   virtual bool resolveObjectClasses(MAKRti::DtString & errorString, bool& fomReadError);
   virtual bool resolveInteractionClasses(MAKRti::DtString & errorString, bool& fomReadError);
   virtual bool resolveAttributes(MAKRti::DtString & errorString, bool& fomReadError);
   virtual bool resolveParameters(MAKRti::DtString & errorString, bool& fomReadError);
   virtual bool resolveDimensions(MAKRti::DtString & errorString, bool& fomReadError);

   virtual void addAttrInfoToChildren(DtObjectClassInfo* classDesc,
      const MAKRti::DtString& attributeName,
      DtDimensionHandle dimensionHandle);

   virtual bool componentSortingIsActive() const;

protected:

   typedef std::map<DtObjectClassHandle, DtObjectClassInfo*> DtObjectClassByHandleMap;
   typedef std::map<MAKRti::DtString, DtObjectClassInfo*> DtObjectClassByNameMap;
   typedef std::map<DtInteractionClassHandle, DtInteractionClassInfo*> DtInteractionClassByHandleMap;
   typedef std::map<MAKRti::DtString, DtInteractionClassInfo*> DtInteractionClassByNameMap;

protected:

   DtObjectClassByHandleMap myObjectsByHandle;
   DtObjectClassByNameMap myObjectsByName;
   DtObjectClassByNameMap myObjectsExcludeMomByName;
   DtObjectClassByNameMap myObjectsMomByName;

   DtInteractionClassByHandleMap myInteractionsByHandle;
   DtInteractionClassByNameMap myInteractionsByName;
   DtInteractionClassByNameMap myInteractionsExcludeMomByName;
   DtInteractionClassByNameMap myInteractionsMomByName;

#ifdef DDM
   DtSpaceVector mySpaces;

   DtSpaceHandle myFirstSpaceHandle;
#endif

   bool my13and1516interop;

   bool myEnableComponentSorting;

   bool myMergingEnabled;

   // This is all FOM files merged in this target.  It includes the MIM and is in merge order.
   MAKRti::DtNameVector myFedFiles;

   bool myOverrideConveyRegions;

   const DtDimensionHandleStdSet myEmptyDimHandleSet;
protected:

   static const unsigned int theLastMomObjectHandle;

   static const unsigned int theLastMomInteractionHandle;

   static const unsigned int theInteractionRootHandle;

   static const unsigned int theObjectRootHandle;

   static DtFomClassMgrCreator theCreator;
};