DtScriptReactiveTaskControllerPSR Class Reference

Inheritance diagram for DtScriptReactiveTaskControllerPSR:

Public Member Functions
	DtScriptReactiveTaskControllerPSR (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtScriptReactiveTaskControllerPSR (const DtScriptReactiveTaskControllerPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
virtual	~DtScriptReactiveTaskControllerPSR ()
	destructor
DtScriptReactiveTaskControllerPSR &	operator= (const DtScriptReactiveTaskControllerPSR &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	putSelf (FILE *fp, int indentLevel, bool writeUnspecified, const DtFilename &path)
	Top level call to write itself to file.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual void	addTaskPriority (const DtString &scriptId, int priority)
virtual void	removeTaskPriority (const DtString &scriptId)
	remove task priority depends on it being in the reactive task entry map, so you should call the removal of the priority first if you are ever to remove both at once.
virtual const std::map< int, std::list< DtString > > &	priorityMap () const
virtual void	updateAllPriorities ()
virtual void	addReactiveTaskEntry (const DtString &scriptId, DtRwScriptReactiveTaskEntry *entry, bool deleteOnUpdate=true)
	Adds the new reactive task entry to the map.
virtual void	removeReactiveTaskEntry (const DtString &scriptId, bool deleteEntry=true)
virtual DtRwScriptReactiveTaskEntry *	findReactiveTaskEntry (const DtString &scriptId) const
virtual const std::map < DtString, DtRwScriptReactiveTaskEntry * > &	reactiveTaskEntryMap () const
virtual void	addActionCategories (const std::set< DtString > &actionCategories)
virtual int	currentReactionLevel (const std::set< DtString > &actionCategories) const
virtual void	updateReactionLevels (const std::set< DtString > &actionCategories)
virtual void	updateAllReactionLevels ()
virtual void	sweepMarkedForDeletion ()
virtual DtRwUserQuestionHandler &	userQuestionHandler ()
	User question handler access.
virtual const DtRwUserQuestionHandler &	userQuestionHandler () 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 DtVrfProcessStateRepository &	operator= (const DtVrfProcessStateRepository &orig)
virtual	~DtVrfProcessStateRepository ()
virtual bool	init ()
	Used for virtual construction. This base method simply returns true.
virtual bool	loadedFromMTL () const
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 DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
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 (FILE *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 aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to iriginal 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 char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual const char *	xmlType () 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 void	putData (FILE *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)
	Deriving class overrides these to get/put class specific data.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
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)
	The variable name, if this object is a variable reference.
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
	The default value to use if the reader/writer object is a variable and that variable is not specified.
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 DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () 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 &)
	Restires 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 (FILE *fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const char *	theXmlType ()
	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 DtReaderWriter *	createFromXmlFile (const DtFilename &)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP)
	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 Types
typedef void(*	DtScriptPSRScenarioSaveLoadFcn )(void *)

Protected Member Functions
bool	doCategoriesOverlap (const std::set< DtString > &firstSet, const std::set< DtString > &secondSet, std::set< DtString > &overlap) const
Protected Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
Protected Member Functions inherited from DtObjectDebugger< DtReaderWriter >
	DtObjectDebugger ()
	DtObjectDebugger (const DtObjectDebugger &)
	~DtObjectDebugger ()

Protected Attributes
DtRwTemplatedListPtr < DtRwScriptReactiveTaskEntry, false >	myReactiveTasks
std::map< DtString, DtRwScriptReactiveTaskEntry * >	myReactiveTaskEntryMap
	Fast access only, though state will be saved through members above these.
std::map< int, std::list < DtString > >	myPriorityMap
std::map< DtString, int >	myCategoryReactionLevelMap
DtRwUserQuestionHandler	myUserQuestionHandler
Protected Attributes inherited from DtVrfProcessStateRepository
DtVrfObject *	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
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

Additional Inherited Members
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 )()
Static Protected Attributes inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	theFactory

Member Typedef Documentation

typedef void(* DtScriptReactiveTaskControllerPSR::DtScriptPSRScenarioSaveLoadFcn)(void *)

protected

Constructor & Destructor Documentation

DtScriptReactiveTaskControllerPSR::DtScriptReactiveTaskControllerPSR	(	DtVrfObject *	vrfObject,
		const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor

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

copy constructor

virtual DtScriptReactiveTaskControllerPSR::~DtScriptReactiveTaskControllerPSR ( )

virtual

destructor

Member Function Documentation

DtScriptReactiveTaskControllerPSR& DtScriptReactiveTaskControllerPSR::operator=

(

const DtScriptReactiveTaskControllerPSR &

orig

)

assignment operator

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

virtual

returns a newly created copy of this object

Implements DtVrfProcessStateRepository.

virtual DtString DtScriptReactiveTaskControllerPSR::type ( ) const

virtual

Returns the string type of this process state repository, defined in procSRTypes.h.

Returns "script-reaction-controller-process-state-repository".

Implements DtVrfProcessStateRepository.

static DtVrfProcessStateRepository* DtScriptReactiveTaskControllerPSR::creator ( const DtString &  rwName, DtVrfObject *  vrfObject, DtReaderWriterRegistry *  parentRegistry  )

static

Returns a newly created instance of this class.

virtual void DtScriptReactiveTaskControllerPSR::putSelf ( FILE *  fp, int  indentLevel, bool  writeUnspecified, const DtFilename &  path  )

virtual

Top level call to write itself to file.

If write unspecified is true, will write entries that are unspecified, in the format (name <use-default>). Path is passed down to all DtReaderWriter members in its DtReaderWriterRegistry (collection of child DtReaderWriter nodes). If a given member in the registry is of type DtReaderWriterFile, and the path is specified with a non-NULL string, then the path prepended to the filename before writing the entry to file.

Reimplemented from DtReaderWriter.

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

virtual

Reimplemented from DtVrfProcessStateRepository.

virtual void DtScriptReactiveTaskControllerPSR::addTaskPriority ( const DtString &  scriptId, int  priority  )

virtual

virtual void DtScriptReactiveTaskControllerPSR::removeTaskPriority ( const DtString &  scriptId )

virtual

remove task priority depends on it being in the reactive task entry map, so you should call the removal of the priority first if you are ever to remove both at once.

virtual const std::map<int, std::list<DtString> >& DtScriptReactiveTaskControllerPSR::priorityMap ( ) const

virtual

virtual void DtScriptReactiveTaskControllerPSR::updateAllPriorities ( )

virtual

virtual void DtScriptReactiveTaskControllerPSR::addReactiveTaskEntry ( const DtString &  scriptId, DtRwScriptReactiveTaskEntry *  entry, bool  deleteOnUpdate = true  )

virtual

Adds the new reactive task entry to the map.

If the item already exists, the existing entry is then updated to match the given entry. If deleteOnUpdate is set, then the passed in entry is deleted to avoid memory leak. The entry parameter is then set with the entry in the map.

virtual void DtScriptReactiveTaskControllerPSR::removeReactiveTaskEntry ( const DtString &  scriptId, bool  deleteEntry = true  )

virtual

virtual DtRwScriptReactiveTaskEntry* DtScriptReactiveTaskControllerPSR::findReactiveTaskEntry ( const DtString &  scriptId ) const

virtual

virtual const std::map<DtString, DtRwScriptReactiveTaskEntry*>& DtScriptReactiveTaskControllerPSR::reactiveTaskEntryMap ( ) const

virtual

virtual void DtScriptReactiveTaskControllerPSR::addActionCategories ( const std::set< DtString > &  actionCategories )

virtual

virtual int DtScriptReactiveTaskControllerPSR::currentReactionLevel ( const std::set< DtString > &  actionCategories ) const

virtual

virtual void DtScriptReactiveTaskControllerPSR::updateReactionLevels ( const std::set< DtString > &  actionCategories )

virtual

virtual void DtScriptReactiveTaskControllerPSR::updateAllReactionLevels ( )

virtual

virtual void DtScriptReactiveTaskControllerPSR::sweepMarkedForDeletion ( )

virtual

virtual DtRwUserQuestionHandler& DtScriptReactiveTaskControllerPSR::userQuestionHandler ( )

virtual

User question handler access.

virtual const DtRwUserQuestionHandler& DtScriptReactiveTaskControllerPSR::userQuestionHandler ( ) const

virtual

bool DtScriptReactiveTaskControllerPSR::doCategoriesOverlap ( const std::set< DtString > &  firstSet, const std::set< DtString > &  secondSet, std::set< DtString > &  overlap  ) const

protected

Member Data Documentation

DtRwTemplatedListPtr<DtRwScriptReactiveTaskEntry, false> DtScriptReactiveTaskControllerPSR::myReactiveTasks

protected

std::map<DtString, DtRwScriptReactiveTaskEntry*> DtScriptReactiveTaskControllerPSR::myReactiveTaskEntryMap

protected

Fast access only, though state will be saved through members above these.

std::map<int, std::list<DtString> > DtScriptReactiveTaskControllerPSR::myPriorityMap

protected

std::map<DtString, int> DtScriptReactiveTaskControllerPSR::myCategoryReactionLevelMap

protected

DtRwUserQuestionHandler DtScriptReactiveTaskControllerPSR::myUserQuestionHandler

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjcore/scriptReactiveTaskControllerPSR.h