VR-Forces 4.6.1 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes
DtAffectEngineeringObjectPSR Class Reference

This is a process state repository for the DtAffectEngineeringObjectController. More...

Inheritance diagram for DtAffectEngineeringObjectPSR:
Inheritance graph
[legend]

Public Types

enum  DtAffectEngineeringObjectState {
  DtIdle, DtMovingIntoRange, DtSettingUp, DtAffecting,
  DtAffectingPaused
}
typedef std::map< DtString,
double
DtResourceMap

Public Member Functions

 DtAffectEngineeringObjectPSR (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 constructor
 DtAffectEngineeringObjectPSR (const DtAffectEngineeringObjectPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 copy constructor
virtual ~DtAffectEngineeringObjectPSR ()
 destructor
DtAffectEngineeringObjectPSRoperator= (const DtAffectEngineeringObjectPSR &orig)
 assignment operator
virtual
DtVrfProcessStateRepository
clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
 returns a newly created copy of this object
virtual DtString type () const
 Returns the string type of this process state repository, defined in procSRTypes.h.
virtual void clear ()
 Clears all stored values and sets to default settings.
virtual const DtRwVectorListnextObjectVertices () const
 Increments to the next object in the list and returns the vertices for that object.
virtual const DtRwVectorListcurrentObjectVertices () const
 Gets the vertices for the current object.
virtual const DtLocalVertexListcurrentLocalObjectsVertices (const Coordinate_System *) const
 Gets the local vertices for the current object.
virtual void setState (DtAffectEngineeringObjectState state)
 Set/get current state in process of affecting the engineering object.
virtual
DtAffectEngineeringObjectState 
state () const
virtual void setIsObjectCreated (bool created)
 Set/get whether the object has already been created, but may still require improvement.
virtual bool isObjectCreated () const
virtual void setEngineeringObject (const DtUUID &)
 Set/get the name of the object to be affected.
virtual const
DtRwVrfObjectReference
engineeringObject () const
virtual DtRwVrfObjectReferenceengineeringObject ()
virtual void setObjectType (const DtObjectType &objType)
 Set/get the type of the object to be affected.
virtual const DtObjectTypeobjectType () const
virtual void setObjectsVertices (const DtRwShapeObjectList &v)
 Set/get the global vertices of the object(s) to be affected.
virtual const DtRwShapeObjectListobjectsVertices () const
virtual void setObjectRadius (double w)
 Set/get the radius (meters) of the engineering object.
virtual double objectRadius () const
virtual void setResourcesUsed (const DtResourceMap &resources)
 Set/get the map of resource types to usage rates.
virtual const DtResourceMapresourcesUsed () const
virtual void setRange (double r)
 Set/get the range at which this task can be performed.
virtual double range () const
virtual void setStrength (double s)
 Set/get the strength at which this task is performed, measured in percent complete per hour.
virtual double strength () const
virtual void setInstantaneous (bool isInstantaneous)
 Set/get whether this task completes instantaneously.
virtual bool instantaneous () const
virtual void setCreatorsHealth (int health)
 Set/get the health of the creating unit.
virtual int creatorsHealth () const
virtual void setSetupTime (double t)
 Set/get the setup time required for the task.
virtual double setupTime () const
virtual void setLastUpdateTime (double t)
 Set/get the last update time.
virtual double lastUpdateTime () const
virtual void setSetupStartTime (double t)
 Set/get the setup start time for tasks that require some setup.
virtual double setupStartTime () const
virtual void setProhibitedTerrainQueryName (const DtString &n)
 Set/get the name of the feature query which indicates terrain that it is prohibited to create this object on.
virtual const DtStringprohibitedTerrainQueryName () const
- Public Member Functions inherited from DtVrfProcessStateRepository
 DtVrfProcessStateRepository (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
 DtVrfProcessStateRepository (const DtVrfProcessStateRepository &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
const DtVrfProcessStateRepositoryoperator= (const DtVrfProcessStateRepository &orig)
virtual ~DtVrfProcessStateRepository ()
virtual bool init ()
 Used for virtual construction. This base method simply returns true.
virtual bool loadedFromMTL () const
virtual void getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
- Public Member Functions inherited from DtReaderWriter
 DtReaderWriter ()
 default constructor
 DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 real constructor Setting the readonly flag prevents object from writing itself to the stream.
 DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 pseudo-copy constructor
 DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor
const DtReaderWriteroperator= (const DtReaderWriter &orig)
 assignment operator
bool operator== (const DtReaderWriter &) const
 Equivalence operator.
bool operator!= (const DtReaderWriter &rhs)
virtual ~DtReaderWriter ()
 destructor
virtual void putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 Top level call to write itself to file.
virtual void postPutSelf ()
 Called after either version of put self (file or environment). Default is no-op.
virtual void prePutSelf ()
 Called before either version of put self (file or environment). Default is no-op.
virtual void getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 Top level to read itself from an input stream.
virtual void postGetSelf ()
 Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void preGetSelf ()
 Called before either version of get self (file or environment). Default is no-op.
virtual void writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString name () const
 Accessor for name of this readable/writable object.
virtual void addAlias (const DtSymbolString &alias)
 Add an alias as an alternative name for this object.
virtual void addAlias (const DtString &alias)
virtual bool hasAlias (const DtSymbolString &alias)
virtual const aliasContaineraliases () const
virtual void setReadonly (bool flag)
 Set read-only flag.
bool isReadonly () const
virtual void reset ()
 For those reader/writer items that support it, resets the reader/writer value to original state Default is no-op.
virtual int alignment () const
 For those items that are sent over the network via HLA, this will give the network alignment.
virtual bool variableIsBound () const
virtual void unbindVariable ()
 Sets the myVariableIsBound flag to false.
virtual void setName (const DtString &)
 Set the name of the object.
virtual const charreaderWriterType () const
 Used to supply a string type that this reader writer type is.
virtual const charxmlType () const
virtual DtString prettyPrint () const
 Routine to return a human readable form of the reader/writer variable.
std::string debugText () const
virtual void bindVariables (DtVariableBindingsList variableBindings)
 Runs a variable binding pass on this reader writer and any of its children.
virtual std::list
< DtVariableNameType
unboundVariables () const
bool invalid () const
virtual bool hasChild (const DtReaderWriter *p) const
 Returns true if this variable has a child p in it's chain.
virtual bool hasVariableReference () const
 Returns true if this item or any item in the registry (recursive) is a variable reference.
virtual void bindLocalVariables (const DtVariableBindingsList &variableBindings)
 Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual void recordUpdateTime () const
 Can be implemented in subclasses to stamp the time when updated.
virtual bool wasUpdatedSince (DtTime t) const
 Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual bool changedSinceLastChecked ()
 Returns true if this objects value has changed since the last time this function was called.
virtual bool peekChangedSinceLastChecked () const
 Returns the value that changedSinceLastChecked would return but does not reset the internal flag.
virtual void putData (std::string &fp, int indentLevel=0)
 Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual void setValueSpecified (bool specified, bool recurse=false)
 The specified flags are used for optional values.
virtual bool valueSpecified () const
virtual bool isVariableReference () const
 Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void setIsVariableReference (bool value)
virtual void clearAllVariableReferenceFlags ()
 Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString variableName () const
 The variable name, if this object is a variable reference.
virtual void setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriterdefaultRWValue () const
 The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriterdefaultRWValue ()
virtual void setDefaultRWValue (DtReaderWriter *)
 Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 Give the stream, if the stream contains a default value then set it here.
const DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistryregistry ()
virtual DtPropertyInterfaceproperty ()
virtual const DtPropertyInterfaceproperty () const
virtual DtString toXml () const
virtual bool toXml (const DtFilename &) const
 Writes contents of xml result to the given filename.
virtual bool fromXml (const DtString &)
 Restores object from given xml string. Returns true if valid.
virtual bool fromXmlFile (const DtFilename &)
 Restores object from given xml file.
virtual void putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void putData (DtEnvironmentSP, DtEnvValueSP value) const
 Override to add attributes of actual data.
virtual void putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
 Called when the item is a variable reference.
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())
 Gets data from the environment value.
virtual void unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
 Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
 Called when the item is a variable reference.

Static Public Member Functions

static
DtVrfProcessStateRepository
creator (const DtString &rwName, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry)
 Returns a newly created instance of this class.
- Static Public Member Functions inherited from DtVrfProcessStateRepository
static
DtVrfProcessStateRepositoryFactory
factory ()
 a DtVrfProcessStateRepositoryFactory is allocated by the DtSimCreator, and this pointer is set.
static void setFactory (DtVrfProcessStateRepositoryFactory *factory)
static void addVrfProcessStateRepositoryCreatorFcn (const DtString &type, DtVrfProcessStateRepositoryCreatorFcn fcn)
static
DtVrfProcessStateRepository
createRepository (const DtString &name, const DtString &type, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry=0)
 Creates a new state repository object, using the factory.
- 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 chartheXmlType ()
 The type that is used when archiving to an XML stream.
static const DtFilename & appPath ()
 Gets the current working directory.
static void setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
 Sets the function to create the DtReaderWriterFactory.
static void createReaderWriterFactory ()
static void cleanupFactory ()
static DtReaderWritercreateFromXmlFile (const DtFilename &, bool createAsProperty=false)
 Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWritercreateFromXml (const DtString &, bool createAsProperty=false)
 Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWritercreateFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
 Given a xml environment, returns a newly created reader/writer object from the object found within.
static DtString getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
 Gets the named attribute from a DtEnvValueSP.
- Static Public Member Functions inherited from DtObjectDebugger< DtReaderWriter >
static DtObjectCounter::CounterType ObjectCount ()
static const DtObjectContainer * ObjectContainer ()

Protected Attributes

DtRwBoolean myIsObjectCreated
DtRwInt myState
DtRwVrfObjectReference 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
DtRwVectorListmyCurrentObjectVertices
DtLocalVertexList myCurrentLocalObjectVertices
DtResourceMap myResourceMap
- Protected Attributes inherited from DtVrfProcessStateRepository
DtVrfObjectmyVrfObject
bool myLoadedFromMTL
- Protected Attributes inherited from DtReaderWriter
const DtSymbolString myName
DtReaderWriterRegistry myRegistry
DtReaderWriterRegistrymyParentRegistry
bool myValueSpecified
bool myReadOnlyFlag
bool myIsVariableReference
DtSymbolString myVariableName
bool myVariableIsBound
DtReaderWritermyDefaultValue
aliasContainer myAliases
 Container for the aliases which represent alternative names for the object.
bool myInvalid
 Set to true if there is a problem reading this item.
bool myChangedFlag
 Set to true when value changes Set to false when value checked with changedSinceLastChecked.

Additional Inherited Members

- Protected Member Functions inherited from DtVrfProcessStateRepository
 DtVrfProcessStateRepository ()
- Static Protected Attributes inherited from DtVrfProcessStateRepository
static
DtVrfProcessStateRepositoryFactory
theFactory

Detailed Description

This is a process state repository for the DtAffectEngineeringObjectController.

Member Typedef Documentation

Member Enumeration Documentation

Enumerator:
DtIdle 
DtMovingIntoRange 
DtSettingUp 
DtAffecting 
DtAffectingPaused 

Constructor & Destructor Documentation

DtAffectEngineeringObjectPSR::DtAffectEngineeringObjectPSR ( DtVrfObject 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
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
virtual void DtAffectEngineeringObjectPSR::setEngineeringObject ( const DtUUID )
virtual

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

virtual const DtRwVrfObjectReference& DtAffectEngineeringObjectPSR::engineeringObject ( ) const
virtual
virtual DtRwVrfObjectReference& DtAffectEngineeringObjectPSR::engineeringObject ( )
virtual
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
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
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 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
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
virtual void DtAffectEngineeringObjectPSR::setRange ( double  r)
virtual

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

virtual double DtAffectEngineeringObjectPSR::range ( ) const
virtual
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
virtual void DtAffectEngineeringObjectPSR::setInstantaneous ( bool  isInstantaneous)
virtual

Set/get whether this task completes instantaneously.

virtual bool DtAffectEngineeringObjectPSR::instantaneous ( ) const
virtual
virtual void DtAffectEngineeringObjectPSR::setCreatorsHealth ( int  health)
virtual

Set/get the health of the creating unit.

virtual int DtAffectEngineeringObjectPSR::creatorsHealth ( ) const
virtual
virtual void DtAffectEngineeringObjectPSR::setSetupTime ( double  t)
virtual

Set/get the setup time required for the task.

virtual double DtAffectEngineeringObjectPSR::setupTime ( ) const
virtual
virtual void DtAffectEngineeringObjectPSR::setLastUpdateTime ( double  t)
virtual

Set/get the last update time.

virtual double DtAffectEngineeringObjectPSR::lastUpdateTime ( ) const
virtual
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
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
static DtVrfProcessStateRepository* DtAffectEngineeringObjectPSR::creator ( const DtString rwName,
DtVrfObject vrfObject,
DtReaderWriterRegistry parentRegistry 
)
static

Returns a newly created instance of this class.

Member Data Documentation

DtRwBoolean DtAffectEngineeringObjectPSR::myIsObjectCreated
protected
DtRwInt DtAffectEngineeringObjectPSR::myState
protected
DtRwVrfObjectReference 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

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

Document ID: Generated on Wed Jul 25 16:57:45 EDT 2018 from SVN revision 190790
Copyright © 2005-2018 VT MÄK. All Rights Reserved (www.mak.com)