![]() |
VR-Exchange 2.1 API Documentation
|
DtPortalInteractions are a special type of DtPortalMessages which are used to transmit simulation data for events, things with no state. More...

Public Member Functions | |
| DtPortalInteraction () | |
| The Default CTOR. | |
| virtual | ~DtPortalInteraction () |
| The Default DTOR. | |
| DtPortalInteraction (const DtPortalInteraction &other) | |
| Copy CTOR - this class is copyable. | |
| DtPortalInteraction & | operator= (const DtPortalInteraction &other) |
| Assignment Operator - this class is copyable. | |
| virtual DtPortalMessageKind | kind () const =0 |
| Returns the type of this message. | |
| virtual const char * | interactionKindName () const =0 |
| returns a well formated string representation of this interactions type | |
| virtual unsigned int | netSize () const |
| Returns the network size of the message. | |
| virtual void | writeSelfToBuffer (void *buffer) const |
| Writes the message to a buffer. | |
| virtual void | readSelfFromBuffer (const void *buffer) |
| fills out this message instance from the buffer provided. | |
| virtual std::ostream & | printDataToStream (std::ostream &str) const |
| Prints the internal state of this message to the stream passed in. | |
Additional Inherited Members |
DtPortalInteractions are a special type of DtPortalMessages which are used to transmit simulation data for events, things with no state.
This is analogous to HLA interactions. Portal Interactions have no lifetime.
| MAKVrExchange::DtPortalInteraction::DtPortalInteraction | ( | ) |
The Default CTOR.
|
virtual |
The Default DTOR.
| MAKVrExchange::DtPortalInteraction::DtPortalInteraction | ( | const DtPortalInteraction & | other | ) |
Copy CTOR - this class is copyable.
| DtPortalInteraction& MAKVrExchange::DtPortalInteraction::operator= | ( | const DtPortalInteraction & | other | ) |
Assignment Operator - this class is copyable.
|
pure virtual |
Returns the type of this message.
Implements MAKVrExchange::DtPortalMessage.
Implemented in MAKVrExchange::DtPortalViewControlInteraction, MAKVrExchange::DtPortalRadioSignalInteraction, MAKVrExchange::DtPortalFireInteraction, MAKVrExchange::DtPortalDetonationInteraction, MAKVrExchange::DtPortalTransferControlInteraction, MAKVrExchange::DtPortalSupplyInteraction, MAKVrExchange::DtPortalStopInteraction, MAKVrExchange::DtPortalCommentInteraction, MAKVrExchange::DtPortalStartInteraction, MAKVrExchange::DtPortalDataQueryInteraction, MAKVrExchange::DtPortalActionRequestInteraction, MAKVrExchange::DtPortalActionResponseInteraction, MAKVrExchange::DtPortalResupplyCancelInteraction, MAKVrExchange::DtPortalDataInteraction, MAKVrExchange::DtPortalEventReportInteraction, MAKVrExchange::DtPortalServiceRequestInteraction, MAKVrExchange::DtPortalSetDataInteraction, MAKVrExchange::DtPortalAcknowledgeInteraction, MAKVrExchange::DtPortalCollisionInteraction, MAKVrExchange::DtPortalRepairCompleteInteraction, MAKVrExchange::DtPortalRepairResponseInteraction, MAKVrExchange::DtPortalGenericInteraction, MAKVrExchange::DtPortalResupplyOfferInteraction, MAKVrExchange::DtPortalCreateEntityInteraction, MAKVrExchange::DtPortalRemoveEntityInteraction, MAKVrExchange::DtPortalBaseInteraction, MAKVrExchange::DtPortalLoggerDeleteFileInteraction, MAKVrExchange::DtPortalLoggerPauseInteraction, MAKVrExchange::DtPortalLoggerRecordActionInteraction, MAKVrExchange::DtPortalLoggerQuitInteraction, MAKVrExchange::DtPortalLoggerPlayActionInteraction, MAKVrExchange::DtPortalLoggerEmptyInteraction, MAKVrExchange::DtPortalLoggerStartInteraction, MAKVrExchange::DtPortalResupplyReceivedInteraction, MAKVrExchange::DtPortalLoggerEndOfActionInteraction, DtPortalBoomInteraction, MAKVrExchange::DtPortalLoggerSkipTimeInteraction, MAKVrExchange::DtPortalLoggerEndInteraction, MAKVrExchange::DtPortalLoggerHeartbeatInteraction, MAKVrExchange::DtPortalLoggerPlayFileInteraction, MAKVrExchange::DtPortalLoggerPlayInteraction, MAKVrExchange::DtPortalLoggerRecordFileInteraction, MAKVrExchange::DtPortalLoggerRecordInteraction, MAKVrExchange::DtPortalLoggerSetTimeInteraction, MAKVrExchange::DtPortalLoggerStateFlagInteraction, MAKVrExchange::DtPortalLoggerStopInteraction, MAKVrExchange::DtPortalLoggerTimeoutInteraction, MAKVrExchange::DtPortalLoggerTimeScaleInteraction, and MAKVrExchange::DtPortalLoggerTotalStateInteraction.
|
pure virtual |
returns a well formated string representation of this interactions type
Implemented in MAKVrExchange::DtPortalViewControlInteraction, MAKVrExchange::DtPortalRadioSignalInteraction, MAKVrExchange::DtPortalFireInteraction, MAKVrExchange::DtPortalDetonationInteraction, MAKVrExchange::DtPortalTransferControlInteraction, MAKVrExchange::DtPortalSupplyInteraction, MAKVrExchange::DtPortalStopInteraction, MAKVrExchange::DtPortalCommentInteraction, MAKVrExchange::DtPortalStartInteraction, MAKVrExchange::DtPortalDataQueryInteraction, MAKVrExchange::DtPortalActionRequestInteraction, MAKVrExchange::DtPortalActionResponseInteraction, MAKVrExchange::DtPortalResupplyCancelInteraction, MAKVrExchange::DtPortalDataInteraction, MAKVrExchange::DtPortalEventReportInteraction, MAKVrExchange::DtPortalServiceRequestInteraction, MAKVrExchange::DtPortalSetDataInteraction, MAKVrExchange::DtPortalAcknowledgeInteraction, MAKVrExchange::DtPortalCollisionInteraction, MAKVrExchange::DtPortalRepairCompleteInteraction, MAKVrExchange::DtPortalRepairResponseInteraction, MAKVrExchange::DtPortalResupplyOfferInteraction, MAKVrExchange::DtPortalGenericInteraction, MAKVrExchange::DtPortalCreateEntityInteraction, MAKVrExchange::DtPortalRemoveEntityInteraction, MAKVrExchange::DtPortalLoggerControlInteraction, MAKVrExchange::DtPortalBaseInteraction, MAKVrExchange::DtPortalLoggerDeleteFileInteraction, MAKVrExchange::DtPortalLoggerPauseInteraction, MAKVrExchange::DtPortalLoggerRecordActionInteraction, MAKVrExchange::DtPortalLoggerQuitInteraction, MAKVrExchange::DtPortalResupplyReceivedInteraction, MAKVrExchange::DtPortalLoggerPlayActionInteraction, MAKVrExchange::DtPortalLoggerEmptyInteraction, MAKVrExchange::DtPortalLoggerStartInteraction, MAKVrExchange::DtPortalLoggerEndOfActionInteraction, DtPortalBoomInteraction, MAKVrExchange::DtPortalLoggerSkipTimeInteraction, MAKVrExchange::DtPortalLoggerEndInteraction, MAKVrExchange::DtPortalLoggerHeartbeatInteraction, MAKVrExchange::DtPortalLoggerPlayFileInteraction, MAKVrExchange::DtPortalLoggerPlayInteraction, MAKVrExchange::DtPortalLoggerRecordFileInteraction, MAKVrExchange::DtPortalLoggerRecordInteraction, MAKVrExchange::DtPortalLoggerSetTimeInteraction, MAKVrExchange::DtPortalLoggerStateFlagInteraction, MAKVrExchange::DtPortalLoggerStopInteraction, MAKVrExchange::DtPortalLoggerTimeoutInteraction, MAKVrExchange::DtPortalLoggerTimeScaleInteraction, and MAKVrExchange::DtPortalLoggerTotalStateInteraction.
|
virtual |
Returns the network size of the message.
This is the number of bytes needed to store this message in a packet. This function is mainly called by the DtPortalConnection instance.
Reimplemented from MAKVrExchange::DtPortalMessage.
Reimplemented in MAKVrExchange::DtPortalViewControlInteraction, MAKVrExchange::DtPortalRadioSignalInteraction, MAKVrExchange::DtPortalFireInteraction, MAKVrExchange::DtPortalDetonationInteraction, MAKVrExchange::DtPortalTransferControlInteraction, MAKVrExchange::DtPortalSupplyInteraction, MAKVrExchange::DtPortalStopInteraction, MAKVrExchange::DtPortalCommentInteraction, MAKVrExchange::DtPortalStartInteraction, MAKVrExchange::DtPortalDataQueryInteraction, MAKVrExchange::DtPortalActionRequestInteraction, MAKVrExchange::DtPortalActionResponseInteraction, MAKVrExchange::DtPortalResupplyCancelInteraction, MAKVrExchange::DtPortalServiceRequestInteraction, MAKVrExchange::DtPortalDataInteraction, MAKVrExchange::DtPortalEventReportInteraction, MAKVrExchange::DtPortalSetDataInteraction, MAKVrExchange::DtPortalAcknowledgeInteraction, MAKVrExchange::DtPortalCollisionInteraction, MAKVrExchange::DtPortalRepairCompleteInteraction, MAKVrExchange::DtPortalRepairResponseInteraction, MAKVrExchange::DtPortalGenericInteraction, MAKVrExchange::DtPortalBaseInteraction, MAKVrExchange::DtPortalCreateEntityInteraction, MAKVrExchange::DtPortalRemoveEntityInteraction, MAKVrExchange::DtPortalLoggerControlInteraction, MAKVrExchange::DtPortalLoggerDeleteFileInteraction, MAKVrExchange::DtPortalLoggerPauseInteraction, MAKVrExchange::DtPortalLoggerRecordActionInteraction, MAKVrExchange::DtPortalLoggerQuitInteraction, MAKVrExchange::DtPortalLoggerPlayActionInteraction, MAKVrExchange::DtPortalLoggerEmptyInteraction, MAKVrExchange::DtPortalLoggerStartInteraction, MAKVrExchange::DtPortalLoggerEndOfActionInteraction, DtPortalBoomInteraction, MAKVrExchange::DtPortalLoggerSkipTimeInteraction, MAKVrExchange::DtPortalLoggerEndInteraction, MAKVrExchange::DtPortalLoggerHeartbeatInteraction, MAKVrExchange::DtPortalLoggerPlayFileInteraction, MAKVrExchange::DtPortalLoggerPlayInteraction, MAKVrExchange::DtPortalLoggerRecordFileInteraction, MAKVrExchange::DtPortalLoggerRecordInteraction, MAKVrExchange::DtPortalLoggerSetTimeInteraction, MAKVrExchange::DtPortalLoggerStateFlagInteraction, MAKVrExchange::DtPortalLoggerStopInteraction, MAKVrExchange::DtPortalLoggerTimeoutInteraction, MAKVrExchange::DtPortalLoggerTimeScaleInteraction, and MAKVrExchange::DtPortalLoggerTotalStateInteraction.
|
virtual |
Writes the message to a buffer.
This function should only be called by the DtPortalConnection instance.
| [in] | buffer |
buffer must be at least the size returned by netSize(). Reimplemented from MAKVrExchange::DtPortalMessage.
Reimplemented in MAKVrExchange::DtPortalViewControlInteraction, MAKVrExchange::DtPortalRadioSignalInteraction, MAKVrExchange::DtPortalFireInteraction, MAKVrExchange::DtPortalDetonationInteraction, MAKVrExchange::DtPortalTransferControlInteraction, MAKVrExchange::DtPortalSupplyInteraction, MAKVrExchange::DtPortalStopInteraction, MAKVrExchange::DtPortalCommentInteraction, MAKVrExchange::DtPortalStartInteraction, MAKVrExchange::DtPortalDataQueryInteraction, MAKVrExchange::DtPortalActionRequestInteraction, MAKVrExchange::DtPortalActionResponseInteraction, MAKVrExchange::DtPortalResupplyCancelInteraction, MAKVrExchange::DtPortalServiceRequestInteraction, MAKVrExchange::DtPortalDataInteraction, MAKVrExchange::DtPortalEventReportInteraction, MAKVrExchange::DtPortalSetDataInteraction, MAKVrExchange::DtPortalAcknowledgeInteraction, MAKVrExchange::DtPortalCollisionInteraction, MAKVrExchange::DtPortalRepairCompleteInteraction, MAKVrExchange::DtPortalRepairResponseInteraction, MAKVrExchange::DtPortalGenericInteraction, MAKVrExchange::DtPortalBaseInteraction, MAKVrExchange::DtPortalCreateEntityInteraction, MAKVrExchange::DtPortalRemoveEntityInteraction, MAKVrExchange::DtPortalLoggerControlInteraction, MAKVrExchange::DtPortalLoggerDeleteFileInteraction, MAKVrExchange::DtPortalLoggerPauseInteraction, MAKVrExchange::DtPortalLoggerRecordActionInteraction, MAKVrExchange::DtPortalLoggerQuitInteraction, MAKVrExchange::DtPortalLoggerPlayActionInteraction, MAKVrExchange::DtPortalLoggerEmptyInteraction, MAKVrExchange::DtPortalLoggerStartInteraction, MAKVrExchange::DtPortalLoggerEndOfActionInteraction, DtPortalBoomInteraction, MAKVrExchange::DtPortalLoggerSkipTimeInteraction, MAKVrExchange::DtPortalLoggerEndInteraction, MAKVrExchange::DtPortalLoggerHeartbeatInteraction, MAKVrExchange::DtPortalLoggerPlayFileInteraction, MAKVrExchange::DtPortalLoggerPlayInteraction, MAKVrExchange::DtPortalLoggerRecordFileInteraction, MAKVrExchange::DtPortalLoggerRecordInteraction, MAKVrExchange::DtPortalLoggerSetTimeInteraction, MAKVrExchange::DtPortalLoggerStateFlagInteraction, MAKVrExchange::DtPortalLoggerStopInteraction, MAKVrExchange::DtPortalLoggerTimeoutInteraction, MAKVrExchange::DtPortalLoggerTimeScaleInteraction, and MAKVrExchange::DtPortalLoggerTotalStateInteraction.
|
virtual |
fills out this message instance from the buffer provided.
This function is only called by the DtPortalConnection instance.
| [in] | buffer |
buffer must be at least the size returned by netSize(). Reimplemented from MAKVrExchange::DtPortalMessage.
Reimplemented in MAKVrExchange::DtPortalViewControlInteraction, MAKVrExchange::DtPortalRadioSignalInteraction, MAKVrExchange::DtPortalFireInteraction, MAKVrExchange::DtPortalDetonationInteraction, MAKVrExchange::DtPortalTransferControlInteraction, MAKVrExchange::DtPortalSupplyInteraction, MAKVrExchange::DtPortalStopInteraction, MAKVrExchange::DtPortalCommentInteraction, MAKVrExchange::DtPortalStartInteraction, MAKVrExchange::DtPortalDataQueryInteraction, MAKVrExchange::DtPortalActionRequestInteraction, MAKVrExchange::DtPortalActionResponseInteraction, MAKVrExchange::DtPortalResupplyCancelInteraction, MAKVrExchange::DtPortalServiceRequestInteraction, MAKVrExchange::DtPortalDataInteraction, MAKVrExchange::DtPortalEventReportInteraction, MAKVrExchange::DtPortalSetDataInteraction, MAKVrExchange::DtPortalAcknowledgeInteraction, MAKVrExchange::DtPortalCollisionInteraction, MAKVrExchange::DtPortalRepairCompleteInteraction, MAKVrExchange::DtPortalRepairResponseInteraction, MAKVrExchange::DtPortalGenericInteraction, MAKVrExchange::DtPortalBaseInteraction, MAKVrExchange::DtPortalCreateEntityInteraction, MAKVrExchange::DtPortalRemoveEntityInteraction, MAKVrExchange::DtPortalLoggerControlInteraction, MAKVrExchange::DtPortalLoggerDeleteFileInteraction, MAKVrExchange::DtPortalLoggerPauseInteraction, MAKVrExchange::DtPortalLoggerRecordActionInteraction, MAKVrExchange::DtPortalLoggerQuitInteraction, MAKVrExchange::DtPortalLoggerPlayActionInteraction, MAKVrExchange::DtPortalLoggerEmptyInteraction, MAKVrExchange::DtPortalLoggerStartInteraction, MAKVrExchange::DtPortalLoggerEndOfActionInteraction, DtPortalBoomInteraction, MAKVrExchange::DtPortalLoggerSkipTimeInteraction, MAKVrExchange::DtPortalLoggerEndInteraction, MAKVrExchange::DtPortalLoggerHeartbeatInteraction, MAKVrExchange::DtPortalLoggerPlayFileInteraction, MAKVrExchange::DtPortalLoggerPlayInteraction, MAKVrExchange::DtPortalLoggerRecordFileInteraction, MAKVrExchange::DtPortalLoggerRecordInteraction, MAKVrExchange::DtPortalLoggerSetTimeInteraction, MAKVrExchange::DtPortalLoggerStateFlagInteraction, MAKVrExchange::DtPortalLoggerStopInteraction, MAKVrExchange::DtPortalLoggerTimeoutInteraction, MAKVrExchange::DtPortalLoggerTimeScaleInteraction, and MAKVrExchange::DtPortalLoggerTotalStateInteraction.
|
virtual |
Prints the internal state of this message to the stream passed in.
All subclasses of DtPortalMessage should implement this.
Reimplemented from MAKVrExchange::DtPortalMessage.
Reimplemented in MAKVrExchange::DtPortalViewControlInteraction, MAKVrExchange::DtPortalRadioSignalInteraction, MAKVrExchange::DtPortalTransferControlInteraction, MAKVrExchange::DtPortalStopInteraction, MAKVrExchange::DtPortalCommentInteraction, MAKVrExchange::DtPortalStartInteraction, MAKVrExchange::DtPortalActionRequestInteraction, MAKVrExchange::DtPortalActionResponseInteraction, MAKVrExchange::DtPortalFireInteraction, MAKVrExchange::DtPortalResupplyCancelInteraction, MAKVrExchange::DtPortalDataInteraction, MAKVrExchange::DtPortalEventReportInteraction, MAKVrExchange::DtPortalSetDataInteraction, MAKVrExchange::DtPortalCollisionInteraction, MAKVrExchange::DtPortalRepairCompleteInteraction, MAKVrExchange::DtPortalRepairResponseInteraction, MAKVrExchange::DtPortalAcknowledgeInteraction, MAKVrExchange::DtPortalDetonationInteraction, MAKVrExchange::DtPortalSupplyInteraction, MAKVrExchange::DtPortalServiceRequestInteraction, MAKVrExchange::DtPortalGenericInteraction, MAKVrExchange::DtPortalBaseInteraction, MAKVrExchange::DtPortalCreateEntityInteraction, MAKVrExchange::DtPortalRemoveEntityInteraction, MAKVrExchange::DtPortalLoggerControlInteraction, MAKVrExchange::DtPortalLoggerDeleteFileInteraction, MAKVrExchange::DtPortalLoggerPauseInteraction, MAKVrExchange::DtPortalLoggerRecordActionInteraction, MAKVrExchange::DtPortalLoggerQuitInteraction, MAKVrExchange::DtPortalLoggerPlayActionInteraction, MAKVrExchange::DtPortalLoggerEmptyInteraction, MAKVrExchange::DtPortalLoggerStartInteraction, MAKVrExchange::DtPortalLoggerEndOfActionInteraction, DtPortalBoomInteraction, MAKVrExchange::DtPortalLoggerSkipTimeInteraction, MAKVrExchange::DtPortalLoggerEndInteraction, MAKVrExchange::DtPortalLoggerHeartbeatInteraction, MAKVrExchange::DtPortalLoggerPlayFileInteraction, MAKVrExchange::DtPortalLoggerPlayInteraction, MAKVrExchange::DtPortalLoggerRecordFileInteraction, MAKVrExchange::DtPortalLoggerRecordInteraction, MAKVrExchange::DtPortalLoggerSetTimeInteraction, MAKVrExchange::DtPortalLoggerStateFlagInteraction, MAKVrExchange::DtPortalLoggerStopInteraction, MAKVrExchange::DtPortalLoggerTimeoutInteraction, MAKVrExchange::DtPortalLoggerTimeScaleInteraction, and MAKVrExchange::DtPortalLoggerTotalStateInteraction.