dtHLAGM::EventIdentifier Class Reference

A DIS/RPR-FOM event identifier. More...

#include <distypes.h>

List of all members.

Public Member Functions

 EventIdentifier (unsigned short eventIdentifier=0)
 Constructor.
size_t EncodedLength () const
 Returns the encoded length of this object.
void Encode (char *buf) const
 Encodes this object into the specified buffer.
void Decode (const char *buf)
 Decodes the values contained in the specified buffer.
void SetEventIdentifier (unsigned short eventIdentifier)
 Sets the value of the event identifier field.
unsigned short GetEventIdentifier () const
 Returns the value of the event identifier field.


Detailed Description

A DIS/RPR-FOM event identifier.

Constructor & Destructor Documentation

dtHLAGM::EventIdentifier::EventIdentifier ( unsigned short  eventIdentifier = 0  ) 

Constructor.

Parameters:
eventIdentifier the event identifier


Member Function Documentation

size_t dtHLAGM::EventIdentifier::EncodedLength (  )  const

Returns the encoded length of this object.

Returns:
the encoded length of this object, in bytes

void dtHLAGM::EventIdentifier::Encode ( char *  buf  )  const

Encodes this object into the specified buffer.

Parameters:
buf the buffer to contain the encoded object

void dtHLAGM::EventIdentifier::Decode ( const char *  buf  ) 

Decodes the values contained in the specified buffer.

Parameters:
buf the buffer containing the encoded object

void dtHLAGM::EventIdentifier::SetEventIdentifier ( unsigned short  eventIdentifier  ) 

Sets the value of the event identifier field.

Parameters:
eventIdentifier the value of the event identifier field

unsigned short dtHLAGM::EventIdentifier::GetEventIdentifier (  )  const

Returns the value of the event identifier field.

Returns:
the value of the event identifier field


http://www.delta3d.org
2.0.0 generated 14 Feb 2008