DtIfSimOperationsInProgress Class Reference

Bit flags which will contain a particular sim operation in progress that the GUI can use to display icons to the user.

Inheritance diagram for DtIfSimOperationsInProgress:

Classes
struct	FluxStatus

Public Types
enum	Operation {   TerrainPaging = 0x00000001, NavOperation = 0x00000002, ClutterOperation = 0x00000004, MovementOrCreateOperation = 0x00000008,   TransferOperation = 0x00000010 }
typedef std::map< int, FluxStatus >	ObjectsInFlux

Public Member Functions
	DtIfSimOperationsInProgress ()
virtual	~DtIfSimOperationsInProgress () override
	DtIfSimOperationsInProgress (const DtIfSimOperationsInProgress &orig)
DtIfSimOperationsInProgress &	operator= (const DtIfSimOperationsInProgress &orig)
virtual int	type () const override
virtual DtSimInterfaceContent *	clone () const override
virtual bool	setOperationInProgress (Operation flag, bool on)
virtual bool	operationIsInProgress (Operation) const
unsigned int	operations () const
const ObjectsInFlux &	objectsInFlux () const
virtual int	netRepSize () const override
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize) override
virtual bool	setToNet () override
virtual void	printDataToString (DtString &str) override
virtual void	clearAllOperations ()
virtual int	addObjectInFlux (const DtUUID &moving, const DtVector &movingTo, int replace=-1)
virtual int	addObjectInFlux (const DtString &markingText, int force, const DtEntityType &type, const DtVector &creatingAt, int replace=-1)
virtual bool	removeObjectInFlux (int)
virtual void	setFluxCap (int)
int	fluxCap () const
Public Member Functions inherited from DtSimInterfaceContent
virtual	~DtSimInterfaceContent ()
virtual bool	update (const DtSimInterfaceContent *data)
virtual char *	netRep ()
virtual void	printContentType (DtString &str)
virtual void	setUseSessionId (bool yesNo)
virtual bool	useSessionId () const

Static Public Member Functions
static DtSimInterfaceContent *	creator ()
Static Public Member Functions inherited from DtSimInterfaceContent
static DtSimInterfaceContent *	createInterfaceContent (int type)
static void	addInterfaceContentCreatorFcn (int type, DtInterfaceContentCreatorFcn fcn)
static void	setFactory (DtInterfaceContentFactory *factory)
static DtInterfaceContentFactory *	factory ()
static void	registerContentTypePrinter (DtSimInterfaceContentTypePrinterFcn printFcn)

Protected Attributes
DtU32	myOperations
ObjectsInFlux	myObjectsInFlux
int	myFluxIndex = 0
int	myFluxCap = 100
Protected Attributes inherited from DtSimInterfaceContent
char *	myNetRep
bool	myUseSessionId

Additional Inherited Members
Protected Member Functions inherited from DtSimInterfaceContent
	DtSimInterfaceContent ()
	DtSimInterfaceContent (const DtSimInterfaceContent &orig)
const DtSimInterfaceContent &	operator= (const DtSimInterfaceContent &orig)
virtual char *	createNetworkBuffer ()
Static Protected Attributes inherited from DtSimInterfaceContent
static DtInterfaceContentFactory *	myFactory
static DtSimInterfaceContentTypePrinterFcn	theContentTypePrinterFcn

Member Typedef Documentation

typedef std::map<int, FluxStatus> DtIfSimOperationsInProgress::ObjectsInFlux

Member Enumeration Documentation

enum DtIfSimOperationsInProgress::Operation

Enumerator
TerrainPaging
NavOperation
ClutterOperation
MovementOrCreateOperation
TransferOperation

Constructor & Destructor Documentation

DtIfSimOperationsInProgress::DtIfSimOperationsInProgress

(

)

default constructor

virtual DtIfSimOperationsInProgress::~DtIfSimOperationsInProgress ( )

overridevirtual

destructor

DtIfSimOperationsInProgress::DtIfSimOperationsInProgress

(

const DtIfSimOperationsInProgress &

orig

)

copy constructor

Member Function Documentation

DtIfSimOperationsInProgress& DtIfSimOperationsInProgress::operator=

(

const DtIfSimOperationsInProgress &

orig

)

assignment operator

virtual int DtIfSimOperationsInProgress::type ( ) const

overridevirtual

Returns the type of Interface Content.

Implements DtSimInterfaceContent.

virtual DtSimInterfaceContent* DtIfSimOperationsInProgress::clone ( ) const

overridevirtual

Implements DtSimInterfaceContent.

virtual bool DtIfSimOperationsInProgress::setOperationInProgress ( Operation  flag, bool  on  )

virtual

Enable/disable auto-reorganization. For setting, will return true if the flag was set on (if not already on) or off (if not already off)

virtual bool DtIfSimOperationsInProgress::operationIsInProgress ( Operation  ) const

virtual

unsigned int DtIfSimOperationsInProgress::operations ( ) const

inline

const ObjectsInFlux& DtIfSimOperationsInProgress::objectsInFlux ( ) const

inline

virtual int DtIfSimOperationsInProgress::netRepSize ( ) const

overridevirtual

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfSimOperationsInProgress::setFromNet ( const char *  contentBuffer, unsigned  contentSize  )

overridevirtual

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfSimOperationsInProgress::setToNet ( )

overridevirtual

Reimplemented from DtSimInterfaceContent.

virtual void DtIfSimOperationsInProgress::printDataToString ( DtString &  str )

overridevirtual

Reimplemented from DtSimInterfaceContent.

virtual void DtIfSimOperationsInProgress::clearAllOperations ( )

virtual

virtual int DtIfSimOperationsInProgress::addObjectInFlux ( const DtUUID &  moving, const DtVector &  movingTo, int  replace = -1  )

virtual

Returns the index into which this object has been placed in the queue. To remove use the supplied index.

virtual int DtIfSimOperationsInProgress::addObjectInFlux ( const DtString &  markingText, int  force, const DtEntityType &  type, const DtVector &  creatingAt, int  replace = -1  )

virtual

virtual bool DtIfSimOperationsInProgress::removeObjectInFlux ( int  )

virtual

virtual void DtIfSimOperationsInProgress::setFluxCap ( int  )

virtual

The maximum number of objects that can be in the flux queue.

int DtIfSimOperationsInProgress::fluxCap ( ) const

inline

static DtSimInterfaceContent* DtIfSimOperationsInProgress::creator ( )

static

Member Data Documentation

DtU32 DtIfSimOperationsInProgress::myOperations

protected

ObjectsInFlux DtIfSimOperationsInProgress::myObjectsInFlux

protected

int DtIfSimOperationsInProgress::myFluxIndex = 0

protected

int DtIfSimOperationsInProgress::myFluxCap = 100

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfmsgs/ifSimOperationsInProgress.h