momObserver.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2024 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: momObserver.h,v $ $Revision: 1.9 $ $State: Exp $
*******************************************************************************/


#pragma once

#ifdef DtMOM
#ifdef DtIFSPEC13

#include "ambObserver.h"
#include "momArgument.h"
class DtMomMgr;
class DtMomObserver;

typedef DtMomObserver* (*DtMomObserverCreator)(DtMomMgr* momMgrPtr);

class DtMomObserver : public DtRtiAmbassadorObserver
{
public:

   static DtMomObserver* create(DtMomMgr* momMgrPtr);
   static void setCreator(DtMomObserverCreator functionPtr);

   DtMomObserver(DtMomMgr* momMgrPtr);

   virtual ~DtMomObserver();

   DtMomObserver( const DtMomObserver& orig );
 
   DtMomObserver& operator=( const DtMomObserver& orig );

   virtual void reset();

   virtual unsigned long objectRegisterCount() const;

   virtual unsigned long objectDeleteCount() const;


   virtual void createFederationExecution(
      const char* executionName, 
      const char* FED, 
      RTI::Exception* except = 0 ); 

   virtual void destroyFederationExecution(
      const char* executionName, 
      RTI::Exception* except = 0 ); 

   virtual void joinFederationExecution(
      const char* yourName, 
      const char* executionName, 
      RTI::FederateAmbassador* federateAmbassadorReference, 
      RTI::FederateHandle& handle, 
      RTI::Exception* except = 0 ); 

   virtual void resignFederationExecution(
      RTI::ResignAction theAction, 
      RTI::Exception* except = 0 ); 

   virtual void registerFederationSynchronizationPoint(       
      const char* label,  
      const char* theTag, 
      RTI::Exception* except = 0 ); 

   virtual void registerFederationSynchronizationPoint(       
      const char* label,
      const char* theTag,
      const RTI::FederateHandleSet& syncSet, 
      RTI::Exception* except = 0 );

   virtual void synchronizationPointAchieved(      
      const char* label, 
      RTI::Exception* except = 0 );

   virtual void requestFederationSave(    
      const char* label,  
      const RTI::FedTime& theTime, 
      RTI::Exception* except = 0 );

   virtual void requestFederationSave( 
      const char* label, 
      RTI::Exception* except = 0 ); 

   virtual void federateSaveBegun( 
      RTI::Exception* except = 0 );

   virtual void federateSaveComplete( 
      RTI::Exception* except = 0 );

   virtual void federateSaveNotComplete( 
      RTI::Exception* except = 0 );

   virtual void requestFederationRestore(    
      const char* label, 
      RTI::Exception* except = 0 ); 

   virtual void federateRestoreComplete( 
      RTI::Exception* except = 0 );

   virtual void federateRestoreNotComplete( 
      RTI::Exception* except = 0 );



   virtual void publishObjectClass(
      RTI::ObjectClassHandle   theClass,  
      const RTI::AttributeHandleSet& attributeList, 
      RTI::Exception* except = 0 );

   virtual void unpublishObjectClass(
      RTI::ObjectClassHandle theClass, 
      RTI::Exception* except = 0 );

   virtual void publishInteractionClass(
      RTI::InteractionClassHandle theInteraction, 
      RTI::Exception* except = 0 );

   virtual void unpublishInteractionClass(
      RTI::InteractionClassHandle theInteraction, 
      RTI::Exception* except = 0 );

   virtual void subscribeObjectClassAttributes(
      RTI::ObjectClassHandle theClass,  
      const RTI::AttributeHandleSet& attributeList,
      RTI::Boolean active = RTI::RTI_TRUE, 
      RTI::Exception* except = 0 );

   virtual void unsubscribeObjectClass(
      RTI::ObjectClassHandle theClass, 
      RTI::Exception* except = 0 );

   virtual void subscribeInteractionClass(
      RTI::InteractionClassHandle theClass, 
      RTI::Boolean active = RTI::RTI_TRUE, 
      RTI::Exception* except = 0 );

   virtual void unsubscribeInteractionClass(
      RTI::InteractionClassHandle theClass, 
      RTI::Exception* except = 0 );


   virtual void registerObjectInstance(
      RTI::ObjectClassHandle  theClass, 
      const char* theObject, 
      RTI::ObjectHandle& handle,
      RTI::Exception* except = 0 );

   virtual void registerObjectInstance(
      RTI::ObjectClassHandle theClass, 
      RTI::ObjectHandle& handle,
      RTI::Exception* except = 0 );

   virtual void updateAttributeValues(
      RTI::ObjectHandle theObject,
      const RTI::AttributeHandleValuePairSet& theAttributes,
      const RTI::FedTime& theTime, 
      const char* theTag, 
      RTI::EventRetractionHandle& handle,
      RTI::Exception* except = 0 ); 

   virtual void updateAttributeValues(
        RTI::ObjectHandle theObject, 
        const RTI::AttributeHandleValuePairSet& theAttributes,
        const char* theTag, 
      RTI::Exception* except = 0 );

   virtual void sendInteraction(
      RTI::InteractionClassHandle theInteraction,
      const RTI::ParameterHandleValuePairSet& theParameters,
      const RTI::FedTime& theTime,
      const char* theTag, 
      RTI::EventRetractionHandle& handle,
      RTI::Exception* except = 0 );

   virtual void sendInteraction(
      RTI::InteractionClassHandle theInteraction,
      const RTI::ParameterHandleValuePairSet& theParameters,
      const char* theTag, 
      RTI::Exception* except = 0 ); 

   virtual void deleteObjectInstance(
      RTI::ObjectHandle theObject, 
      const RTI::FedTime& theTime, 
      const char* theTag, 
      RTI::EventRetractionHandle& handle,
      RTI::Exception* except = 0 );

   virtual void deleteObjectInstance(
      RTI::ObjectHandle theObject,
      const char* theTag, 
      RTI::Exception* except = 0 );

   virtual void localDeleteObjectInstance(
      RTI::ObjectHandle theObject, 
      RTI::Exception* except = 0 ); 

   virtual void changeAttributeTransportationType(
      RTI::ObjectHandle theObject,
      const RTI::AttributeHandleSet& theAttributes,
      RTI::TransportationHandle theType, 
      RTI::Exception* except = 0 );
        
   virtual void changeInteractionTransportationType(
      RTI::InteractionClassHandle theClass,
      RTI::TransportationHandle theType, 
      RTI::Exception* except = 0 );

   virtual void requestObjectAttributeValueUpdate(
      RTI::ObjectHandle theObject,
      const RTI::AttributeHandleSet& theAttributes, 
      RTI::Exception* except = 0 );

   virtual void requestClassAttributeValueUpdate(
      RTI::ObjectClassHandle theClass,
      const RTI::AttributeHandleSet& theAttributes, 
      RTI::Exception* except = 0 );


   virtual void unconditionalAttributeOwnershipDivestiture(
      RTI::ObjectHandle theObject,
      const RTI::AttributeHandleSet& theAttributes, 
      RTI::Exception* except = 0 );

   virtual void negotiatedAttributeOwnershipDivestiture(
      RTI::ObjectHandle theObject, 
      const RTI::AttributeHandleSet& theAttributes,
      const char* theTag, 
      RTI::Exception* except = 0 );

   virtual void attributeOwnershipAcquisition(
      RTI::ObjectHandle theObject, 
      const RTI::AttributeHandleSet& desiredAttributes,
      const char* theTag, 
      RTI::Exception* except = 0 );

   virtual void attributeOwnershipAcquisitionIfAvailable(
      RTI::ObjectHandle theObject,
      const RTI::AttributeHandleSet& desiredAttributes, 
      RTI::Exception* except = 0 );

   virtual void attributeOwnershipReleaseResponse(
      RTI::ObjectHandle theObject,
      const RTI::AttributeHandleSet& theAttributes, 
      RTI::AttributeHandleSet* set,
      RTI::Exception* except = 0 );

   virtual void cancelNegotiatedAttributeOwnershipDivestiture(
      RTI::ObjectHandle theObject,
      const RTI::AttributeHandleSet& theAttributes, 
      RTI::Exception* except = 0 );

   virtual void cancelAttributeOwnershipAcquisition(
      RTI::ObjectHandle theObject, 
      const RTI::AttributeHandleSet& theAttributes, 
      RTI::Exception* except = 0 );

   virtual void queryAttributeOwnership(
      RTI::ObjectHandle theObject,
      RTI::AttributeHandle theAttribute, 
      RTI::Exception* except = 0 );
        
   virtual void isAttributeOwnedByFederate(
      RTI::ObjectHandle theObject,
      RTI::AttributeHandle theAttribute, 
      RTI::Boolean boolean,
      RTI::Exception* except = 0 );


   virtual void enableTimeRegulation(
      const RTI::FedTime& theFederateTime, 
      const RTI::FedTime& theLookahead, 
      RTI::Exception* except = 0 );

   virtual void disableTimeRegulation(
      RTI::Exception* except = 0 );

   virtual void enableTimeConstrained(
      RTI::Exception* except = 0 );

   virtual void disableTimeConstrained(
      RTI::Exception* except = 0 );

   virtual void timeAdvanceRequest(
     const  RTI::FedTime& theTime, 
     RTI::Exception* except = 0 );

   virtual void timeAdvanceRequestAvailable(
    const RTI::FedTime& theTime, 
      RTI::Exception* except = 0 );

   virtual void nextEventRequest(
      const RTI::FedTime& theTime, 
      RTI::Exception* except = 0 );

   virtual void nextEventRequestAvailable(
      const RTI::FedTime& theTime, 
      RTI::Exception* except = 0 );

   virtual void flushQueueRequest(
      const RTI::FedTime& theTime, 
      RTI::Exception* except = 0 );

   virtual void enableAsynchronousDelivery(
      RTI::Exception* except = 0 );

   virtual void disableAsynchronousDelivery(
      RTI::Exception* except = 0 );
    
   virtual void queryLBTS(
      RTI::FedTime& theTime, 
      RTI::Exception* except = 0 ); 

   virtual void queryFederateTime(
      RTI::FedTime& theTime, 
      RTI::Exception* except = 0 ); 

   virtual void queryMinNextEventTime(
      RTI::FedTime& theTime, 
      RTI::Exception* except = 0 ); 

   virtual void modifyLookahead(
      const RTI::FedTime& theLookahead, 
      RTI::Exception* except = 0 );

   virtual void queryLookahead(
       RTI::FedTime& theTime, 
      RTI::Exception* except = 0 ); 

   virtual void retract(
      RTI::EventRetractionHandle theHandle, 
      RTI::Exception* except = 0 );

   virtual void changeAttributeOrderType(
      RTI::ObjectHandle theObject, 
      const RTI::AttributeHandleSet& theAttributes,
      RTI::OrderingHandle theType, 
      RTI::Exception* except = 0 ); 

   virtual void changeInteractionOrderType(
      RTI::InteractionClassHandle theClass,
      RTI::OrderingHandle theType, 
      RTI::Exception* except = 0 );


   virtual void createRegion(
      RTI::SpaceHandle theSpace,
      RTI::ULong numberOfExtents, 
      RTI::Region* region,
      RTI::Exception* except = 0 );

   virtual void notifyAboutRegionModification(
      RTI::Region& theRegion, 
      RTI::Exception* except = 0 );

   virtual void deleteRegion(
      RTI::Region* theRegion, 
      RTI::Exception* except = 0 );

   virtual void registerObjectInstanceWithRegion(
      RTI::ObjectClassHandle theClass,
      const char* theObject,
      RTI::AttributeHandle theAttributes[],
      RTI::Region* theRegions[],
      RTI::ULong theNumberOfHandles, 
      RTI::ObjectHandle& handle,
      RTI::Exception* except = 0 );

   virtual void registerObjectInstanceWithRegion(
      RTI::ObjectClassHandle theClass,
      RTI::AttributeHandle theAttributes[],
      RTI::Region* theRegions[],
      RTI::ULong theNumberOfHandles, 
      RTI::ObjectHandle& handle,
      RTI::Exception* except = 0 );

   virtual void associateRegionForUpdates(
      RTI::Region& theRegion,
      RTI::ObjectHandle theObject,
      const RTI::AttributeHandleSet& theAttributes, 
      RTI::Exception* except = 0 );

   virtual void unassociateRegionForUpdates(
      RTI::Region& theRegion,
      RTI::ObjectHandle theObject, 
      RTI::Exception* except = 0 );

   virtual void subscribeObjectClassAttributesWithRegion(
      RTI::ObjectClassHandle theClass,
      RTI::Region& theRegion,
      const RTI::AttributeHandleSet& attributeList,
      RTI::Boolean active = RTI::RTI_TRUE, 
      RTI::Exception* except = 0 );

   virtual void unsubscribeObjectClassWithRegion(
      RTI::ObjectClassHandle theClass,
      RTI::Region& theRegion, 
      RTI::Exception* except = 0 );

   virtual void subscribeInteractionClassWithRegion(
      RTI::InteractionClassHandle theClass,
      RTI::Region& theRegion,
      RTI::Boolean active = RTI::RTI_TRUE, 
      RTI::Exception* except = 0 );

   virtual void unsubscribeInteractionClassWithRegion(
      RTI::InteractionClassHandle theClass,
      RTI::Region& theRegion, 
      RTI::Exception* except = 0 );

   virtual void sendInteractionWithRegion(
      RTI::InteractionClassHandle theInteraction,
      const RTI::ParameterHandleValuePairSet& theParameters,
      const RTI::FedTime& theTime,
      const char* theTag, 
      const RTI::Region& theRegion, 
      RTI::EventRetractionHandle& handle,
      RTI::Exception* except = 0 );

   virtual void sendInteractionWithRegion(
      RTI::InteractionClassHandle theInteraction,
      const RTI::ParameterHandleValuePairSet& theParameters,
      const char* theTag,
      const RTI::Region& theRegion, 
      RTI::Exception* except = 0 ); 

   virtual void requestClassAttributeValueUpdateWithRegion(
     RTI::ObjectClassHandle theClass,
     const RTI::AttributeHandleSet& theAttributes,
     const RTI::Region& theRegion, 
      RTI::Exception* except = 0 );


   virtual void getObjectClassHandle(
      const char* theName, 
      RTI::ObjectClassHandle& handle,
      RTI::Exception* except = 0 );

   virtual void getObjectClassName(
      RTI::ObjectClassHandle theHandle, 
      char* className,
      RTI::Exception* except = 0 ); 

   virtual void getAttributeHandle(
      const char* theName, 
      RTI::ObjectClassHandle whichClass, 
      RTI::AttributeHandle& handle,
      RTI::Exception* except = 0 ); 

   virtual void getAttributeName(
      RTI::AttributeHandle theHandle,
      RTI::ObjectClassHandle whichClass, 
      char* attributeName,
      RTI::Exception* except = 0 ); 

   virtual void getInteractionClassHandle(
      const char* theName, 
      RTI::InteractionClassHandle& handle,
      RTI::Exception* except = 0 );

   virtual void getInteractionClassName(
     RTI::InteractionClassHandle theHandle, 
     char* className,
     RTI::Exception* except = 0 ); 

   virtual void getParameterHandle(
      const char* theName,
      RTI::InteractionClassHandle whichClass,
      RTI::ParameterHandle& handle,
      RTI::Exception* except = 0 ); 
    
   virtual void getParameterName(
      RTI::ParameterHandle theHandle,  
      RTI::InteractionClassHandle whichClass, 
      char* paramName,
      RTI::Exception* except = 0 );

   virtual void getObjectInstanceHandle(
      const char* theName, 
      RTI::ObjectHandle& handle,
      RTI::Exception* except = 0 );

   virtual void getObjectInstanceName(
     RTI::ObjectHandle theHandle, 
     char* objectInstanceName,
     RTI::Exception* except = 0 );

   virtual void getRoutingSpaceHandle(
     const char* theName, 
     RTI::SpaceHandle& handle,
     RTI::Exception* except = 0 );
        
   virtual void getRoutingSpaceName(
      RTI::SpaceHandle theHandle, 
      char* spaceName,
      RTI::Exception* except = 0 ); 

   virtual void getDimensionHandle(
     const char* theName,
     RTI::SpaceHandle whichSpace, 
     RTI::DimensionHandle& handle,
     RTI::Exception* except = 0 );
    
   virtual void getDimensionName(
      RTI::DimensionHandle theHandle,
      RTI::SpaceHandle whichSpace, 
      char* dimensionName,
      RTI::Exception* except = 0 );

   virtual void getAttributeRoutingSpaceHandle(
      RTI::AttributeHandle theHandle,
      RTI::ObjectClassHandle whichClass, 
      RTI::SpaceHandle& handle, 
      RTI::Exception* except = 0 );

   virtual void getObjectClass(
      RTI::ObjectHandle theObject, 
      RTI::ObjectClassHandle& handle,
      RTI::Exception* except = 0 );

   virtual void getInteractionRoutingSpaceHandle(
     RTI::InteractionClassHandle theHandle, 
     RTI::SpaceHandle& handle, 
     RTI::Exception* except = 0 );

   virtual void getTransportationHandle(
     const char* theName, 
     RTI::TransportationHandle& handle,
     RTI::Exception* except = 0 );

   virtual void getTransportationName(
     RTI::TransportationHandle theHandle, 
     char* transportationName,
     RTI::Exception* except = 0 );

   virtual void getOrderingHandle(
     const char* theName, 
     RTI::OrderingHandle& handle,
     RTI::Exception* except = 0 );

   virtual void getOrderingName(
     RTI::OrderingHandle theHandle, 
     char* orderingName,
     RTI::Exception* except = 0 ); 

   virtual void enableClassRelevanceAdvisorySwitch(
      RTI::Exception* except = 0 );

   virtual void disableClassRelevanceAdvisorySwitch(
      RTI::Exception* except = 0 );

   virtual void enableAttributeRelevanceAdvisorySwitch(
      RTI::Exception* except = 0 );

   virtual void disableAttributeRelevanceAdvisorySwitch(
      RTI::Exception* except = 0 );

   virtual void enableAttributeScopeAdvisorySwitch(
      RTI::Exception* except = 0 );

   virtual void disableAttributeScopeAdvisorySwitch(
      RTI::Exception* except = 0 );

   virtual void enableInteractionRelevanceAdvisorySwitch(
      RTI::Exception* except = 0 );

   virtual void disableInteractionRelevanceAdvisorySwitch(
      RTI::Exception* except = 0 );

   virtual void tick(
       RTI::Boolean result,
       RTI::Exception* except = 0 );
        
   virtual void tick(
      RTI::TickTime minimum,
      RTI::TickTime maximum, 
      RTI::Boolean result,
      RTI::Exception* except = 0 );

   virtual void getRegionToken(
     RTI::Region*,
     RTI::RegionToken& token,
     RTI::Exception* except = 0 );

   virtual void getRegion(
      RTI::RegionToken, 
      RTI::Region* region,
      RTI::Exception* except = 0 );

protected:

   virtual void observe( const MAKRti::DtString& functionName,
                         RTI::Exception* except = 0,
                         const DtMomArgument& argument1 = theDfltMomArgument,
                         const DtMomArgument& argument2 = theDfltMomArgument,
                         const DtMomArgument& argument3 = theDfltMomArgument,
                         const DtMomArgument& argument4 = theDfltMomArgument,
                         const DtMomArgument& argument5 = theDfltMomArgument,
                         const DtMomArgument& returnArg = theDfltRetVal );

protected:
   DtMomMgr* myMomMgr;

   unsigned long myRegisterCount;
   unsigned long myDeleteCount;
   bool myAllowEvokeCallbackToBeObserved;

protected:

   static const DtMomArgument theDfltMomArgument;
   static const DtMomArgument theDfltRetVal;
   static DtMomObserverCreator theCreator;
};

#endif 
#endif