VR-Forces 5.0.1 Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes
makVrf::DtVrfEntityIdentifierFactory Class Reference

Public Member Functions

 DtVrfEntityIdentifierFactory (DtVrlinkNetworkInterface *)
 
virtual ~DtVrfEntityIdentifierFactory ()
 
virtual DtEntityIdentifier nextId (const DtStateData *, const DtEntityIdentifier &base=DtEntityIdentifier::nullId())
 
virtual void startScenarioLoad ()
 
virtual void endScenarioLoad ()
 
virtual void setAppId (int)
 
int appId () const
 
virtual int setAppIdRangeMax (int upper)
 
int appIdRangeMax () const
 

Protected Member Functions

virtual bool checkAndChange (int &appId, int &entityNum)
 
virtual bool checkAndChange (DtEntityIdentifier &id)
 

Protected Attributes

DtVrlinkNetworkInterfacemyVrfObjectManager
 
std::set< DtStringmyUsedIdentifiers
 
bool myLoadingScenario
 
int myAppId
 
int myAppIdRangeMax
 
std::map< int, intmyAppIdRanges
 
tbb::mutex myEntityIdMutex
 

Constructor & Destructor Documentation

makVrf::DtVrfEntityIdentifierFactory::DtVrfEntityIdentifierFactory ( DtVrlinkNetworkInterface )

CTOR.

virtual makVrf::DtVrfEntityIdentifierFactory::~DtVrfEntityIdentifierFactory ( )
virtual

DTOR.

Member Function Documentation

virtual DtEntityIdentifier makVrf::DtVrfEntityIdentifierFactory::nextId ( const DtStateData ,
const DtEntityIdentifier &  base = DtEntityIdentifier::nullId() 
)
virtual

Return the next available identifier. If there is a given identifer and the site/app does not match the current exercise connection site/app, the user will be warned and a new id created.

virtual void makVrf::DtVrfEntityIdentifierFactory::startScenarioLoad ( )
virtual

Call when about to start loading a scenario. Initializes internal structures for load.

virtual void makVrf::DtVrfEntityIdentifierFactory::endScenarioLoad ( )
virtual

Call when scenario load is over. Clears out internal structures and sets factory to always create a new identifier regardless of whether or not one is passed in.

virtual void makVrf::DtVrfEntityIdentifierFactory::setAppId ( int  )
virtual

Accessor for the current app id.

int makVrf::DtVrfEntityIdentifierFactory::appId ( ) const
inline
virtual int makVrf::DtVrfEntityIdentifierFactory::setAppIdRangeMax ( int  upper)
virtual

Returns the max range in case it is lower than the app id or -1.

int makVrf::DtVrfEntityIdentifierFactory::appIdRangeMax ( ) const
inline
virtual bool makVrf::DtVrfEntityIdentifierFactory::checkAndChange ( int appId,
int entityNum 
)
protectedvirtual

Checks the entity num and app id to be in a valid range. If not returns false.

virtual bool makVrf::DtVrfEntityIdentifierFactory::checkAndChange ( DtEntityIdentifier &  id)
protectedvirtual

Member Data Documentation

DtVrlinkNetworkInterface* makVrf::DtVrfEntityIdentifierFactory::myVrfObjectManager
protected
std::set<DtString> makVrf::DtVrfEntityIdentifierFactory::myUsedIdentifiers
protected
bool makVrf::DtVrfEntityIdentifierFactory::myLoadingScenario
protected
int makVrf::DtVrfEntityIdentifierFactory::myAppId
protected
int makVrf::DtVrfEntityIdentifierFactory::myAppIdRangeMax
protected
std::map<int, int> makVrf::DtVrfEntityIdentifierFactory::myAppIdRanges
protected
tbb::mutex makVrf::DtVrfEntityIdentifierFactory::myEntityIdMutex
protected

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

Document ID: Generated on Mon Jun 20 00:38:30 EDT 2022 from SVN revision 244029
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)