VR-Link API Documentation for HLA 1.3
List of all members | Public Member Functions | Protected Member Functions
DtObjectTagModifier Class Reference

Instances of DtObjectTagModifier are registered with the DtExerciseConn, in order to modify the userTag of HLA object updates. More...

Public Member Functions

 DtObjectTagModifier ()
 Constructor.
virtual ~DtObjectTagModifier ()
 Destructor.
virtual void modifyTag (DtStateMsg *msg, const DtStateRepository *rep)=0
 Modifies the user tag of a DtStateMsg.

Protected Member Functions

 DtObjectTagModifier (const DtObjectTagModifier &orig)
 Copy constructor not implemented - not copiable.
DtObjectTagModifieroperator= (const DtObjectTagModifier &orig)
 Assignment operator not implemented - not copiable.

Detailed Description

Instances of DtObjectTagModifier are registered with the DtExerciseConn, in order to modify the userTag of HLA object updates.

These may be registered by the exercise connection's setObjectTagModifier() method, and are expected to be passed in the form of shared pointers, or DtObjectTagModifierSP. DtObjectTagModifier is an abstract class, and the modifyTag method is meant to be implemented by the user.

Examples

Constructor & Destructor Documentation

DtObjectTagModifier::DtObjectTagModifier ( )

Constructor.

virtual DtObjectTagModifier::~DtObjectTagModifier ( )
virtual

Destructor.

DtObjectTagModifier::DtObjectTagModifier ( const DtObjectTagModifier orig)
protected

Copy constructor not implemented - not copiable.

Member Function Documentation

virtual void DtObjectTagModifier::modifyTag ( DtStateMsg msg,
const DtStateRepository rep 
)
pure virtual

Modifies the user tag of a DtStateMsg.

This function is meant to be overridden, and is called for an object every time an update for it is sent out. setCustomTag should be called on the DtStateMsg to modify the tag, and the state repository may be cast to the appropriate type, if known.

Parameters
msgThe state message that contains the tag
repThe state repository that accompanies the message
DtObjectTagModifier& DtObjectTagModifier::operator= ( const DtObjectTagModifier orig)
protected

Assignment operator not implemented - not copiable.


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

Document ID: Generated on Wed Aug 14 15:35:11 EDT 2013 from SVN revision 130445
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)