 |
VR-Forces 4.1.1 Class Documentation
|
|
VR-Forces 4.1.1 Class Documentation
|
This section describes the following message classes and their functions:
The constants in the message classes are defined in msgTypes.h.
DtSimMessage (simMsg.h) is an abstract base class that provides common functionality for DtSimInterfaceMessage and DtVrfObjectMessage. These classes are derived from DtSimMessage and implement interface messages and radio messages respectively.
DtInterfaceMessageExecutive (ifaceMsgExec.h) manages callbacks on interface messages. The member function indexType() extracts the interface message content type from a DtSimInterfaceMessage and returns it as a string.
DtMessageExecutive (msgExec.h) is an abstract base class. Classes derived from DtMessageExecutive are used to manage callbacks on particular message types. For example, the radio message executive has a list of callback lists indexed by radio message type.
Entities use DtAdminMessage (adminMessage.h) to send administration message to each other, or to or from the GUI. These are messages that are not task, set requests, or reports, but which are used for administration of the simulation. The notify level and file logging options in the Object Console tab of the Entity Information dialog box use DtAdminMessages.
The class DtVrfObjectMessageExecutive (vrfObjectMessageExecutive.h) is used to manage callbacks of DtVrfObjectMessages. Callbacks can be registered on specified message content types such as Move To Task, or on general message categories such as Task or Report.
Entities use DtReportMessage (reportMsg.h) to send DtSimReports (simReport.h) to one another. The radioMessageType() for this kind of message is DtReportMessageType.
In VR-Forces, only the type DtTaskCompletedReportType of DtSimReport is implemented, however you can create your own reports by deriving from DtSimReport and implementing the clone() and type() functions. The DtTaskCompletedReportType report message is sent by DtSimLocalEntity::taskComplete() to notify either the entity's superior or the DtSimManager of task completion (depending on who issued the task in the first place).
Entities use DtSetDataRequestMessage (setDtaRqMsg.h) send DtSetDataRequests (setDataReq.h) to one another. The radioMessageType() for this kind of message is DtSetDataRequestMessageType. Classes derived from DtSetDataRequest are used to implement the messages for setting parameters, such as location.
DtSetDataRequestMessages are sent to entities:
Use DtSimInterfaceMessage (ifaceMsg.h) to send an interface message. It derives from a standard DtSimMessage, and returns DtInterfaceMessageType as its messageType(). It contains a pointer to a DtSimInterfaceContent (analogous to the DtTask in a DtTaskMessage).
Derived kinds of DtSimInterfaceContent can be categorized as follows:
The Remote Control API uses many of these messages to communicate with VR-Forces applications. Exchanging these messages happens transparently within the implementation of the Remote Control API. If you use the Remote Control API, you do not necessarily need to concern yourself with the specific messages to control remote VR-Forces applications. However, if you want to modify or extend the remote control API, you may need to know about some of the underlying messages.
Messages sent to and from entities are sent using a DtVrfObjectMessage. VR-Forces implements four types of VRF Object Messages:
The DtVrfObjectMessage class contains the addressing information for a message between entities in the form of the name of the sending entity and the name of the receiver. If the receiver is specified to be "DtBroadcast" the message is considered to be addressed to any entity. Message subclasses contain the actual data of the message.
Entities use DtTaskMessage (taskMsg.h) to send DtSimTasks (simTask.h) to one another. The radioMessageType() for this kind of message is DtTaskMessageType. Classes derived from DtSimTask are used to implement task messages, for example, Move To.
DtTaskMessages are sent to entities: