This file declares DtRemoteConfigurationMapEntry.

Inheritance diagram for DtRemoteConfigurationMapEntry:

Public Types
enum	AttachByType { UnspecifiedType = 0, ObjectType, EntityIdType, MarkingTextType }

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

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

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

	DtRemoteConfigurationMapEntry (const DtRemoteConfigurationMapEntry &orig)

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

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

virtual	~DtRemoteConfigurationMapEntry ()

virtual DtRemoteConfigurationMapEntry *	clone () const

DtRemoteConfigurationMapEntry &	operator= (const DtRemoteConfigurationMapEntry &orig)


DtRemoteConfigurationMapEntry::AttachByType	attachByType () const

void	setAttachByType (AttachByType atype)


const DtString &	configurationKeyName () const

void	setConfigurationKeyName (const DtString &keyname)


const DtEntityIdentifier &	entityIdentifier () const

void	setEntityIdentifier (const DtEntityIdentifier &eid)


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

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


const DtString &	markingText () const

void	setMarkingText (const char *pStr)

void	setMarkingText (const DtString &sStr)


const DtObjectType &	objectType () const

virtual void	setObjectType (const DtObjectType &otype)

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)

virtual	~DtReaderWriter ()

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

virtual void	postPutSelf ()

virtual void	prePutSelf ()

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

virtual void	postGetSelf ()

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

virtual int	alignment () const

virtual bool	variableIsBound () const

virtual void	unbindVariable ()

virtual void	setName (const DtString &)

virtual const char *	readerWriterType () const

virtual const char *	xmlType () const

virtual DtString	prettyPrint () const

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	wasUpdatedSince (DtTime t) const

virtual bool	changedSinceLastChecked ()

virtual bool	peekChangedSinceLastChecked () const

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	putData (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const

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

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

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 DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)

virtual void	parseAttachByField (DtlObjPtr dtlObjPtr)

virtual void	parseForceFilterField (DtlObjPtr dtlObjPtr)

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

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

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

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

Protected Attributes
AttachByType	myAttachByType

DtRwString	myConfigurationKeyName

DtEntityIdentifier	myEntityIdentifier

std::vector< unsigned >	myForceFilters

DtString	myMarkingText

DtRwObjectType	myObjectType

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

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

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

References myAttachByType.

const DtString & DtRemoteConfigurationMapEntry::configurationKeyName ( ) const

inline

Get/set component configuration filename.

References myConfigurationKeyName.

void DtRemoteConfigurationMapEntry::setConfigurationKeyName ( const DtString & keyname )

inline

Get/set component configuration filename.

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

Used to identify entity by entity type enumeration.

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

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

const DtString & DtRemoteConfigurationMapEntry::markingText ( ) const

inline

Used to explicitly identify an entity by marking text.

References myMarkingText.

void DtRemoteConfigurationMapEntry::setMarkingText ( const char * pStr )

inline

Used to explicitly identify an entity by marking text.

References myMarkingText.

void DtRemoteConfigurationMapEntry::setMarkingText ( const DtString & sStr )

inline

Used to explicitly identify an entity by marking text.

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

Used to identify entity by entity type enumeration.

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

protectedvirtual

Override getData to parse out member fields.

Reimplemented from DtReaderWriter.

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:

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfutil/remoteConfigurationMapEntry.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation