DtRwActivities Class Reference

A DtRwActivities list will contain a list of activities (key/value pair) by entity type that will support those activities. More...

Inheritance diagram for DtRwActivities:

Public Types
typedef std::map< DtString, DtString >	ActivitiesMap
typedef std::map< DtString, ActivitiesMap >	EntityTypeActivitiesMap
Public Types inherited from DtRwTemplatedListPtr< DtRwStringAttribute, true >
typedef DtIteratorBase < DtRwStringAttribute >	iterator
typedef DtIteratorBase< const DtRwStringAttribute >	const_iterator

Public Member Functions
	DtRwActivities (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	DtRwActivities (const DtString &name, const DtRwActivities &orig, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtRwActivities ()
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual const char *	xmlType () const
DtRwActivities &	operator= (const DtRwActivities &)
virtual DtEntityType	bestMatch (const DtEntityType &) const
	Given the supplied entity type, return the best match of the entity types that are contained.
virtual ActivitiesMap	activitiesFor (const DtEntityType &) const
	Gets all the activities for the given type (closest match)
virtual ActivitiesMap	activitiesFor (const DtString &) const
virtual const EntityTypeActivitiesMap &	activitiesMap () const
	Returns all activities.
virtual void	setActivitiesMap (const EntityTypeActivitiesMap &acts)
virtual void	addActivities (const DtEntityType &, const ActivitiesMap &)
	Adds new activities for the given type. If the exact type exists replaces, else adds the new type.
virtual void	addActivities (const DtString &, const ActivitiesMap &)
virtual void	addActivity (const DtString &, const DtString &key, const DtString &value)
	Adds the given activity for the given type. If the exact type and activity exists, replaces else adds.
virtual void	removeActivitiesFor (const DtEntityType &)
	Removes the given entity type and/or string mapping.
virtual void	removeActivitiesFor (const DtString &)
virtual DtString	valueForKeyword (const DtEntityType &, const DtString &key) const
	Given the entity type and key, returns the value for that type.
virtual DtString	valueForKeyword (const DtString &, const DtString &key) const
virtual bool	hasMatchingType (const DtEntityType &) const
virtual bool	hasMatchingType (const DtString &) const
virtual void	clear ()
	Clears all information.
Public Member Functions inherited from DtRwTemplatedListPtr< DtRwStringAttribute, true >
	DtRwTemplatedListPtr ()
	default constructor
	DtRwTemplatedListPtr (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor
	DtRwTemplatedListPtr (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwTemplatedListPtr (const DtString &name, const DtRwTemplatedListPtr &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	Invokes DtReaderWriter copy constructor.
	DtRwTemplatedListPtr (const DtSymbolString &name, const DtRwTemplatedListPtr &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwTemplatedListPtr (const DtRwTemplatedListPtr &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	... and make sure the default constructor is overridden:
DtRwTemplatedListPtr &	operator= (const DtRwTemplatedListPtr &orig)
virtual	~DtRwTemplatedListPtr ()
DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	This method must be overridden by a subclass.
virtual DtListItem *	add (DtRwStringAttribute *data)
	Define this function to hide the DtRwList version, and accept only the specific DtReaderWriter subclass that this list is handling.
void	removeAll ()
	Removes all entries from the list.
void *	remove (DtListItem *item)
void *	remove (DtRwStringAttribute *item)
virtual std::set< DtString >	supportedXmlTypes () const
	Returns list of supported types. Default is the templated object xml type.
void	removeAndDeleteAll ()
	Removes and deletes all entries in the list.
bool	operator== (const DtRwTemplatedListPtr &) const
	Equivalence operators.
bool	operator!= (const DtRwTemplatedListPtr &) const
virtual void	populateList (boost::function< void(DtReaderWriter *)> addFunction, DtEnvironmentSP env, DtEnvValueSP node, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &bindings)
DtListItem *	find (boost::function< bool(const DtRwStringAttribute &)> predFcn) const
	Finds the first item in the list for which predFcn returns true.
void	copyList (const DtRwTemplatedListPtr &orig)
Public Member Functions inherited from DtRwList
	DtRwList ()
	default constructor
	DtRwList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor
	DtRwList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtRwList ()
const DtRwList &	operator= (const DtRwList &orig)
	Calls down to DtReaderWriter::operator=(). List elements are not copied.
virtual DtListItem *	add (DtReaderWriter *data)
	Add element to the end of the list.
virtual DtListItem *	addWithAlternateName (DtReaderWriter *data, const DtString &name)
	Add element to the end of the list, but use the provided name in place of the object name on the data object.
virtual DtListItem *	addToStart (DtReaderWriter *data)
	Add element to the beginning of the list.
virtual DtListItem *	addToEnd (DtReaderWriter *data)
	Add element to the end of the list.
virtual void *	remove (DtReaderWriter *data, DtListItem *item)
	Remove an element from the list.
virtual DtlObjPtr	getLocalData (DtlObjPtr args)
	Since getData is usually used for local data, and we're overloading it here to get the list data, use this if you want any data before your lists.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual DtListItem *	addBefore (DtReaderWriter *data, DtReaderWriter *before)
	Add element to the list just before the indicated item.
virtual DtListItem *	addAfter (DtReaderWriter *data, DtReaderWriter *after)
	Add element to the list just after the indicated item.
virtual void	reset ()
	Calls removeAndDeleteAll.
bool	operator== (const DtRwList &rhs) const
	Iterates over all items and calls the factory to compare.
bool	operator!= (const DtRwList &rhs) const
virtual void	populateListByType (boost::function< void(DtReaderWriter *)> addFunction, DtEnvironmentSP env, DtEnvValueSP node, const DtString &bindingType, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &bindings)
	DtRwList (const DtString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	Invokes DtReaderWriter copy constructor.
	DtRwList (const DtSymbolString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
virtual DtListItem *	addBefore (DtReaderWriter *data, const DtString &before)
	Add element to the list just before the indicated item.
virtual DtListItem *	addBefore (DtReaderWriter *data, const DtSymbolString &before)
virtual DtListItem *	addAfter (DtReaderWriter *data, const DtString &after)
	Add element to the list just after the indicated item.
virtual DtListItem *	addAfter (DtReaderWriter *data, const DtSymbolString &after)
virtual void	putData (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP value, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
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 (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
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	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 aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
bool	isReadonly () const
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 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 (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 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 ()
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 ()
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	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 const char *	theXmlType ()
	The type that is used when archiving to an XML stream.
Static Public Member Functions inherited from DtRwTemplatedListPtr< DtRwStringAttribute, true >
static const char *	ListReaderWriterType ()
Static Public Member Functions inherited from DtRwList

Protected Member Functions
virtual void	prePutSelf ()
	Override to add in items from map as reader/writer items.
virtual void	postPutSelf ()
	Override to remove items.
virtual void	postGetSelf ()
	Override to get items from list and place into internal map.

Protected Attributes
EntityTypeActivitiesMap	myActivities
Protected Attributes inherited from DtRwTemplatedListPtr< DtRwStringAttribute, true >
DtString	myXmlType

Private Member Functions
	DtRwActivities ()
	Not implemented.

Additional Inherited Members
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
static bool	thePutIndent

Detailed Description

A DtRwActivities list will contain a list of activities (key/value pair) by entity type that will support those activities.

The actual activities are kept in a std::map until read/written to file at which point they will be placed into this list as RW items

Member Typedef Documentation

typedef std::map<DtString, DtString> DtRwActivities::ActivitiesMap

typedef std::map<DtString, ActivitiesMap> DtRwActivities::EntityTypeActivitiesMap

Constructor & Destructor Documentation

DtRwActivities::DtRwActivities ( )

private

Not implemented.

DtRwActivities::DtRwActivities	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

DtRwActivities::DtRwActivities	(	const DtString &	name,
		const DtRwActivities &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

virtual DtRwActivities::~DtRwActivities ( )

virtual

Member Function Documentation

virtual const char* DtRwActivities::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 DtRwTemplatedListPtr< DtRwStringAttribute, true >.

static const char* DtRwActivities::theXmlType ( )

static

The type that is used when archiving to an XML stream.

Reimplemented from DtRwTemplatedListPtr< DtRwStringAttribute, true >.

virtual const char* DtRwActivities::xmlType ( ) const

inlinevirtual

Reimplemented from DtRwTemplatedListPtr< DtRwStringAttribute, true >.

References DtRwTemplatedListPtr< T, T_autoDelete >::theXmlType().

DtRwActivities& DtRwActivities::operator=

(

const DtRwActivities &

)

virtual DtEntityType DtRwActivities::bestMatch ( const DtEntityType &  ) const

virtual

Given the supplied entity type, return the best match of the entity types that are contained.

virtual ActivitiesMap DtRwActivities::activitiesFor ( const DtEntityType &  ) const

virtual

Gets all the activities for the given type (closest match)

virtual ActivitiesMap DtRwActivities::activitiesFor ( const DtString &  ) const

virtual

virtual const EntityTypeActivitiesMap& DtRwActivities::activitiesMap ( ) const

virtual

Returns all activities.

virtual void DtRwActivities::setActivitiesMap ( const EntityTypeActivitiesMap &  acts )

virtual

virtual void DtRwActivities::addActivities ( const DtEntityType &  , const ActivitiesMap &    )

virtual

Adds new activities for the given type. If the exact type exists replaces, else adds the new type.

virtual void DtRwActivities::addActivities ( const DtString &  , const ActivitiesMap &    )

virtual

virtual void DtRwActivities::addActivity ( const DtString &  , const DtString &  key, const DtString &  value  )

virtual

Adds the given activity for the given type. If the exact type and activity exists, replaces else adds.

virtual void DtRwActivities::removeActivitiesFor ( const DtEntityType &  )

virtual

Removes the given entity type and/or string mapping.

virtual void DtRwActivities::removeActivitiesFor ( const DtString &  )

virtual

virtual DtString DtRwActivities::valueForKeyword ( const DtEntityType &  , const DtString &  key  ) const

virtual

Given the entity type and key, returns the value for that type.

virtual DtString DtRwActivities::valueForKeyword ( const DtString &  , const DtString &  key  ) const

virtual

virtual bool DtRwActivities::hasMatchingType ( const DtEntityType &  ) const

virtual

virtual bool DtRwActivities::hasMatchingType ( const DtString &  ) const

virtual

virtual void DtRwActivities::clear ( )

virtual

Clears all information.

virtual void DtRwActivities::prePutSelf ( )

protectedvirtual

Override to add in items from map as reader/writer items.

Reimplemented from DtReaderWriter.

virtual void DtRwActivities::postPutSelf ( )

protectedvirtual

Override to remove items.

Reimplemented from DtReaderWriter.

virtual void DtRwActivities::postGetSelf ( )

protectedvirtual

Override to get items from list and place into internal map.

Reimplemented from DtReaderWriter.

Member Data Documentation

EntityTypeActivitiesMap DtRwActivities::myActivities

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfutil/rwActivities.h