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 DtFilename &searchPath, 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)
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 ()
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)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
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	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
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 bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
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 DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
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 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.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

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 DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()

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.
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	putData (FILE *fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.

Protected Attributes
DtRwTemplatedListPtr < DtRwScriptReactiveTaskEntry >	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
Protected Attributes inherited from DtVrfProcessStateRepository
DtVrfObject *	myVrfObject
bool	myLoadedFromMTL
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
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::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 DtFilename &	searchPath,
		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
	)

virtual

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

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

protected

Member Data Documentation

DtRwTemplatedListPtr<DtRwScriptReactiveTaskEntry> 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

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

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

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation