VR-Forces 4.3.1 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
DtVrfMsgPrinter Class Reference
Inheritance diagram for DtVrfMsgPrinter:
Inheritance graph
[legend]

Public Member Functions

 DtVrfMsgPrinter (DtExerciseConn *exConn)
 Constructor.
void receiveMessage (DtDataInteraction *dataInter)
 Overridden to print out VR-Forces data interactions.
virtual bool init ()
 Edit this function to register your own custom messages.
virtual void processDataInteraction (DtDataInteraction *interaction)
virtual bool getContentFromNet (DtDataInteraction *dataInter, DtSimInterfaceContent *&content) const
 Create/set objects based on DtDataInteraction information.
- Public Member Functions inherited from DtVrfMessageInterface
 DtVrfMessageInterface (DtExerciseConn *exConn, bool useDefaultInterfaceFactory=true)
 Constructor.
virtual ~DtVrfMessageInterface ()
 destructor
virtual bool createMessageExecutive ()
 Creator functions.
virtual void createSplitMessageCollector ()
 Replaces mySplitMessageCollector with a new one.
virtual DtSplitMessageCollectorsplitMessageCollector ()
virtual const
DtSplitMessageCollector
splitMessageCollector () const
virtual bool deliverMessage (const DtSimInterfaceMessage &msg)
 Send a message.
virtual bool receiveMessage (const DtSimInterfaceMessage &msg)
virtual bool createAndDeliverMessage (const DtSimulationAddress &recipient, const DtSimInterfaceContent &content, bool overrideTimestampOrder=true)
virtual bool getContentFromNet (unsigned nBufferSize, int nContentType, const char *pContentBuffer, DtSimInterfaceContent *&content) const
virtual bool setContentForNet (DtDataInteraction *dataInter, DtSimInterfaceContent *content) const
virtual void setSequence (DtU32 num)
 Get/Set the sequence number.
virtual DtU32 sequence () const
virtual void setSessionId (DtU32 num)
 Get/Set the session id.
virtual DtU32 sessionId () const
virtual void setVrfMessageVersionSupported (DtU32 num)
 Get/Set the vrf message version.
virtual DtU32 vrfMessageVersionSupported () const
virtual bool isMessageVrfVersionSupported (DtDataInteraction *) const
 Returns true if this data interaction passes the message version check.
virtual void addVrfMessageVersionValidCallback (DtIsValidVrfMessageVersionFcn fcn, void *usr)
 Register vrf message interface version valid.
virtual void removeVrfMessageVersionValidCallback (DtIsValidVrfMessageVersionFcn fcn, void *usr)
virtual bool isVrfMessageVersionTransparentMessageType (int messageType) const
 Returns true if the given message type is message version transparent (i.e.
virtual bool isSessionTransparentMessageType (int messageType)
 Returns true if the given message type is session transparent (i.e.
virtual DtExerciseConn * exerciseConn ()
 Get the exercise connection ptr.
virtual void clearExerciseConn ()
 Sets the exercise conn to NULL.
virtual DtInterfaceContentFactoryfactory () const
 Get/Set the factory used for creating interface content msgs.
virtual void setFactory (DtInterfaceContentFactory *fact)
virtual
DtInterfaceMessageExecutive
messageExecutive () const
 Get the message executive ptr.
virtual const DtSimulationAddress & messageAddress () const
 Get the address that should be used as the sender for all messages originating from the backend.
virtual bool sendMessage (const DtSimInterfaceMessage &message)
 Send a sim interface message.
virtual void addMessageCallback (int type, DtMessageCallbackFcn fcn, void *usrData)
 Add/Remove interface message callback functions.
virtual void removeMessageCallback (int type, DtMessageCallbackFcn fcn, void *usrData)
virtual bool sendSplitContent (const char *pContentBuffer, unsigned int nBufferSize, int nContentType, const DtSimulationAddress &sender, const DtSimulationAddress &recipient, DtSplitMessageHandle &msgHandleReturn)
 Sends oversize message content as multiple DtSimInterfaceMessages with DtIfSplitContent.
virtual bool sendSplitContent (const char *pContentBuffer, unsigned int nBufferSize, int nContentType, const DtSimulationAddress &sender, const DtSimulationAddress &recipient)
 Sends oversize message content as multiple DtSimInterfaceMessages with DtIfSplitContent.
virtual bool isQueuedMessage (const DtSimInterfaceMessage &message)
 Determines if a message should get put into the receive queue.
virtual void processReceiveMessageQueue ()
 Receives any interface messages we have in the myReceiveMessageQueue.
virtual void setQueueMessages (bool)
 Set to false to not queue messages in HLA. Default is true.
virtual bool queueMessages () const
virtual void setTransportTypeReliable (int contentType)
 Sets the transport type for the given content type to be reliable.
virtual void setTransportTypeBestEffort (int contentType)
 Sets the transport type for the given content type to be best-effort.
virtual void updateTransportTypeForMsg (const DtSimInterfaceMessage &message)
 Update the transportation type to be used based on the given message.
virtual void updateTransportType (RTI::TransportationHandle transportType)
 Update the transportation type to be used.
virtual void processReassembledContent (const char *pContent, int nContentSize, int nContentType, const DtSimulationAddress &messageIdSender, int messageIdNumber, const DtSimulationAddress &recipient)
 Reconstitute a message based on previously split content.
virtual bool receiveMessage (const DtSimInterfaceContent &content)
 Call this to receive a message internally – this will not go out over the network.

Static Public Member Functions

static void dataInteractionCallback (DtDataInteraction *i, void *usr)
- Static Public Member Functions inherited from DtVrfMessageInterface
static void netMessageCallback (DtDataInteraction *dataInter, void *usr)

Protected Member Functions

 DtVrfMsgPrinter ()
 Default contstructor; not implemented.
- Protected Member Functions inherited from DtVrfMessageInterface
bool sendNormalMessage (const DtSimInterfaceMessage &message)
 Send a message, called from sendMessage if message content does not exceed maximum size.
 DtVrfMessageInterface (const DtVrfMessageInterface &orig)
DtVrfMessageInterfaceoperator= (const DtVrfMessageInterface &orig)
 DtVrfMessageInterface ()

Protected Attributes

DtDefaultVrfObjectMessageFactory myVrfObjectMsgFact
DtDefaultCondExprFactory myCondExprFact
DtDefaultStatementFactory myStmtFact
DtDefaultSimReportFactory myReportFact
DtDefaultSimTaskFactory myTaskFact
DtDefaultSetDataRequestFactory mySetDataFact
DtDefaultSimCommandFactory mySimCommandFact
DtDefaultAdminContentFactory myAdminContentFact
- Protected Attributes inherited from DtVrfMessageInterface
DtInterfaceContentFactorymyContentFactory
DtInterfaceMessageExecutivemyMessageExecutive
DtExerciseConn * myExerciseConnection
bool myCreatedInterfaceFactory
DtU32 mySequenceNumber
DtU32 mySessionId
DtSplitMessageCollectormySplitMessageCollector
DtU32 myVrfMessageVersionSupported
 The vrf version is set (by default) from the values found in version.h.
DtList myCallbacks
DtList myReceiveMessageQueue
 Used to hold interface messages which will cause response messages to be sent until after drainInput, when they can safely be sent (with the DMSO RTI).
bool myQueueMessages
 Set to false to not queue messages in HLA. Default is true.
RTI::TransportationHandle myReliableTransportType
 Stores the transportation type for the reliable type.
RTI::TransportationHandle myBestEffortTransportType
 Stores the transportation type for the best-effort type.
RTI::TransportationHandle myCurrentTransportType
 Stores the current transportation type being used.
RTI::InteractionClassHandle myDataInterClassHdl
 Stores the current transportation type being used.
std::set< intmyContentTypesToSendReliable
 Set of content types to be sent via reliable transport.

Additional Inherited Members

- Static Protected Member Functions inherited from DtVrfMessageInterface
static bool matchPattern (const DtSimulationAddress &address, const DtSimulationAddress &pattern)
 Utility function that returns true if the address matches the given pattern.
static void postDrainCallback (void *usr)
 calls processSendMessageQueue();

Constructor & Destructor Documentation

DtVrfMsgPrinter::DtVrfMsgPrinter ( DtExerciseConn *  exConn)

Constructor.

DtVrfMsgPrinter::DtVrfMsgPrinter ( )
protected

Default contstructor; not implemented.

Member Function Documentation

void DtVrfMsgPrinter::receiveMessage ( DtDataInteraction *  dataInter)
virtual

Overridden to print out VR-Forces data interactions.

Reimplemented from DtVrfMessageInterface.

virtual bool DtVrfMsgPrinter::init ( )
virtual

Edit this function to register your own custom messages.

Reimplemented from DtVrfMessageInterface.

static void DtVrfMsgPrinter::dataInteractionCallback ( DtDataInteraction *  i,
void *  usr 
)
static
virtual void DtVrfMsgPrinter::processDataInteraction ( DtDataInteraction *  interaction)
virtual
virtual bool DtVrfMsgPrinter::getContentFromNet ( DtDataInteraction *  dataInter,
DtSimInterfaceContent *&  content 
) const
virtual

Create/set objects based on DtDataInteraction information.

Reimplemented from DtVrfMessageInterface.

Member Data Documentation

DtDefaultVrfObjectMessageFactory DtVrfMsgPrinter::myVrfObjectMsgFact
protected
DtDefaultCondExprFactory DtVrfMsgPrinter::myCondExprFact
protected
DtDefaultStatementFactory DtVrfMsgPrinter::myStmtFact
protected
DtDefaultSimReportFactory DtVrfMsgPrinter::myReportFact
protected
DtDefaultSimTaskFactory DtVrfMsgPrinter::myTaskFact
protected
DtDefaultSetDataRequestFactory DtVrfMsgPrinter::mySetDataFact
protected
DtDefaultSimCommandFactory DtVrfMsgPrinter::mySimCommandFact
protected
DtDefaultAdminContentFactory DtVrfMsgPrinter::myAdminContentFact
protected

The documentation for this class was generated from the following file:

Document ID: Generated on Wed Jul 29 00:55:00 EDT 2015 from SVN revision 155257
Copyright © 2005-2015 VT MÄK. All Rights Reserved (www.mak.com)