VR-Link API Documentation for DIS
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Public Attributes

Represents Events in DIS. More...

+ Collaboration diagram for DtEventId:

Public Member Functions

 DtEventId (const char *str)
 Constructs a DtEventId instance from a string in the form: "2:4:5" (Site/Host/EventNum)
 DtEventId (int site, int host, int eventNum)
 Constructor.
 DtEventId (DtNetEventId netId)
 Constructs an EventId from a DIS network structure.
 DtEventId ()
 Constructs a default EventId.
 ~DtEventId ()
 Destructor.
void init (int site, int host, int eventNum)
 Provided for backwards compatibility.
void setFromNet (DtNetEventId netId)
 same as DtEventId(DtNetEventId)
 operator DtNetEventId () const
int site () const
 Sets the SiteID.
void setSite (int site)
 Gets the SiteID.
int host () const
 Sets the HostID, also know as the application ID.
void setHost (int host)
 Gets the HostID, also know as the application ID.
int eventNum () const
 Sets the Event Number.
void setEventNum (int eventNum)
 Gets the Event Number.
const char * string () const
 returns a string representation of this class
int operator== (const DtEventId &otherGuy) const
int operator!= (const DtEventId &otherGuy) const

Static Public Member Functions

static const DtEventIdnullId ()
 returns an empty string

Public Attributes

DtSimulationAddress DtSimulator
 Public for backwards compatibility, will be removed in the future.
DtU16 DtEvent
 Public for backwards compatibility, will be removed in the future.
DtString myStringRep
 Public for backwards compatibility, will be removed in the future.

Detailed Description

Represents Events in DIS.

Events take the form of DtSimulationAddress:eventNum. EventIDs are used to match WeaponFire and Detonation Events as well as changes in EmitterSystems. Please consult the DIS standard for more details.

Constructor & Destructor Documentation

DtEventId::DtEventId ( const char *  str)

Constructs a DtEventId instance from a string in the form: "2:4:5" (Site/Host/EventNum)

DtEventId::DtEventId ( int  site,
int  host,
int  eventNum 
)

Constructor.

DtEventId::DtEventId ( DtNetEventId  netId)

Constructs an EventId from a DIS network structure.

DtEventId::DtEventId ( )

Constructs a default EventId.

DtEventId::~DtEventId ( )

Destructor.

Member Function Documentation

int DtEventId::eventNum ( ) const

Sets the Event Number.

int DtEventId::host ( ) const

Sets the HostID, also know as the application ID.

void DtEventId::init ( int  site,
int  host,
int  eventNum 
)

Provided for backwards compatibility.

static const DtEventId& DtEventId::nullId ( )
static

returns an empty string

DtEventId::operator DtNetEventId ( ) const
int DtEventId::operator!= ( const DtEventId otherGuy) const
int DtEventId::operator== ( const DtEventId otherGuy) const
void DtEventId::setEventNum ( int  eventNum)

Gets the Event Number.

void DtEventId::setFromNet ( DtNetEventId  netId)
void DtEventId::setHost ( int  host)

Gets the HostID, also know as the application ID.

void DtEventId::setSite ( int  site)

Gets the SiteID.

int DtEventId::site ( ) const

Sets the SiteID.

const char* DtEventId::string ( ) const

returns a string representation of this class

Member Data Documentation

DtU16 DtEventId::DtEvent

Public for backwards compatibility, will be removed in the future.

DtSimulationAddress DtEventId::DtSimulator

Public for backwards compatibility, will be removed in the future.

DtString DtEventId::myStringRep

Public for backwards compatibility, will be removed in the future.


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

Document ID: Generated on Mon Feb 6 18:36:34 EST 2017 from SVN revision 173107
Copyright © 2005-2016 VT MÄK. All Rights Reserved (www.mak.com)