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 $
*********************************************************************/


#ifndef DtFomClassMgr_H_
#define DtFomClassMgr_H_

#include <vlutil/vlFedTarget.h>
#include "attrInfo.h"
#include "spaceInfo.h"
#include "objClassInfo.h"
#include "intClassInfo.h"
#include "fedTargetHelper.h"
#include "attrInfo.h"
#include "RIDparams.h"
#include <set>
#include <map>
#include <mtl/xmlFedReader.h>
#include <vector>



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



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

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

   DtFomClassMgr(DtRIDParameters* params);

   DtFomClassMgr();

   DtFomClassMgr& operator=(const DtFomClassMgr& orig);

public:

    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);

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

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

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

   void addObjClass( const char* name, const char* baseName,      
      DtSharingType sharing, const MAKRti::DtString& semantics );

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

   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* attrName, 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 );

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

   virtual DtMergeFomStatus mergeInteractionClasses( DtFedTarget const& module );

   virtual DtMergeFomStatus mergeInteractionInfo( DtInteractionClassInfo const & interInfo,
      const char* spaceName = 0);

   virtual void mergeParameters( DtInteractionClassInfo const& interInfo );

   virtual DtMergeFomStatus mergeSpaces( DtFedTarget const& module );

   virtual DtMergeFomStatus mergeDimensions( DtSpaceInfo const& spaceInfo );

   virtual DtMergeFomStatus mergeSwitches( DtFedTarget const& module );
    
   //-------------------------------------------------------------------------
   //-------------------------------------------------------------------------

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

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

   virtual const char* className (
      DtObjectClassHandle theHandle,
      bool throwException=true);

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

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

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

   virtual DtObjectClassInfo* classByHandle(
      DtObjectClassHandle handle) const;

   virtual DtObjectClassInfo* objectRootClass() const;

   virtual DtObjectClassHandle objectRootHandle() const;

   virtual int numClasses() const;

   //------------------------------------------- Regions 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);

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

   virtual DtDimensionHandleSet const &
   getAvailableDimensionsForInteractionClass(
      DtInteractionClassHandle passedInClassHandle);

   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) const;

   virtual DtInteractionClassInfo* interactionByHandle(
      DtInteractionClassHandle handle) const;

   virtual DtInteractionClassInfo* interactionRootClass() const;

   virtual DtInteractionClassHandle interactionRootHandle() const;

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

   virtual const char* interactionName (
      DtInteractionClassHandle theHandle,
      bool throwException=true);

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

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

   virtual int numInteractions() const;

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

   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);


   // 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 addInterClassSorted( const char* name,
      const char* baseName, MAKRti::DtTransportType transport, MAKRti::DtOrderType order,
      DtSpaceHandle spaceH, DtInteractionClassInfo* baseClass, 
      DtSharingType sharing,
      const MAKRti::DtString& semantics );
   virtual void addInterClassUnsorted( const char* name,
      const char* baseName, MAKRti::DtTransportType transport, MAKRti::DtOrderType order,
      DtSpaceHandle spaceH, DtInteractionClassInfo* baseClass, 
      DtSharingType sharing, const MAKRti::DtString& semantics );

   void addObjClassSorted( const char* name,
      const char* baseName, DtSharingType sharing, 
      const MAKRti::DtString& semantics, DtObjectClassInfo* baseClass );
   void addObjClassUnsorted( const char* name,
      const char* baseName, DtSharingType sharing,
      const MAKRti::DtString& semantics, DtObjectClassInfo* baseClass );

   bool objectClassPresent(const char* name, 
                           unsigned int startIndex = 0,
                           unsigned int endIndex = 0 ) const;

   bool attrPresent( const char *name, 
                     DtObjectClassInfo* classInfo,
                     unsigned int startIndex = 0,
                     unsigned int endIndex = 0 ) const;

   bool interactionClassPresent(const char* name, 
                                unsigned int startIndex = 0,
                                unsigned int endIndex = 0 ) const;

   unsigned int objectClassPosition( const char* name, 
                                     unsigned int startIndex = 0, 
                                     unsigned int endIndex = 0 ) const;

   unsigned int interactionClassPosition( const char* name,
                                          unsigned int startIndex = 0,
                                          unsigned int endIndex = 0 ) const;

   bool resolveAttributeDimensions(MAKRti::DtString & errorString);
   bool resolveObjectClasses(MAKRti::DtString & errorString);
   bool resolveInteractionClasses(MAKRti::DtString & errorString);
   bool resolveAttributes(MAKRti::DtString & errorString);
   bool resolveParameters(MAKRti::DtString & errorString);
   bool resolveDimensions(MAKRti::DtString & errorString);

protected:

   DtObjectClassVector myClasses;

   int myFirstMomObjectHandle;

   DtInteractionClassVector myInteractions;

   int myFirstMomInteractionHandle;

#ifdef DDM

   DtSpaceVector mySpaces;

   DtSpaceHandle myFirstSpaceHandle;
#endif

   bool my13and1516interop;

   bool myEnableFomBackwardsCompatibility;

//    //! Indicates a FOM module merge is taking place
//    bool myMergingFomModule;


   bool myOverrideConveyRegions;

   mutable DtObjectClassHandle myMutableLastObjClassLookup;

   mutable DtInteractionClassHandle myMutableLastInterClassLookup;

protected:

   static DtFomClassMgrCreator theCreator;
};

#endif