MAK Data Logger API Documentation for HLA
List of all members | Public Member Functions | Protected Attributes
MAKLogger::DtHlaStateObject Class Reference

A HLA state object which represents any HLA object. More...

+ Inheritance diagram for MAKLogger::DtHlaStateObject:
+ Collaboration diagram for MAKLogger::DtHlaStateObject:

Public Member Functions

virtual ~DtHlaStateObject ()
 Constructor.
virtual bool isEntity () const
 Is object an entity.
virtual bool isAggregate () const
 Is object an aggregate.
virtual DtU64 uniqueId () const
 Get a unique identifier for the state object.
virtual DtU64 uniqueId (const DtHlaObject *object) const
 Get the unique id for a hla object.
virtual const DtStringname () const
 The name of the object if it exists (empty string if not).
virtual DtU64 packetId (const DtPacket &packet) const
 Get the unique id from the packet object.
virtual void setPacketId (DtU64, DtPacket &) const
 Attempt to change the uniqueId in a packet.
virtual DtPacketcreateUpdate (const DtAbsoluteTime &currentTime) const
 Create a single update packet.
virtual DtPacketcreateUpdates (const DtAbsoluteTime &currentTime) const
 Create update packet.
virtual DtPacketcreateRemoval (const DtAbsoluteTime &currentTime) const
 Create removal packet.
virtual bool packetForMe (const DtPacket &) const
 Check to see if the packet is for me.
virtual void updateViaPacket (const DtPacket &)
 Update object via packet.
virtual DtHlaTimeStampledStateRepattributes ()
 Get the attributes of the object.
virtual const DtRegionDescSetregionSet () const
 Get the descriptor set for the associated region.
DtLgrHlaHandle objectHandle () const
DtLgrHlaHandle classHandle () const
const DtStringtag () const
- Public Member Functions inherited from MAKLogger::DtStateObject
virtual ~DtStateObject ()
virtual bool equals (const DtStateObject &copy)
 Compare two objects to see if they are equal.
virtual bool operator< (const DtStateObject &second)
 Used for sorting objects, compares unique ids.
virtual bool isEnvironmentalProcess () const
 Optional override for basic type queries.
virtual
DtLgrEntityTracker::EntryHandle 
entityTrackingId () const
 Set/Get entity tracking ID.
virtual void setEntityTrackingId (DtLgrEntityTracker::EntryHandle id)
 Set/Get entity tracking ID.

Protected Attributes

DtLgrHlaHandle myObjectHandle
DtLgrHlaHandle myClassHandle
DtString myName
DtString myTag
DtLgrHlaMessageStatemyState
DtHlaTimeStampledStateRepmyAttributes
DtRegionDescSet myRegions
const DtBaseObjClassDescmyClassDesc
- Protected Attributes inherited from MAKLogger::DtStateObject
DtLgrEntityTracker::EntryHandle myEntityTrackingId

Detailed Description

A HLA state object which represents any HLA object.

Constructor & Destructor Documentation

virtual MAKLogger::DtHlaStateObject::~DtHlaStateObject ( )
virtual

Constructor.

Base constructor. Destructor.

Member Function Documentation

virtual DtHlaTimeStampledStateRep* MAKLogger::DtHlaStateObject::attributes ( )
virtual

Get the attributes of the object.

DtLgrHlaHandle MAKLogger::DtHlaStateObject::classHandle ( ) const
inline
virtual DtPacket* MAKLogger::DtHlaStateObject::createRemoval ( const DtAbsoluteTime currentTime) const
virtual

Create removal packet.

Implements MAKLogger::DtStateObject.

virtual DtPacket* MAKLogger::DtHlaStateObject::createUpdate ( const DtAbsoluteTime currentTime) const
virtual

Create a single update packet.

virtual DtPacket* MAKLogger::DtHlaStateObject::createUpdates ( const DtAbsoluteTime currentTime) const
virtual

Create update packet.

virtual bool MAKLogger::DtHlaStateObject::isAggregate ( ) const
virtual

Is object an aggregate.

Reimplemented from MAKLogger::DtStateObject.

virtual bool MAKLogger::DtHlaStateObject::isEntity ( ) const
virtual

Is object an entity.

Reimplemented from MAKLogger::DtStateObject.

virtual const DtString& MAKLogger::DtHlaStateObject::name ( ) const
virtual

The name of the object if it exists (empty string if not).

Implements MAKLogger::DtStateObject.

DtLgrHlaHandle MAKLogger::DtHlaStateObject::objectHandle ( ) const
inline
virtual bool MAKLogger::DtHlaStateObject::packetForMe ( const DtPacket ) const
virtual

Check to see if the packet is for me.

Implements MAKLogger::DtStateObject.

virtual DtU64 MAKLogger::DtHlaStateObject::packetId ( const DtPacket packet) const
virtual

Get the unique id from the packet object.

Implements MAKLogger::DtStateObject.

virtual const DtRegionDescSet& MAKLogger::DtHlaStateObject::regionSet ( ) const
virtual

Get the descriptor set for the associated region.

virtual void MAKLogger::DtHlaStateObject::setPacketId ( DtU64  ,
DtPacket  
) const
virtual

Attempt to change the uniqueId in a packet.

This does not modify the unique Id of the object.

Implements MAKLogger::DtStateObject.

const DtString& MAKLogger::DtHlaStateObject::tag ( ) const
inline
virtual DtU64 MAKLogger::DtHlaStateObject::uniqueId ( ) const
virtual

Get a unique identifier for the state object.

Implements MAKLogger::DtStateObject.

virtual DtU64 MAKLogger::DtHlaStateObject::uniqueId ( const DtHlaObject *  object) const
virtual

Get the unique id for a hla object.

virtual void MAKLogger::DtHlaStateObject::updateViaPacket ( const DtPacket )
virtual

Update object via packet.

Implements MAKLogger::DtStateObject.

Member Data Documentation

DtHlaTimeStampledStateRep* MAKLogger::DtHlaStateObject::myAttributes
protected
const DtBaseObjClassDesc* MAKLogger::DtHlaStateObject::myClassDesc
mutableprotected
DtLgrHlaHandle MAKLogger::DtHlaStateObject::myClassHandle
protected
DtString MAKLogger::DtHlaStateObject::myName
protected
DtLgrHlaHandle MAKLogger::DtHlaStateObject::myObjectHandle
protected
DtRegionDescSet MAKLogger::DtHlaStateObject::myRegions
protected
DtLgrHlaMessageState* MAKLogger::DtHlaStateObject::myState
protected
DtString MAKLogger::DtHlaStateObject::myTag
protected

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

Document ID: Generated on Thu Apr 10 18:53:01 EDT 2014 from SVN revision 138105
Copyright © 2005-2012 VT MÄK. All Rights Reserved (www.mak.com)