DtAffectEngineeringObjectPSR Class Reference

This is a process state repository for the DtAffectEngineeringObjectController.

Inheritance diagram for DtAffectEngineeringObjectPSR:

Public Types
enum	DtAffectEngineeringObjectState {   DtIdle, DtMovingIntoRange, DtSettingUp, DtAffecting,   DtAffectingPaused }
typedef std::map< DtString, double >	DtResourceMap
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
	DtAffectEngineeringObjectPSR (DtLocalObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	DtAffectEngineeringObjectPSR (const DtAffectEngineeringObjectPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtAffectEngineeringObjectPSR ()
DtAffectEngineeringObjectPSR &	operator= (const DtAffectEngineeringObjectPSR &orig)
virtual DtVrfProcessStateRepository *	clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
virtual DtString	type () const
virtual void	clear ()
virtual void	setObjectJustCreated (bool)
virtual bool	objectJustCreated () const
virtual const DtRwVectorList *	nextObjectVertices () const
virtual const DtRwVectorList *	currentObjectVertices () const
virtual unsigned	currentObjectIndex () const
virtual const DtLocalVertexList *	currentLocalObjectsVertices (const Coordinate_System *) const
virtual void	setState (DtAffectEngineeringObjectState state)
virtual DtAffectEngineeringObjectState	state () const
virtual void	setIsObjectCreated (bool created)
virtual bool	isObjectCreated () const
virtual void	setEngineeringObject (const DtUUID &)
virtual DtSimObjectReference	engineeringObject () const
virtual void	setObjectType (const DtObjectType &objType)
virtual const DtObjectType &	objectType () const
virtual void	setObjectsVertices (const DtRwShapeObjectList &v)
virtual const DtRwShapeObjectList &	objectsVertices () const
virtual void	setObjectRadius (double w)
virtual double	objectRadius () const
virtual void	setResourcesUsed (const DtResourceMap &resources)
virtual const DtResourceMap &	resourcesUsed () const
virtual void	setRange (double r)
virtual double	range () const
virtual void	setStrength (double s)
virtual double	strength () const
virtual void	setInstantaneous (bool isInstantaneous)
virtual bool	instantaneous () const
virtual void	setCreatorsHealth (int health)
virtual int	creatorsHealth () const
virtual void	setSetupTime (double t)
virtual double	setupTime () const
virtual void	setLastUpdateTime (double t)
virtual double	lastUpdateTime () const
virtual void	setSetupStartTime (double t)
virtual double	setupStartTime () const
virtual void	setProhibitedTerrainQueryName (const DtString &n)
virtual const DtString &	prohibitedTerrainQueryName () const
Public Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository (DtLocalObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	DtVrfProcessStateRepository (const DtVrfProcessStateRepository &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
const DtVrfProcessStateRepository &	operator= (const DtVrfProcessStateRepository &orig)
virtual	~DtVrfProcessStateRepository ()
virtual bool	init ()
virtual bool	loadedFromMTL () const
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override
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	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	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)

Static Public Member Functions
static DtVrfProcessStateRepository *	creator (const DtString &rwName, DtLocalObject *vrfObject, DtReaderWriterRegistry *parentRegistry)
Static Public Member Functions inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	factory ()
static void	setFactory (DtVrfProcessStateRepositoryFactory *factory)
static void	addVrfProcessStateRepositoryCreatorFcn (const DtString &type, DtVrfProcessStateRepositoryCreatorFcn fcn)
static DtVrfProcessStateRepository *	createRepository (const DtString &name, const DtString &type, DtLocalObject *vrfObject, DtReaderWriterRegistry *parentRegistry=0)
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 Attributes
DtRwBoolean	myIsObjectCreated
DtRwInt	myState
DtRwSimObjectReference	myEngineeringObject
DtRwObjectType	myObjectType
DtRwShapeObjectList	myObjectsVertices
DtRwReal	myObjectRadius
DtRwTemplatedRealList	myResourceUsage
DtRwReal	myRange
DtRwReal	myStrength
DtRwBoolean	myInstantaneous
DtRwInt	myCreatorsHealth
DtRwReal	mySetupTime
DtRwReal	myLastUpdateTime
DtRwReal	mySetupStartTime
DtRwString	myProhibitedTerrainQueryName
DtRwInt	myNextObjectIndex
DtRwVectorList *	myCurrentObjectVertices
DtLocalVertexList	myCurrentLocalObjectVertices
DtResourceMap	myResourceMap
bool	myObjectJustCreated
Protected Attributes inherited from DtVrfProcessStateRepository
DtLocalObject *	myVrfObject
bool	myLoadedFromMTL
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

Additional Inherited Members
Protected Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository ()
const DtSimObject *	vrfObject () const
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
Static Protected Attributes inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	theFactory
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 Typedef Documentation

typedef std::map<DtString, double> DtAffectEngineeringObjectPSR::DtResourceMap

Member Enumeration Documentation

enum DtAffectEngineeringObjectPSR::DtAffectEngineeringObjectState

Enumerator
DtIdle
DtMovingIntoRange
DtSettingUp
DtAffecting
DtAffectingPaused

Constructor & Destructor Documentation

DtAffectEngineeringObjectPSR::DtAffectEngineeringObjectPSR	(	DtLocalObject *	vrfObject,
		const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor

DtAffectEngineeringObjectPSR::DtAffectEngineeringObjectPSR	(	const DtAffectEngineeringObjectPSR &	orig,
		const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtAffectEngineeringObjectPSR::~DtAffectEngineeringObjectPSR ( )

virtual

destructor

Member Function Documentation

DtAffectEngineeringObjectPSR& DtAffectEngineeringObjectPSR::operator=

(

const DtAffectEngineeringObjectPSR &

orig

)

assignment operator

virtual DtVrfProcessStateRepository* DtAffectEngineeringObjectPSR::clone ( const DtString &  rwName = DtString::nullString(), DtReaderWriterRegistry *  parentRegistry = 0  ) const

virtual

returns a newly created copy of this object

Implements DtVrfProcessStateRepository.

virtual DtString DtAffectEngineeringObjectPSR::type ( ) const

virtual

Returns the string type of this process state repository, defined in procSRTypes.h. Returns "affect-engineering-object-controller-psr".

Implements DtVrfProcessStateRepository.

virtual void DtAffectEngineeringObjectPSR::clear ( )

virtual

Clears all stored values and sets to default settings.

virtual void DtAffectEngineeringObjectPSR::setState ( DtAffectEngineeringObjectState  state )

virtual

Set/get current state in process of affecting the engineering object.

virtual DtAffectEngineeringObjectState DtAffectEngineeringObjectPSR::state ( ) const

virtual

Set/get current state in process of affecting the engineering object.

virtual void DtAffectEngineeringObjectPSR::setIsObjectCreated ( bool  created )

virtual

Set/get whether the object has already been created, but may still require improvement.

virtual bool DtAffectEngineeringObjectPSR::isObjectCreated ( ) const

virtual

Set/get whether the object has already been created, but may still require improvement.

virtual void DtAffectEngineeringObjectPSR::setEngineeringObject ( const DtUUID &  )

virtual

Set/get the name of the object to be affected.

virtual DtSimObjectReference DtAffectEngineeringObjectPSR::engineeringObject ( ) const

virtual

Set/get the name of the object to be affected.

virtual void DtAffectEngineeringObjectPSR::setObjectType ( const DtObjectType &  objType )

virtual

Set/get the type of the object to be affected.

virtual const DtObjectType& DtAffectEngineeringObjectPSR::objectType ( ) const

virtual

Set/get the type of the object to be affected.

virtual void DtAffectEngineeringObjectPSR::setObjectsVertices ( const DtRwShapeObjectList &  v )

virtual

Set/get the global vertices of the object(s) to be affected.

virtual const DtRwShapeObjectList& DtAffectEngineeringObjectPSR::objectsVertices ( ) const

virtual

Set/get the global vertices of the object(s) to be affected.

virtual void DtAffectEngineeringObjectPSR::setObjectJustCreated ( bool  )

virtual

For double buffering, have to skip the first tick of this object to allow it to properly initialize.

virtual bool DtAffectEngineeringObjectPSR::objectJustCreated ( ) const

virtual

virtual const DtRwVectorList* DtAffectEngineeringObjectPSR::nextObjectVertices ( ) const

virtual

Increments to the next object in the list and returns the vertices for that object. Returns a null pointer when the end of the list has been reached.

virtual const DtRwVectorList* DtAffectEngineeringObjectPSR::currentObjectVertices ( ) const

virtual

Gets the vertices for the current object. Must call nextObjectVertices prior to calling this call for the first time, otherwise returns a null pointer.

virtual unsigned DtAffectEngineeringObjectPSR::currentObjectIndex ( ) const

virtual

Index of the current object being affected.

virtual const DtLocalVertexList* DtAffectEngineeringObjectPSR::currentLocalObjectsVertices ( const Coordinate_System *  ) const

virtual

Gets the local vertices for the current object. Must call nextObjectVertices prior to calling this call for the first time, otherwise returns a null pointer.

virtual void DtAffectEngineeringObjectPSR::setObjectRadius ( double  w )

virtual

Set/get the radius (meters) of the engineering object.

virtual double DtAffectEngineeringObjectPSR::objectRadius ( ) const

virtual

Set/get the radius (meters) of the engineering object.

virtual void DtAffectEngineeringObjectPSR::setResourcesUsed ( const DtResourceMap &  resources )

virtual

Set/get the map of resource types to usage rates.

virtual const DtResourceMap& DtAffectEngineeringObjectPSR::resourcesUsed ( ) const

virtual

Set/get the map of resource types to usage rates.

virtual void DtAffectEngineeringObjectPSR::setRange ( double  r )

virtual

Set/get the range at which this task can be performed.

virtual double DtAffectEngineeringObjectPSR::range ( ) const

virtual

Set/get the range at which this task can be performed.

virtual void DtAffectEngineeringObjectPSR::setStrength ( double  s )

virtual

Set/get the strength at which this task is performed, measured in percent complete per hour.

virtual double DtAffectEngineeringObjectPSR::strength ( ) const

virtual

Set/get the strength at which this task is performed, measured in percent complete per hour.

virtual void DtAffectEngineeringObjectPSR::setInstantaneous ( bool  isInstantaneous )

virtual

Set/get whether this task completes instantaneously.

virtual bool DtAffectEngineeringObjectPSR::instantaneous ( ) const

virtual

Set/get whether this task completes instantaneously.

virtual void DtAffectEngineeringObjectPSR::setCreatorsHealth ( int  health )

virtual

Set/get the health of the creating unit.

virtual int DtAffectEngineeringObjectPSR::creatorsHealth ( ) const

virtual

Set/get the health of the creating unit.

virtual void DtAffectEngineeringObjectPSR::setSetupTime ( double  t )

virtual

Set/get the setup time required for the task.

virtual double DtAffectEngineeringObjectPSR::setupTime ( ) const

virtual

Set/get the setup time required for the task.

virtual void DtAffectEngineeringObjectPSR::setLastUpdateTime ( double  t )

virtual

Set/get the last update time.

virtual double DtAffectEngineeringObjectPSR::lastUpdateTime ( ) const

virtual

Set/get the last update time.

virtual void DtAffectEngineeringObjectPSR::setSetupStartTime ( double  t )

virtual

Set/get the setup start time for tasks that require some setup.

virtual double DtAffectEngineeringObjectPSR::setupStartTime ( ) const

virtual

Set/get the setup start time for tasks that require some setup.

virtual void DtAffectEngineeringObjectPSR::setProhibitedTerrainQueryName ( const DtString &  n )

virtual

Set/get the name of the feature query which indicates terrain that it is prohibited to create this object on.

virtual const DtString& DtAffectEngineeringObjectPSR::prohibitedTerrainQueryName ( ) const

virtual

Set/get the name of the feature query which indicates terrain that it is prohibited to create this object on.

static DtVrfProcessStateRepository* DtAffectEngineeringObjectPSR::creator ( const DtString &  rwName, DtLocalObject *  vrfObject, DtReaderWriterRegistry *  parentRegistry  )

static

Returns a newly created instance of this class.

Member Data Documentation

DtRwBoolean DtAffectEngineeringObjectPSR::myIsObjectCreated

protected

DtRwInt DtAffectEngineeringObjectPSR::myState

protected

DtRwSimObjectReference DtAffectEngineeringObjectPSR::myEngineeringObject

protected

DtRwObjectType DtAffectEngineeringObjectPSR::myObjectType

protected

DtRwShapeObjectList DtAffectEngineeringObjectPSR::myObjectsVertices

protected

DtRwReal DtAffectEngineeringObjectPSR::myObjectRadius

protected

DtRwTemplatedRealList DtAffectEngineeringObjectPSR::myResourceUsage

protected

DtRwReal DtAffectEngineeringObjectPSR::myRange

protected

DtRwReal DtAffectEngineeringObjectPSR::myStrength

protected

DtRwBoolean DtAffectEngineeringObjectPSR::myInstantaneous

protected

DtRwInt DtAffectEngineeringObjectPSR::myCreatorsHealth

protected

DtRwReal DtAffectEngineeringObjectPSR::mySetupTime

protected

DtRwReal DtAffectEngineeringObjectPSR::myLastUpdateTime

protected

DtRwReal DtAffectEngineeringObjectPSR::mySetupStartTime

protected

DtRwString DtAffectEngineeringObjectPSR::myProhibitedTerrainQueryName

protected

DtRwInt DtAffectEngineeringObjectPSR::myNextObjectIndex

mutableprotected

DtRwVectorList* DtAffectEngineeringObjectPSR::myCurrentObjectVertices

mutableprotected

DtLocalVertexList DtAffectEngineeringObjectPSR::myCurrentLocalObjectVertices

mutableprotected

DtResourceMap DtAffectEngineeringObjectPSR::myResourceMap

mutableprotected

bool DtAffectEngineeringObjectPSR::myObjectJustCreated

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfobjcore/affectEngineeringObjectPSR.h