DtRemoteConfigurationMapEntry Class Reference

This file declares DtRemoteConfigurationMapEntry. More...

Inheritance diagram for DtRemoteConfigurationMapEntry:

Public Types
enum	AttachByType { UnspecifiedType = 0, ObjectType, EntityIdType, MarkingTextType }
	Attachment Type enumerations, used as a rule to select entities for attachment. More...
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
	DtRemoteConfigurationMapEntry ()
	Default Constructor.
	DtRemoteConfigurationMapEntry (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	Constructor.
	DtRemoteConfigurationMapEntry (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	Constructor.
	DtRemoteConfigurationMapEntry (const DtRemoteConfigurationMapEntry &orig)
	Copy constructor.
	DtRemoteConfigurationMapEntry (const DtString &name, const DtRemoteConfigurationMapEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	Copy constructor.
	DtRemoteConfigurationMapEntry (const DtSymbolString &name, const DtRemoteConfigurationMapEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	Copy constructor.
virtual	~DtRemoteConfigurationMapEntry ()
	Destructor.
virtual DtRemoteConfigurationMapEntry *	clone () const
	Clone operator.
DtRemoteConfigurationMapEntry &	operator= (const DtRemoteConfigurationMapEntry &orig)
	Assignment operator.
DtRemoteConfigurationMapEntry::AttachByType	attachByType () const
	Describes the rule by which entities will be identified for attachment.
void	setAttachByType (AttachByType atype)
const DtString &	configurationKeyName () const
	Get/set component configuration filename.
void	setConfigurationKeyName (const DtString &keyname)
const DtEntityIdentifier &	entityIdentifier () const
	Used to identify entity by entity type enumeration.
void	setEntityIdentifier (const DtEntityIdentifier &eid)
const std::vector< unsigned > &	forceFilters () const
	Returns an array of force types to which this entry applies.
virtual void	setForceFilters (const std::vector< unsigned > &filters)
const DtString &	markingText () const
	Used to explicitly identify an entity by marking text.
void	setMarkingText (const char *pStr)
void	setMarkingText (const DtString &sStr)
const DtObjectType &	objectType () const
	Used to identify entity by entity type enumeration.
virtual void	setObjectType (const DtObjectType &otype)
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	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 (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 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 *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
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)
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	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 DtRemoteConfigurationMapEntry *	create ()
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 ()
	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 DtReaderWriterFactory *	factory ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	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
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	Override getData to parse out member fields.
virtual void	parseAttachByField (DtlObjPtr dtlObjPtr)
	Parse the "attach-by" data from this form: (attach-by ...) Override to extend the types of attachment that may take place.
virtual void	parseForceFilterField (DtlObjPtr dtlObjPtr)
	Parse the "force-filter" data from this form: (force-filter ...)
virtual void	putData (std::string &fp, int indentLevel=0)
	Override to write out fields.
virtual void	writeAttachBy (std::string &fp, int indentLevel=0)
	Write attach-by information to MTL stream Override to extend the way "attach-by" can be represented.
virtual void	writeForceFilter (std::string &fp, int indentLevel=0)
	Write force filter array to MTL stream, if myForceFilters has size.
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
AttachByType	myAttachByType
	Qualifier to identify entities to which attachment should be applied.
DtRwString	myConfigurationKeyName
	This key name must match one of the remote configuration entry keys in the OPD.
DtEntityIdentifier	myEntityIdentifier
	Used to identify explicity entity for attachment.
std::vector< unsigned >	myForceFilters
	An array of force types to which this entry applies.
DtString	myMarkingText
	Used to explicitly identify an entity by marking text.
DtRwObjectType	myObjectType
	Used to identify entity by entity type enumeration.
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.

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

This file declares DtRemoteConfigurationMapEntry.

DtRemoteConfigurationMapEntry

Member Enumeration Documentation

enum DtRemoteConfigurationMapEntry::AttachByType

Attachment Type enumerations, used as a rule to select entities for attachment.

Enumerator:

UnspecifiedType
ObjectType
EntityIdType
MarkingTextType

Constructor & Destructor Documentation

DtRemoteConfigurationMapEntry::DtRemoteConfigurationMapEntry

(

)

Default Constructor.

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

Constructor.

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

Constructor.

DtRemoteConfigurationMapEntry::DtRemoteConfigurationMapEntry

(

const DtRemoteConfigurationMapEntry &

orig

)

Copy constructor.

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

Copy constructor.

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

Copy constructor.

virtual DtRemoteConfigurationMapEntry::~DtRemoteConfigurationMapEntry ( )

virtual

Destructor.

Member Function Documentation

virtual DtRemoteConfigurationMapEntry* DtRemoteConfigurationMapEntry::clone ( ) const

virtual

Clone operator.

DtRemoteConfigurationMapEntry& DtRemoteConfigurationMapEntry::operator=

(

const DtRemoteConfigurationMapEntry &

orig

)

Assignment operator.

static DtRemoteConfigurationMapEntry* DtRemoteConfigurationMapEntry::create ( )

static

DtRemoteConfigurationMapEntry::AttachByType DtRemoteConfigurationMapEntry::attachByType ( ) const

inline

Describes the rule by which entities will be identified for attachment.

References myAttachByType.

void DtRemoteConfigurationMapEntry::setAttachByType ( AttachByType  atype )

inline

References myAttachByType.

const DtString & DtRemoteConfigurationMapEntry::configurationKeyName ( ) const

inline

Get/set component configuration filename.

References myConfigurationKeyName.

void DtRemoteConfigurationMapEntry::setConfigurationKeyName ( const DtString &  keyname )

inline

References myConfigurationKeyName.

const DtEntityIdentifier & DtRemoteConfigurationMapEntry::entityIdentifier ( ) const

inline

Used to identify entity by entity type enumeration.

References myEntityIdentifier.

void DtRemoteConfigurationMapEntry::setEntityIdentifier ( const DtEntityIdentifier &  eid )

inline

References myEntityIdentifier.

const std::vector< unsigned > & DtRemoteConfigurationMapEntry::forceFilters ( ) const

inline

Returns an array of force types to which this entry applies.

References myForceFilters.

virtual void DtRemoteConfigurationMapEntry::setForceFilters ( const std::vector< unsigned > &  filters )

virtual

const DtString & DtRemoteConfigurationMapEntry::markingText ( ) const

inline

Used to explicitly identify an entity by marking text.

References myMarkingText.

void DtRemoteConfigurationMapEntry::setMarkingText ( const char *  pStr )

inline

References myMarkingText.

void DtRemoteConfigurationMapEntry::setMarkingText ( const DtString &  sStr )

inline

References myMarkingText.

const DtObjectType & DtRemoteConfigurationMapEntry::objectType ( ) const

inline

Used to identify entity by entity type enumeration.

References myObjectType.

virtual void DtRemoteConfigurationMapEntry::setObjectType ( const DtObjectType &  otype )

virtual

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

protectedvirtual

Override getData to parse out member fields.

virtual void DtRemoteConfigurationMapEntry::parseAttachByField ( DtlObjPtr  dtlObjPtr )

protectedvirtual

Parse the "attach-by" data from this form: (attach-by ...) Override to extend the types of attachment that may take place.

virtual void DtRemoteConfigurationMapEntry::parseForceFilterField ( DtlObjPtr  dtlObjPtr )

protectedvirtual

Parse the "force-filter" data from this form: (force-filter ...)

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

protectedvirtual

Override to write out fields.

Reimplemented from DtReaderWriter.

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

protectedvirtual

Write attach-by information to MTL stream Override to extend the way "attach-by" can be represented.

Base class handles "object-type" "marking-text" and "entity-id".

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

protectedvirtual

Write force filter array to MTL stream, if myForceFilters has size.

Member Data Documentation

AttachByType DtRemoteConfigurationMapEntry::myAttachByType

protected

Qualifier to identify entities to which attachment should be applied.

Referenced by attachByType(), and setAttachByType().

DtRwString DtRemoteConfigurationMapEntry::myConfigurationKeyName

protected

This key name must match one of the remote configuration entry keys in the OPD.

Referenced by configurationKeyName(), and setConfigurationKeyName().

DtEntityIdentifier DtRemoteConfigurationMapEntry::myEntityIdentifier

protected

Used to identify explicity entity for attachment.

Referenced by entityIdentifier(), and setEntityIdentifier().

std::vector<unsigned> DtRemoteConfigurationMapEntry::myForceFilters

protected

An array of force types to which this entry applies.

Referenced by forceFilters().

DtString DtRemoteConfigurationMapEntry::myMarkingText

protected

Used to explicitly identify an entity by marking text.

Referenced by markingText(), and setMarkingText().

DtRwObjectType DtRemoteConfigurationMapEntry::myObjectType

protected

Used to identify entity by entity type enumeration.

Referenced by objectType().

---

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

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