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.

Inheritance diagram for DtRwActivities:

[legend]

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

Public Member Functions
	DtRwActivities (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)

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

virtual	~DtRwActivities () override

virtual const char *	readerWriterType () const override

virtual const char *	xmlType () const override

DtRwActivities &	operator= (const DtRwActivities &)

virtual DtEntityType	bestMatch (const DtEntityType &) const

virtual ActivitiesMap	activitiesFor (const DtEntityType &) const

virtual ActivitiesMap	activitiesFor (const DtString &) const

virtual const EntityTypeActivitiesMap &	activitiesMap () const

virtual void	setActivitiesMap (const EntityTypeActivitiesMap &acts)

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

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

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

virtual void	removeActivitiesFor (const DtEntityType &)

virtual void	removeActivitiesFor (const DtString &)

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

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

virtual bool	hasMatchingType (const DtEntityType &) const

virtual bool	hasMatchingType (const DtString &) const

virtual void	clear ()

Public Member Functions inherited from DtRwTemplatedListPtr< DtRwStringAttribute, true >
	DtRwTemplatedListPtr ()

	DtRwTemplatedListPtr (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)

	DtRwTemplatedListPtr (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)

	DtRwTemplatedListPtr (const DtString &name, const DtRwTemplatedListPtr &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtRwTemplatedListPtr (const DtSymbolString &name, const DtRwTemplatedListPtr &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtRwTemplatedListPtr (const DtRwTemplatedListPtr &orig, DtReaderWriterRegistry *parentRegistry=NULL)

virtual DtRwTemplatedListPtr &	operator= (const DtRwTemplatedListPtr &orig)

virtual	~DtRwTemplatedListPtr () override

virtual DtReaderWriter *	createPrototype (const char *name="") const override

virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override

virtual DtListItem *	insertItemAt (DtRwStringAttribute *data, int index)

virtual DtListItem *	add (DtReaderWriter *item) override

virtual DtListItem *	add (DtRwStringAttribute *data)

virtual void	removeAll () override

void *	remove (DtListItem *item)

void *	remove (DtRwStringAttribute *item)

virtual std::set< DtString >	supportedXmlTypes () const override

virtual void	removeAndDeleteAll () override

virtual bool	operator== (const DtRwTemplatedListPtr &) const

bool	operator!= (const DtRwTemplatedListPtr &) const

virtual void	populateList (boost::function< void(DtReaderWriter *)> addFunction, DtEnvironmentSP env, DtEnvValueSP node, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &bindings) override

DtListItem *	find (boost::function< bool(const DtRwStringAttribute &)> predFcn) const

virtual DtString	prettyPrint () const override

void	copyList (const DtRwTemplatedListPtr &orig)

Public Member Functions inherited from DtRwList
	DtRwList ()

	DtRwList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)

	DtRwList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)

virtual	~DtRwList () override

const DtRwList &	operator= (const DtRwList &orig)

virtual DtListItem *	addWithAlternateName (DtReaderWriter *data, const DtString &name)

virtual DtListItem *	addToStart (DtReaderWriter *data)

virtual DtListItem *	addToEnd (DtReaderWriter *data)

virtual void *	remove (DtReaderWriter data, DtListItem item)

virtual DtlObjPtr	getLocalData (DtlObjPtr args)

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

virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList()) override

virtual DtListItem *	addBefore (DtReaderWriter data, DtReaderWriter before)

virtual DtListItem *	addAfter (DtReaderWriter data, DtReaderWriter after)

virtual void	reset () override

bool	operator== (const DtRwList &rhs) const

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)

	DtRwList (const DtSymbolString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)

virtual DtListItem *	addBefore (DtReaderWriter *data, const DtString &before)

virtual DtListItem *	addBefore (DtReaderWriter *data, const DtSymbolString &before)

virtual DtListItem *	addAfter (DtReaderWriter *data, const DtString &after)

virtual DtListItem *	addAfter (DtReaderWriter *data, const DtSymbolString &after)

virtual void	putData (DtEnvironmentSP, DtEnvValueSP parent) const override

virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP value, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList()) override

Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()

	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)

const DtReaderWriter &	operator= (const DtReaderWriter &orig)

