DtSimResource is an abstract base class that can be used to create a hierarchical resource list of a type specified by the deriving class. More...

Inheritance diagram for DtSimResource:

[legend]

Public Member Functions
virtual	~DtSimResource ()
	destructor
virtual bool	init ()
	Base class version just returns true, but this will be called by the createResource call so that deriving classes can do virtual allocation if need be.
virtual void	putData (FILE *fp, int indentLevel=0)
	putData writes our type, which is provided by the virtual type accessor of the deriving class.
virtual void	addChildResource (DtSimResource *resource)
virtual bool	removeChildResource (DtSimResource *resource)
	Removes the specified resource from this resource's subresource list, or from the subresources of any of those resources.
virtual void	copyResource (const DtSimResource &orig)
virtual void	updateAmountFromChildren ()=0
	When the deriving class's setAmount is called, this should be called on the resources parent.
virtual void	updateFullAmountFromChildren ()=0
	When the deriving class's setFullAmount is called, this should be called on the resources parent.
virtual void	distributeAmountToChildren ()=0
	When the deriving class's setAmount is called, this should be called if the resource has any children.
virtual void	distributeFullAmountToChildren ()=0
	When the deriving class's setFullAmount is called, this should be called if the resource has any children.
virtual DtReal	percentageFull () const =0
	The deriving class will also provide a function to specify the quantity (of the appropriate type) that indicates a full/complete load of the resource.
virtual void	setPercentageFull (DtReal percent)=0
	Percent will be truncated to be between 0. and 1.
virtual DtString	type () const =0
	The data type of the resource. These types are defined in rsrcTypes.h.
virtual DtSimResource *	clone (DtReaderWriterRegistry *parentRegistry=0) const =0
virtual void	setResourceManager (DtSimResourceManager *resourceManager)
virtual DtSimResourceManager *	resourceManager ()
virtual const DtSimResourceManager *	resourceManager () const
virtual DtSimResourceList *	subresources ()
	Accessor to this resource's subresources.
virtual void	setParent (DtSimResource *parent)
	The parent pointer is actually kept in the subresources list, since it needs it as well.
virtual DtSimResource *	parent ()
virtual const DtSimResource *	parent () const
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual bool	isEqual (const DtSimResource &res) const
bool	operator!= (const DtSimResource &orig) const
	Expects subclasses to implement isEqual method. Default returns false.
bool	operator== (const DtSimResource &orig) 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	putSelf (FILE *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 (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 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 *	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 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 DtSimResource *	createResource (DtlObjPtr mtlStream, const DtVariableBindingsList &variableBindings)
static void	addResourceCreatorFcn (const DtString &type, DtSimResourceCreatorFcn fcn)
static void	addResourceCreatorFcn (const DtSymbolString &type, DtSimResourceCreatorFcn fcn)
static void	setFactory (DtSimResourceFactory *factory)
static DtSimResourceFactory *	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 Member Functions
	DtSimResource ()
	default constructor
	DtSimResource (const DtString &resourceName, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor
	DtSimResource (const DtSymbolString &resourceName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtSimResource (const DtSimResource &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor The copy constructor only calls down to the base class copy constructor.
DtSimResource &	operator= (const DtSimResource &orig)
	assignment operator
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
DtSimResourceManager *	myResourceManager
DtSimResourceList	mySubresources
DtSimResource *	myParent
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.

Static Protected Attributes
static DtSimResourceFactory *	myFactory
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

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 )()

Detailed Description

DtSimResource is an abstract base class that can be used to create a hierarchical resource list of a type specified by the deriving class.

The deriving class must provide an implementation of getData that knows how to create the right kind of resource when reading from a file. It also must provide implementations of updateAmountFromChildren(), which determines the amount of this resource by summing up from any child resources, and distributeAmountToChildren().

Constructor & Destructor Documentation

DtSimResource::DtSimResource ( )

protected

default constructor

DtSimResource::DtSimResource	(	const DtString &	resourceName,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

protected

real constructor

The resource name is the name that will be used to look up the resource in the resource manager.

DtSimResource::DtSimResource	(	const DtSymbolString &	resourceName,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

protected

DtSimResource::DtSimResource	(	const DtSimResource &	orig,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

protected

copy constructor The copy constructor only calls down to the base class copy constructor.

It does not copy the mySubresources member. Derived classes must do this in their copy constructor implementations as follows:

mySubresources.setParent(this); mySubresources.copyList(orig.mySubresources, parentRegistry);

virtual DtSimResource::~DtSimResource ( )

virtual

destructor

Member Function Documentation

DtSimResource& DtSimResource::operator= ( const DtSimResource & orig )

protected

assignment operator

virtual bool DtSimResource::init ( )

virtual

Base class version just returns true, but this will be called by the createResource call so that deriving classes can do virtual allocation if need be.

virtual void DtSimResource::putData	(	FILE *	fp,
		int	indentLevel = `0`
	)

virtual

putData writes our type, which is provided by the virtual type accessor of the deriving class.

Reimplemented from DtReaderWriter.

virtual void DtSimResource::addChildResource ( DtSimResource * resource )

virtual

virtual bool DtSimResource::removeChildResource ( DtSimResource * resource )

virtual

Removes the specified resource from this resource's subresource list, or from the subresources of any of those resources.

Does not delete the resource.

Returns: True if the resource was found and removed.

virtual void DtSimResource::copyResource ( const DtSimResource & orig )

virtual

virtual void DtSimResource::updateAmountFromChildren ( )

pure virtual

When the deriving class's setAmount is called, this should be called on the resources parent.

Implemented in DtRealResource, and DtIntegerResource.

virtual void DtSimResource::updateFullAmountFromChildren ( )

pure virtual

When the deriving class's setFullAmount is called, this should be called on the resources parent.

Implemented in DtRealResource, and DtIntegerResource.

virtual void DtSimResource::distributeAmountToChildren ( )

pure virtual

When the deriving class's setAmount is called, this should be called if the resource has any children.

Implemented in DtRealResource, and DtIntegerResource.

virtual void DtSimResource::distributeFullAmountToChildren ( )

pure virtual

When the deriving class's setFullAmount is called, this should be called if the resource has any children.

Implemented in DtRealResource, and DtIntegerResource.

virtual DtReal DtSimResource::percentageFull ( ) const

pure virtual

The deriving class will also provide a function to specify the quantity (of the appropriate type) that indicates a full/complete load of the resource.

PercentageFull will return 0. to 1., amount / fullAmount Note: 1. is returned if full amount is <= 0.

Implemented in DtRealResource, and DtIntegerResource.

virtual void DtSimResource::setPercentageFull ( DtReal percent )

pure virtual

Percent will be truncated to be between 0. and 1.

Implemented in DtRealResource, and DtIntegerResource.

virtual DtString DtSimResource::type ( ) const

pure virtual

The data type of the resource. These types are defined in rsrcTypes.h.

Implemented in DtRealResource, DtIntegerResource, and DtMunitionResource.

Referenced by DtMunitionResourceIterator::firstMatch().

virtual DtSimResource* DtSimResource::clone ( DtReaderWriterRegistry * parentRegistry = 0 ) const

pure virtual

Implemented in DtRealResource, DtIntegerResource, and DtMunitionResource.

virtual void DtSimResource::setResourceManager ( DtSimResourceManager * resourceManager )

virtual

virtual DtSimResourceManager* DtSimResource::resourceManager ( )

virtual

virtual const DtSimResourceManager* DtSimResource::resourceManager ( ) const

virtual

virtual DtSimResourceList* DtSimResource::subresources ( )

virtual

Accessor to this resource's subresources.

Referenced by DtRecursiveResourceIterator::next().

virtual void DtSimResource::setParent ( DtSimResource * parent )

virtual

The parent pointer is actually kept in the subresources list, since it needs it as well.

virtual DtSimResource* DtSimResource::parent ( )

virtual

virtual const DtSimResource* DtSimResource::parent ( ) const

virtual

static DtSimResource* DtSimResource::createResource	(	DtlObjPtr	mtlStream,
		const DtVariableBindingsList &	variableBindings
	)

static

static void DtSimResource::addResourceCreatorFcn	(	const DtString &	type,
		DtSimResourceCreatorFcn	fcn
	)

static

static void DtSimResource::addResourceCreatorFcn	(	const DtSymbolString &	type,
		DtSimResourceCreatorFcn	fcn
	)

static

static void DtSimResource::setFactory ( DtSimResourceFactory * factory )

static

static DtSimResourceFactory* DtSimResource::factory ( )

static

Returns: A pointer to the static DtReaderWriterFactory. This factory can create instances of DtReaderWriter subclasses that have been registered with it.

Reimplemented from DtReaderWriter.

virtual const char* DtSimResource::readerWriterType ( ) const

virtual

Used to supply a string type that this reader writer type is.

This can be used in place of dynamic-casting. Also used by the opd editor to determine which type of control to create

Reimplemented from DtReaderWriter.

Reimplemented in DtMunitionResource.

virtual bool DtSimResource::isEqual ( const DtSimResource & res ) const

virtual

Reimplemented in DtRealResource, and DtIntegerResource.

bool DtSimResource::operator!= ( const DtSimResource & orig ) const

inline

Expects subclasses to implement isEqual method. Default returns false.

bool DtSimResource::operator== ( const DtSimResource & orig ) const

Member Data Documentation

DtSimResourceManager* DtSimResource::myResourceManager

protected

DtSimResourceList DtSimResource::mySubresources

protected

DtSimResource* DtSimResource::myParent

protected

DtSimResourceFactory* DtSimResource::myFactory

staticprotected

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-3-branch/include/vrfutil/simResource.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation