Holds data and provides accessors pertinent to the task state of a single Embedded Entity.

Inheritance diagram for DtRwEmbeddedEntityTaskState:

Public Types
enum	DtEmbeddedEntityControlState { DtIdle, DtWaitingToDeployForForwarding, DtForwardingMessage, DtWaitingToDeploy, DtWaitingToRecover, DtWaitingOnSubtaskCompletion, DtComplete, DtUnable }

Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer

typedef std::vector < DtSymbolString >::iterator	aliasIter

typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter

typedef std::vector< DtFilename >	SearchPaths

typedef std::pair < DtSymbolString, DtString >	DtVariableNameType

typedef DtReaderWriterFactory (	DtReaderWriterFactoryCreatorFcn )()

Public Member Functions
	DtRwEmbeddedEntityTaskState (const DtString &rwName, DtReaderWriterRegistry *parentRegistry=0)

	DtRwEmbeddedEntityTaskState (const DtRwEmbeddedEntityTaskState &orig, DtReaderWriterRegistry *parentRegistry=0)

virtual DtRwEmbeddedEntityTaskState &	operator= (const DtRwEmbeddedEntityTaskState &orig)

virtual	~DtRwEmbeddedEntityTaskState ()

virtual void	increaseTimeWaited (double delta)

virtual void	resetToIdle ()


virtual void	setTaskState (const DtEmbeddedEntityControlState &stateEnum)

virtual DtEmbeddedEntityControlState	taskState () const


virtual void	setTaskId (const int &tskId)

virtual int	taskId () const


virtual void	setSubtaskId (const int &subtskId)

virtual int	subtaskId () const


virtual void	setTimeWaiting (const double &time)

virtual double	timeWaiting () const


virtual void	setEntityName (const DtString &entName)

virtual const DtString &	entityName () const

Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()

	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)

const DtReaderWriter &	operator= (const DtReaderWriter &orig)

bool	operator== (const DtReaderWriter &) const

bool	operator!= (const DtReaderWriter &rhs)

virtual	~DtReaderWriter ()

virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual void	postPutSelf ()

virtual void	prePutSelf ()

virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

virtual void	postGetSelf ()

virtual void	preGetSelf ()

virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual DtSymbolString	name () const

virtual void	addAlias (const DtSymbolString &alias)

virtual void	addAlias (const DtString &alias)

virtual bool	hasAlias (const DtSymbolString &alias)

virtual const aliasContainer &	aliases () const

virtual void	setReadonly (bool flag)

bool	isReadonly () const

virtual void	reset ()

virtual int	alignment () const

virtual bool	variableIsBound () const

virtual void	unbindVariable ()

virtual void	setName (const DtString &)

virtual const char *	readerWriterType () const

virtual const char *	xmlType () const

virtual DtString	prettyPrint () const

std::string	debugText () const

virtual void	bindVariables (DtVariableBindingsList variableBindings)

virtual std::list < DtVariableNameType >	unboundVariables () const

bool	invalid () const

virtual bool	hasChild (const DtReaderWriter *p) const

virtual bool	hasVariableReference () const

virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)

virtual void	recordUpdateTime () const

virtual bool	wasUpdatedSince (DtTime t) const

virtual bool	changedSinceLastChecked ()

virtual bool	peekChangedSinceLastChecked () const

virtual void	putData (std::string &fp, int indentLevel=0)

virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)

virtual void	setValueSpecified (bool specified, bool recurse=false)

virtual bool	valueSpecified () const

virtual bool	isVariableReference () const

virtual void	setIsVariableReference (bool value)

virtual void	clearAllVariableReferenceFlags ()

virtual DtSymbolString	variableName () const

virtual void	setVariableName (const DtSymbolString variableName)

virtual const DtReaderWriter *	defaultRWValue () const

virtual DtReaderWriter *	defaultRWValue ()

virtual void	setDefaultRWValue (DtReaderWriter *)

virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

const DtReaderWriterRegistry &	registry () const

DtReaderWriterRegistry &	registry ()

virtual DtPropertyInterface *	property ()

virtual const DtPropertyInterface *	property () const

virtual DtString	toXml () const

virtual DtRwVariableBindings *	generateVariableBindings () const

virtual bool	toXml (const DtFilename &) const

virtual bool	fromXml (const DtString &)

virtual bool	fromXmlFile (const DtFilename &)

virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const

virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())

virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())

virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Protected Attributes
DtRwInt	myTaskState

DtRwInt	myTaskId

DtRwInt	mySubtaskId

DtRwReal	myTimeWaiting

DtRwString	myEntityName

Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName

DtReaderWriterRegistry	myRegistry

DtReaderWriterRegistry *	myParentRegistry

bool	myValueSpecified

bool	myReadOnlyFlag

bool	myIsVariableReference

DtSymbolString	myVariableName

bool	myVariableIsBound

DtReaderWriter *	myDefaultValue

aliasContainer	myAliases

bool	myInvalid

bool	myChangedFlag

Private Member Functions
	DtRwEmbeddedEntityTaskState ()

Additional Inherited Members
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)

static const DtVariableBindingsList &	nullVariableReference ()

static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)

static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)

static void	setPutIndent (bool)

static bool	putIndent ()

static const char *	theXmlType ()

static const DtFilename &	appPath ()

static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)

static void	createReaderWriterFactory ()

static void	cleanupFactory ()

static DtReaderWriterFactory *	factory ()

static void	setOutputStream (DtOutputStream *stream)

static DtOutputStream &	outputStream ()

static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)

static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)

static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)

static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue

static DtGetSelfCallbackInfo	thePostGetSelfCallback

static DtPutSelfCallbackInfo	thePrePutSelfCallback

static const DtVariableBindingsList	theEmptyVariableBindingsList

static bool	theCreatorFcnSet

static DtReaderWriterFactory *	theFactory

static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn

static bool	thePutIndent

static DtOutputStream *	theOutputStream

Member Enumeration Documentation

enum DtRwEmbeddedEntityTaskState::DtEmbeddedEntityControlState

State enumeration used by DtEmbeddedEntitiesController and stored here for controller state transitions.

Enumerator
DtIdle
DtWaitingToDeployForForwarding
DtForwardingMessage
DtWaitingToDeploy
DtWaitingToRecover
DtWaitingOnSubtaskCompletion
DtComplete
DtUnable

Constructor & Destructor Documentation

DtRwEmbeddedEntityTaskState::DtRwEmbeddedEntityTaskState	(	const DtString &	rwName,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

constructor

DtRwEmbeddedEntityTaskState::DtRwEmbeddedEntityTaskState	(	const DtRwEmbeddedEntityTaskState &	orig,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

copy constructor

virtual DtRwEmbeddedEntityTaskState::~DtRwEmbeddedEntityTaskState ( )

virtual

destructor

DtRwEmbeddedEntityTaskState::DtRwEmbeddedEntityTaskState ( )

private

default constructor; not implemented

Member Function Documentation

virtual DtRwEmbeddedEntityTaskState& DtRwEmbeddedEntityTaskState::operator= ( const DtRwEmbeddedEntityTaskState & orig )

virtual

assignment

virtual void DtRwEmbeddedEntityTaskState::increaseTimeWaited ( double delta )

virtual

Increments myTimeWaiting by the specified amount.

virtual void DtRwEmbeddedEntityTaskState::resetToIdle ( )

virtual

Resets all member variables to their default state.

virtual void DtRwEmbeddedEntityTaskState::setTaskState ( const DtEmbeddedEntityControlState & stateEnum )

virtual

Accessors for myTaskState.

virtual DtEmbeddedEntityControlState DtRwEmbeddedEntityTaskState::taskState ( ) const

virtual

Accessors for myTaskState.

virtual void DtRwEmbeddedEntityTaskState::setTaskId ( const int & tskId )

virtual

Accessors for myTaskId.

virtual int DtRwEmbeddedEntityTaskState::taskId ( ) const

virtual

Accessors for myTaskId.

virtual void DtRwEmbeddedEntityTaskState::setSubtaskId ( const int & subtskId )

virtual

Accessors for mySubtaskIdNote that this is only relevant for making forwarded tasks block to completion.

virtual int DtRwEmbeddedEntityTaskState::subtaskId ( ) const

virtual

Accessors for mySubtaskIdNote that this is only relevant for making forwarded tasks block to completion.

virtual void DtRwEmbeddedEntityTaskState::setTimeWaiting ( const double & time )

virtual

Accessors for myTimeWaiting.

virtual double DtRwEmbeddedEntityTaskState::timeWaiting ( ) const

virtual

Accessors for myTimeWaiting.

virtual void DtRwEmbeddedEntityTaskState::setEntityName ( const DtString & entName )

virtual

Accessors for myEntityName.

virtual const DtString& DtRwEmbeddedEntityTaskState::entityName ( ) const

virtual

Accessors for myEntityName.

Member Data Documentation

DtRwInt DtRwEmbeddedEntityTaskState::myTaskState

protected

DtRwInt DtRwEmbeddedEntityTaskState::myTaskId

protected

DtRwInt DtRwEmbeddedEntityTaskState::mySubtaskId

protected

DtRwReal DtRwEmbeddedEntityTaskState::myTimeWaiting

protected

DtRwString DtRwEmbeddedEntityTaskState::myEntityName

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfobjcore/embeddedEntitiesPSR.h

Public Types

Public Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation