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 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)
	Describes the rule by which entities will be identified for attachment.

const DtString &	configurationKeyName () const
	Get/set component configuration filename.
void	setConfigurationKeyName (const DtString &keyname)
	Get/set component configuration filename.

const DtEntityIdentifier &	entityIdentifier () const
	Used to identify entity by entity type enumeration.
void	setEntityIdentifier (const DtEntityIdentifier &eid)
	Used to identify entity by entity type enumeration.

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)
	Returns an array of force types to which this entry applies.

const DtString &	markingText () const
	Used to explicitly identify an entity by marking text.
void	setMarkingText (const char *pStr)
	Used to explicitly identify an entity by marking text.
void	setMarkingText (const DtString &sStr)
	Used to explicitly identify an entity by marking text.

const DtObjectType &	objectType () const
	Used to identify entity by entity type enumeration.
virtual void	setObjectType (const DtObjectType &otype)
	Used to identify entity by entity type enumeration.
Static Public Member Functions
static DtRemoteConfigurationMapEntry *	create ()
Protected Member Functions
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, 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 (FILE *fp, int indentLevel=0)
	Override to write out fields.
virtual void	writeAttachBy (FILE *fp, int indentLevel=0)
	Write attach-by information to MTL stream Override to extend the way "attach-by" can be represented.
virtual void	writeForceFilter (FILE *fp, int indentLevel=0)
	Write force filter array to MTL stream, if myForceFilters has size.
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.

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]

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 DtFilename &	searchPath,
		const DtVariableBindingsList &	variableBindings
	)		`[protected, virtual]`

Override getData to parse out member fields.

virtual void DtRemoteConfigurationMapEntry::parseAttachByField ( DtlObjPtr dtlObjPtr ) [protected, virtual]

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 ) [protected, virtual]

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

virtual void DtRemoteConfigurationMapEntry::putData	(	FILE *	fp,
		int	indentLevel = `0`
	)		`[protected, virtual]`

Override to write out fields.

Reimplemented from DtReaderWriter.

virtual void DtRemoteConfigurationMapEntry::writeAttachBy	(	FILE *	fp,
		int	indentLevel = `0`
	)		`[protected, virtual]`

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	(	FILE *	fp,
		int	indentLevel = `0`
	)		`[protected, virtual]`

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:

include/vrfutil/remoteConfigurationMapEntry.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation