VR-Exchange 2.6 API Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes
DtPortalBoomInteraction Class Reference

Represents a weapon fire event. More...

Inheritance diagram for DtPortalBoomInteraction:
Inheritance graph
[legend]

Public Types

typedef void(* DtPortalBoomInteractionCb )(const DtPortalBoomInteraction &inter, void *usr)

Public Member Functions

 DtPortalBoomInteraction ()
 CTOR.
virtual ~DtPortalBoomInteraction ()
 Virtual DTOR.
virtual unsigned int netSize () const
 NOTE: DtDEC_ATTRIBUTE resets the access specifier to protected.
virtual void writeSelfToBuffer (void *buffer, int bufferSize) const
 Writes this message into the memory buffer provided by buffer.
virtual void readSelfFromBuffer (const void *buffer, int bufferSize)
 Reads this message from the memory buffer into this object.
virtual std::ostream & printDataToStream (std::ostream &str) const
 Prints the current state of this message to the stream specified by str.
Data Exchange Attributes
 DtDEC_ATTRIBUTE (DtU32, Volume, volume)
 DtDEC_ATTRIBUTE (bool, GroundMovement, groundMovement)
- Public Member Functions inherited from MAKVrExchange::DtPortalInteraction
 DtPortalInteraction (DtPortalMessageKind kind, const DtString &name)
 CTOR.
 DtPortalInteraction (const DtPortalInteraction &other)
 Copy CTOR.
virtual ~DtPortalInteraction ()
 Virtual DTOR.
virtual DtPortalInteraction & operator= (const DtPortalInteraction &other)
 Assignment operator.
 DtDEC_ATTRIBUTE (DtString, Name, name)
 Message Name attribute.
 DtDEC_ATTRIBUTE (DtAttributeValuePairList, AttributeValuePairList, attributeValuePairList)
 The Attribute Value Pair List for the class.
- Public Member Functions inherited from MAKVrExchange::DtPortalMessage
 DtPortalMessage (DtPortalMessageKind kind)
 CTOR.
 DtPortalMessage (const DtPortalMessage &other)
 Copy CTOR.
virtual ~DtPortalMessage ()
 Virtual DTOR.
virtual DtPortalMessage & operator= (const DtPortalMessage &other)
 Assignment operator.
virtual bool operator== (const DtPortalMessage &other) const
virtual bool operator!= (const DtPortalMessage &other) const
 DtDEC_ATTRIBUTE (DtPortalMessageKind, Kind, kind)
 Message Kind attribute.
virtual void setSerialNumber (unsigned int i) const
 This method should be considered private and not be used.
virtual unsigned int serialNumber () const
 Returns a unique identifier for this message.
virtual void setSendingBrokerId (const DtU32 &id) const
 This method should be considered private and not be used.
virtual DtU32 sendingBrokerId () const
 Returns the ID of the sending broker.
virtual void setTimeSent (const DtTime &tm) const
 This method should be considered private and not be used.
virtual DtTime timeSent () const
 The Time that the message was sent.
virtual void setTimeReceived (const DtTime &tm) const
 This method should be considered private and not be used.
virtual DtTime timeReceived () const
 The time that this message was received.

Static Public Member Functions

static void addCallback (MAKVrExchange::DtPortalConnection *conn, DtPortalBoomInteractionCb cb, void *usr)
 Adds a callback to be called when interactions are received.
static void removeCallback (MAKVrExchange::DtPortalConnection *conn, DtPortalBoomInteractionCb cb, void *usr)
 Removes the callback for when interactions are received.
static DtPortalMessage * create ()

Static Public Attributes

static const
MAKVrExchange::DtPortalMessageKind 		theKind
 NOTE: DtDEC_ATTRIBUTE resets the access specifier to protected.

Additional Inherited Members

- Protected Member Functions inherited from MAKVrExchange::DtPortalMessage
virtual int getSize (const DtU8 &v) const
virtual char * encode (const DtU8 &val, char *buffer, int &bufferSize) const
virtual const char * decode (DtU8 &val, const char *buffer, int &bufferSize) const
virtual int getSize (const DtU16 &v) const
virtual char * encode (const DtU16 &val, char *buffer, int &bufferSize) const
virtual const char * decode (DtU16 &val, const char *buffer, int &bufferSize) const
virtual int getSize (const DtU32 &v) const
virtual char * encode (const DtU32 &val, char *buffer, int &bufferSize) const
virtual const char * decode (DtU32 &val, const char *buffer, int &bufferSize) const
virtual int getSize (const DtU64 &v) const
virtual char * encode (const DtU64 &val, char *buffer, int &bufferSize) const
virtual const char * decode (DtU64 &val, const char *buffer, int &bufferSize) const
virtual int getSize (const DtInt8 &v) const
virtual char * encode (const DtInt8 &val, char *buffer, int &bufferSize) const
virtual const char * decode (DtInt8 &val, const char *buffer, int &bufferSize) const
virtual int getSize (const DtInt16 &v) const
virtual char * encode (const DtInt16 &val, char *buffer, int &bufferSize) const
virtual const char * decode (DtInt16 &val, const char *buffer, int &bufferSize) const
virtual int getSize (const DtInt32 &v) const
virtual char * encode (const DtInt32 &val, char *buffer, int &bufferSize) const
virtual const char * decode (DtInt32 &val, const char *buffer, int &bufferSize) const
virtual int getSize (const DtInt64 &v) const
virtual char * encode (const DtInt64 &val, char *buffer, int &bufferSize) const
virtual const char * decode (DtInt64 &val, const char *buffer, int &bufferSize) const
virtual int getSize (const DtFloat32 &v) const
virtual char * encode (const DtFloat32 &val, char *buffer, int &bufferSize) const
virtual const char * decode (DtFloat32 &val, const char *buffer, int &bufferSize) const
virtual int getSize (const DtFloat64 &v) const
virtual char * encode (const DtFloat64 &val, char *buffer, int &bufferSize) const
virtual const char * decode (DtFloat64 &val, const char *buffer, int &bufferSize) const
virtual int getSize (const DtVector32 &v) const
virtual char * encode (const DtVector32 &val, char *buffer, int &bufferSize) const
virtual const char * decode (DtVector32 &val, const char *buffer, int &bufferSize) const
virtual int getSize (const DtVector64 &v) const
virtual char * encode (const DtVector64 &val, char *buffer, int &bufferSize) const
virtual const char * decode (DtVector64 &val, const char *buffer, int &bufferSize) const
virtual int getSize (const DtTaitBryan &v) const
virtual char * encode (const DtTaitBryan &val, char *buffer, int &bufferSize) const
virtual const char * decode (DtTaitBryan &val, const char *buffer, int &bufferSize) const
virtual int getSize (const DtString &val) const
virtual char * encode (const DtString &val, char *buffer, int &bufferSize) const
virtual const char * decode (DtString &val, const char *buffer, int &bufferSize) const
virtual int getSize (const bool &v) const
virtual char * encode (const bool &val, char *buffer, int &bufferSize) const
virtual const char * decode (bool &val, const char *buffer, int &bufferSize) const
virtual int getSize (const DtSilentEntity &v) const
virtual char * encode (const DtSilentEntity &val, char *buffer, int &bufferSize) const
virtual const char * decode (DtSilentEntity &val, const char *buffer, int &bufferSize) const
virtual int getSize (const DtSilentAggregate &v) const
virtual char * encode (const DtSilentAggregate &val, char *buffer, int &bufferSize) const
virtual const char * decode (DtSilentAggregate &val, const char *buffer, int &bufferSize) const
virtual int getSize (const DtVariableLengthData &v) const
virtual char * encode (const DtVariableLengthData &val, char *buffer, int &bufferSize) const
virtual const char * decode (DtVariableLengthData &val, const char *buffer, int &bufferSize) const
virtual int getSize (const DtFixedLengthData &value) const
virtual char * encode (const DtFixedLengthData &value, char *buffer, int &bufferSize) const
virtual const char * decode (DtFixedLengthData &value, const char *buffer, int &bufferSize) const
virtual int getSize (const DtAggregateVariableDatum &v) const
virtual char * encode (const DtAggregateVariableDatum &val, char *buffer, int &bufferSize) const
virtual const char * decode (DtAggregateVariableDatum &val, const char *buffer, int &bufferSize) const
virtual int getSize (const DtEmitterBeamData &data) const
virtual char * encode (const DtEmitterBeamData &data, char *buffer, int &bufferSize) const
virtual const char * decode (DtEmitterBeamData &data, const char *buffer, int &bufferSize) const
virtual int getSize (const DtLinearSegmentData &data) const
virtual char * encode (const DtLinearSegmentData &data, char *buffer, int &bufferSize) const
virtual const char * decode (DtLinearSegmentData &data, const char *buffer, int &bufferSize) const
virtual int getSize (const DtActiveSonarBeamData &data) const
virtual char * encode (const DtActiveSonarBeamData &data, char *buffer, int &bufferSize) const
virtual const char * decode (DtActiveSonarBeamData &data, const char *buffer, int &bufferSize) const
virtual int getSize (const DtEntityIdentifier &value) const
virtual char * encode (const DtEntityIdentifier &value, char *buffer, int &bufferSize) const
virtual const char * decode (DtEntityIdentifier &value, const char *buffer, int &bufferSize) const
virtual int getSize (const DtEntityType &value) const
virtual char * encode (const DtEntityType &value, char *buffer, int &bufferSize) const
virtual const char * decode (DtEntityType &value, const char *buffer, int &bufferSize) const
virtual int getSize (const DtSyntheticEnvironmentObjectType &value) const
virtual char * encode (const DtSyntheticEnvironmentObjectType &value, char *buffer, int &bufferSize) const
virtual const char * decode (DtSyntheticEnvironmentObjectType &value, const char *buffer, int &bufferSize) const
virtual int getSize (const DtArticulatedPartCollection &value) const
virtual char * encode (const DtArticulatedPartCollection &value, char *buffer, int &bufferSize) const
virtual const char * decode (DtArticulatedPartCollection &value, const char *buffer, int &bufferSize) const
virtual int getSize (const DtAttachedPartCollection &value) const
virtual char * encode (const DtAttachedPartCollection &value, char *buffer, int &bufferSize) const
virtual const char * decode (DtAttachedPartCollection &value, const char *buffer, int &bufferSize) const
virtual int getSize (const DtIffAtcNavaidsAltParm4 &value) const
virtual char * encode (const DtIffAtcNavaidsAltParm4 &value, char *buffer, int &bufferSize) const
virtual const char * decode (DtIffAtcNavaidsAltParm4 &value, const char *buffer, int &bufferSize) const
virtual int getSize (const DtSimulationAddress &value) const
virtual char * encode (const DtSimulationAddress &value, char *buffer, int &bufferSize) const
virtual const char * decode (DtSimulationAddress &value, const char *buffer, int &bufferSize) const
virtual int getSize (const DtShaftRateData &value) const
virtual char * encode (const DtShaftRateData &value, char *buffer, int &bufferSize) const
virtual const char * decode (DtShaftRateData &value, const char *buffer, int &bufferSize) const
virtual int getSize (const DtRingSectorsRecord &value) const
virtual char * encode (const DtRingSectorsRecord &value, char *buffer, int &bufferSize) const
virtual const char * decode (DtRingSectorsRecord &value, const char *buffer, int &bufferSize) const
virtual int getSize (const DtPostureTransitionRecord &value) const
virtual char * encode (const DtPostureTransitionRecord &value, char *buffer, int &bufferSize) const
virtual const char * decode (DtPostureTransitionRecord &value, const char *buffer, int &bufferSize) const
virtual int getSize (const DtMoppLevelTransitionRecord &value) const
virtual char * encode (const DtMoppLevelTransitionRecord &value, char *buffer, int &bufferSize) const
virtual const char * decode (DtMoppLevelTransitionRecord &value, const char *buffer, int &bufferSize) const
virtual int getSize (const DtIndirectFirePowerRecord &value) const
virtual char * encode (const DtIndirectFirePowerRecord &value, char *buffer, int &bufferSize) const
virtual const char * decode (DtIndirectFirePowerRecord &value, const char *buffer, int &bufferSize) const
virtual int getSize (const DtRangedPowerRecord &value) const
virtual char * encode (const DtRangedPowerRecord &value, char *buffer, int &bufferSize) const
virtual const char * decode (DtRangedPowerRecord &value, const char *buffer, int &bufferSize) const
virtual int getSize (const DtEffectModifierRecord &value) const
virtual char * encode (const DtEffectModifierRecord &value, char *buffer, int &bufferSize) const
virtual const char * decode (DtEffectModifierRecord &value, const char *buffer, int &bufferSize) const
virtual int getSize (const DtTypedQuantityRecord &value) const
virtual char * encode (const DtTypedQuantityRecord &value, char *buffer, int &bufferSize) const
virtual const char * decode (DtTypedQuantityRecord &value, const char *buffer, int &bufferSize) const
virtual int getSize (const DtCasualtyReportRecord &value) const
virtual char * encode (const DtCasualtyReportRecord &value, char *buffer, int &bufferSize) const
virtual const char * decode (DtCasualtyReportRecord &value, const char *buffer, int &bufferSize) const
virtual int getSize (const DtTypedAmountRecord &value) const
virtual char * encode (const DtTypedAmountRecord &value, char *buffer, int &bufferSize) const
virtual const char * decode (DtTypedAmountRecord &value, const char *buffer, int &bufferSize) const
virtual int getSize (const DtEWAttackRecord &value) const
virtual char * encode (const DtEWAttackRecord &value, char *buffer, int &bufferSize) const
virtual const char * decode (DtEWAttackRecord &value, const char *buffer, int &bufferSize) const
virtual int getSize (const DtEWAttackDefendingRecord &value) const
virtual char * encode (const DtEWAttackDefendingRecord &value, char *buffer, int &bufferSize) const
virtual const char * decode (DtEWAttackDefendingRecord &value, const char *buffer, int &bufferSize) const
virtual int getSize (const DtTypedRateRecord &value) const
virtual char * encode (const DtTypedRateRecord &value, char *buffer, int &bufferSize) const
virtual const char * decode (DtTypedRateRecord &value, const char *buffer, int &bufferSize) const
virtual int getSize (const DtAmountRecord &value) const
virtual char * encode (const DtAmountRecord &value, char *buffer, int &bufferSize) const
virtual const char * decode (DtAmountRecord &value, const char *buffer, int &bufferSize) const
virtual int getSize (const DtSensorContactInfo &value) const
virtual char * encode (const DtSensorContactInfo &value, char *buffer, int &bufferSize) const
virtual const char * decode (DtSensorContactInfo &value, const char *buffer, int &bufferSize) const
virtual int getSize (const DtPropulsionSystemData &value) const
virtual char * encode (const DtPropulsionSystemData &value, char *buffer, int &bufferSize) const
virtual const char * decode (DtPropulsionSystemData &value, const char *buffer, int &bufferSize) const
virtual int getSize (const DtNozzleSystemData &value) const
virtual char * encode (const DtNozzleSystemData &value, char *buffer, int &bufferSize) const
virtual const char * decode (DtNozzleSystemData &value, const char *buffer, int &bufferSize) const
virtual int getSize (const DtVrxRecordSetList &value) const
virtual char * encode (const DtVrxRecordSetList &value, char *buffer, int &bufferSize) const
virtual const char * decode (DtVrxRecordSetList &value, const char *buffer, int &bufferSize) const
template<typename T1 , typename T2 >
int getSize (const std::pair< T1, T2 > &value) const
template<typename T1 , typename T2 >
char * encode (const std::pair< T1, T2 > &value, char *buffer, int &bufferSize) const
template<typename T1 , typename T2 >
const char * decode (std::pair< T1, T2 > &value, const char *buffer, int &bufferSize) const
template<typename T >
int getSize (const std::list< T > &value) const
template<typename T >
char * encode (const std::list< T > &value, char *buffer, int &bufferSize) const
template<typename T >
const char * decode (std::list< T > &value, const char *buffer, int &bufferSize) const
template<typename T >
int getSize (const std::vector< T > &value) const
template<typename T >
char * encode (const std::vector< T > &value, char *buffer, int &bufferSize) const
template<typename T >
const char * decode (std::vector< T > &value, const char *buffer, int &bufferSize) const
template<typename T1 , typename T2 >
int getSize (const std::map< T1, T2 > &value) const
template<typename T1 , typename T2 >
char * encode (const std::map< T1, T2 > &value, char *buffer, int &bufferSize) const
template<typename T1 , typename T2 >
const char * decode (std::map< T1, T2 > &value, const char *buffer, int &bufferSize) const
- Protected Attributes inherited from MAKVrExchange::DtPortalMessage
DtU32 myMutableSerialNumber
 Mutable because it can be set by the PConnection.
DtU32 myMutableSendingBrokerId
 Mutable because it can be set by the PConnection.
DtTime myMutableSentTimeStamp
 Mutable because it can be set by the PConnection.
DtTime myMutableReceivedTimeStamp
 Mutable because it can be set by the PConnection.

Detailed Description

Represents a weapon fire event.

DtPortalBoomInteraction represents a noise that sounds like "Boom". This example is very simple and silly, but is intended to show users to how to create portal Interaction messages.

Member Typedef Documentation

typedef void(* DtPortalBoomInteraction::DtPortalBoomInteractionCb)(const DtPortalBoomInteraction &inter, void *usr)

Constructor & Destructor Documentation

DtPortalBoomInteraction::DtPortalBoomInteraction ( )

CTOR.

Referenced by create().

virtual DtPortalBoomInteraction::~DtPortalBoomInteraction ( )
virtual

Virtual DTOR.

Member Function Documentation

static void DtPortalBoomInteraction::addCallback ( MAKVrExchange::DtPortalConnection *  conn,
DtPortalBoomInteractionCb  cb,
void *  usr 
)
static

Adds a callback to be called when interactions are received.

MAKVrExchange::DtPortalMessage * DtPortalBoomInteraction::create ( )
inlinestatic

References DtPortalBoomInteraction().

DtPortalBoomInteraction::DtDEC_ATTRIBUTE ( DtU32  ,
Volume  ,
volume   
)
DtPortalBoomInteraction::DtDEC_ATTRIBUTE ( bool  ,
GroundMovement  ,
groundMovement   
)
virtual unsigned int DtPortalBoomInteraction::netSize ( ) const
virtual

NOTE: DtDEC_ATTRIBUTE resets the access specifier to protected.

Reimplemented from MAKVrExchange::DtPortalInteraction.

virtual std::ostream& DtPortalBoomInteraction::printDataToStream ( std::ostream &  str) const
virtual

Prints the current state of this message to the stream specified by str.

Objects which add attributes must override this method to print them.

Reimplemented from MAKVrExchange::DtPortalInteraction.

virtual void DtPortalBoomInteraction::readSelfFromBuffer ( const void *  buffer,
int  bufferSize 
)
virtual

Reads this message from the memory buffer into this object.

The buffer must be initialized and be at least netSize() bytes long. Objects which add attributes must override this method to read them.

Reimplemented from MAKVrExchange::DtPortalInteraction.

static void DtPortalBoomInteraction::removeCallback ( MAKVrExchange::DtPortalConnection *  conn,
DtPortalBoomInteractionCb  cb,
void *  usr 
)
static

Removes the callback for when interactions are received.

virtual void DtPortalBoomInteraction::writeSelfToBuffer ( void *  buffer,
int  bufferSize 
) const
virtual

Writes this message into the memory buffer provided by buffer.

The buffer must already be allocated and be at least netSize() bytes long. Objects which add attributes must override this method to write them.

Reimplemented from MAKVrExchange::DtPortalInteraction.

Member Data Documentation

const MAKVrExchange::DtPortalMessageKind DtPortalBoomInteraction::theKind
static

NOTE: DtDEC_ATTRIBUTE resets the access specifier to protected.

The documentation for this class was generated from the following file:
Document ID: Generated on Wed Jan 30 18:15:18 EST 2019 from SVN revision 195534
Copyright © 2005-2019 VT MÄK. All Rights Reserved (www.mak.com)