bool	operator== (const DtReaderWriter &) const

bool	operator!= (const DtReaderWriter &rhs) const

virtual	~DtReaderWriter ()

virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual void	preGetSelf ()

virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual DtSymbolString	name () const

virtual void	addAlias (const DtSymbolString &alias)

virtual void	addAlias (const DtString &alias)

virtual bool	hasAlias (const DtSymbolString &alias)

virtual const aliasContainer &	aliases () const

virtual void	setReadonly (bool flag)

bool	isReadonly () const

virtual int	alignment () const

virtual bool	variableIsBound () const

virtual void	unbindVariable ()

virtual void	setName (const DtString &)

std::string	debugText () const

virtual void	bindVariables (DtVariableBindingsList variableBindings)

virtual std::list < DtVariableNameType >	unboundVariables () const

bool	invalid () const

virtual bool	hasChild (const DtReaderWriter *p) const

virtual bool	hasVariableReference () const

virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)

virtual void	recordUpdateTime () const

virtual bool	changedSinceLastChecked ()

virtual bool	peekChangedSinceLastChecked () const

virtual void	putData (std::string &fp, int indentLevel=0)

virtual void	setValueSpecified (bool specified, bool recurse=false)

virtual bool	valueSpecified () const

virtual bool	isVariableReference () const

virtual void	setIsVariableReference (bool value)

virtual void	clearAllVariableReferenceFlags ()

virtual DtSymbolString	variableName () const

virtual void	setVariableName (const DtSymbolString variableName)

virtual const DtReaderWriter *	defaultRWValue () const

virtual DtReaderWriter *	defaultRWValue ()

virtual void	setDefaultRWValue (DtReaderWriter *)

virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

const DtReaderWriterRegistry &	registry () const

DtReaderWriterRegistry &	registry ()

virtual DtPropertyInterface *	property ()

virtual const DtPropertyInterface *	property () const

virtual DtString	toXml () const

virtual DtRwVariableBindings *	generateVariableBindings () const

virtual bool	toXml (const DtFilename &) const

virtual bool	fromXml (const DtString &)

virtual bool	fromXmlFile (const DtFilename &)

virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Static Public Member Functions
static const char *	theXmlType ()

Static Public Member Functions inherited from DtRwTemplatedListPtr< DtRwStringAttribute, true >
static const char *	theXmlType ()

static const char *	ListReaderWriterType ()

Static Public Member Functions inherited from DtRwList
static const char *	theXmlType ()

Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)

static const DtVariableBindingsList &	nullVariableReference ()

static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)

static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)

static void	setPutIndent (bool)

static bool	putIndent ()

static const char *	theXmlType ()

static const DtFilename &	appPath ()

static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)

static void	createReaderWriterFactory ()

static void	cleanupFactory ()

static DtReaderWriterFactory *	factory ()

static void	setOutputStream (DtOutputStream *stream)

static DtOutputStream &	outputStream ()

static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)

static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)

static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)

static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Member Functions
virtual void	prePutSelf () override

virtual void	postPutSelf () override

virtual void	postGetSelf () override

Protected Member Functions inherited from DtRwList
virtual DtListItem *	addBefore (DtReaderWriter data, DtListItem before)

virtual DtListItem *	addAfter (DtReaderWriter data, DtListItem after)

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Protected Attributes
EntityTypeActivitiesMap	myActivities

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

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

bool	myInvalid

bool	myChangedFlag

Private Member Functions
	DtRwActivities ()

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

static DtOutputStream *	theOutputStream

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

overridevirtual

Member Function Documentation

virtual const char* DtRwActivities::readerWriterType ( ) const

overridevirtual

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.

virtual const char* DtRwActivities::xmlType ( ) const

inlineoverridevirtual

Routines to archive/dearchive from an XML Environment.

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

overrideprotectedvirtual

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

Reimplemented from DtReaderWriter.

virtual void DtRwActivities::postPutSelf ( )

overrideprotectedvirtual

Override to remove items.

Reimplemented from DtReaderWriter.

virtual void DtRwActivities::postGetSelf ( )

overrideprotectedvirtual

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:

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfutil/rwActivities.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation