DtSpotReportGeneratorControllerPSR Class Reference

Process State Repository for DtSpotReportGeneratorController. More...

Inheritance diagram for DtSpotReportGeneratorControllerPSR:

Public Member Functions
	DtSpotReportGeneratorControllerPSR (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	Constructor.
	DtSpotReportGeneratorControllerPSR (const DtSpotReportGeneratorControllerPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	Copy constructor.
DtSpotReportGeneratorControllerPSR &	operator= (const DtSpotReportGeneratorControllerPSR &orig)
	Assignment Operator.
virtual	~DtSpotReportGeneratorControllerPSR ()
	Destructor.
virtual DtVrfProcessStateRepository *	clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
	Returns complete copy of this class using the copy constructor.
virtual DtString	type () const
	Returns "spot-report-generator-controller-process-state-repository".
virtual bool	localEnabled () const
	If globalEnabledOverridingLocal() returns false, the spot report generator uses this value to determine if spot reports should be enabled.
virtual void	setLocalEnabled (bool localEnabled)
virtual bool	globalEnabledOverridingLocal () const
	Determines if the spot report generator will use the global back-end setting or the value returned by localEnabled().
virtual void	setGlobalEnabledOverridingLocal (bool globalEnabled)
virtual DtSimReportList &	spotReportList ()
virtual const DtSimReportList &	spotReportList () 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
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Top level to read itself from an input stream.
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
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
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 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=0)
	Static creator function for factory registration.
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.

Protected Member Functions
void	copySpotReportListFrom (const DtSimReportList &sourceList)
	Clears the current mySpotReportList, then clones all reports on the source list and adds them to the local list.
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
DtSimReportList	mySpotReportList
DtRwBoolean	myLocalEnabled
DtRwBoolean	myGlobalEnabledOverridingLocal
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
Static Protected Attributes inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	theFactory

Detailed Description

Process State Repository for DtSpotReportGeneratorController.

Maintains a list of currently spotted objects in the form of spot reports.

Constructor & Destructor Documentation

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

Constructor.

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

Copy constructor.

virtual DtSpotReportGeneratorControllerPSR::~DtSpotReportGeneratorControllerPSR ( )

virtual

Destructor.

Member Function Documentation

DtSpotReportGeneratorControllerPSR& DtSpotReportGeneratorControllerPSR::operator=

(

const DtSpotReportGeneratorControllerPSR &

orig

)

Assignment Operator.

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

virtual

Returns complete copy of this class using the copy constructor.

Implements DtVrfProcessStateRepository.

virtual DtString DtSpotReportGeneratorControllerPSR::type ( ) const

virtual

Returns "spot-report-generator-controller-process-state-repository".

Implements DtVrfProcessStateRepository.

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

static

Static creator function for factory registration.

virtual DtSimReportList& DtSpotReportGeneratorControllerPSR::spotReportList ( )

virtual

A spot report for each currently spotted object.

virtual const DtSimReportList& DtSpotReportGeneratorControllerPSR::spotReportList ( ) const

virtual

A spot report for each currently spotted object.

virtual bool DtSpotReportGeneratorControllerPSR::localEnabled ( ) const

virtual

If globalEnabledOverridingLocal() returns false, the spot report generator uses this value to determine if spot reports should be enabled.

@(

virtual void DtSpotReportGeneratorControllerPSR::setLocalEnabled ( bool  localEnabled )

virtual

virtual bool DtSpotReportGeneratorControllerPSR::globalEnabledOverridingLocal ( ) const

virtual

Determines if the spot report generator will use the global back-end setting or the value returned by localEnabled().

@(

virtual void DtSpotReportGeneratorControllerPSR::setGlobalEnabledOverridingLocal ( bool  globalEnabled )

virtual

void DtSpotReportGeneratorControllerPSR::copySpotReportListFrom ( const DtSimReportList &  sourceList )

protected

Clears the current mySpotReportList, then clones all reports on the source list and adds them to the local list.

Non-virtual because it is called from the constructors.

Member Data Documentation

DtSimReportList DtSpotReportGeneratorControllerPSR::mySpotReportList

protected

DtRwBoolean DtSpotReportGeneratorControllerPSR::myLocalEnabled

protected

DtRwBoolean DtSpotReportGeneratorControllerPSR::myGlobalEnabledOverridingLocal

protected

---

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

• include/vrfobjcore/spotReportGeneratorPSR.h