DtTargetPriorityEntry; readable/writeable representation of a prioritized entity type.

DtTargetPriorityEntry is a readable/writable doublet of DtEntityType and an integer priority. The DtTargetPriorityList is a list of these types.

Inheritance diagram for DtTargetPriorityEntry:

[legend]

Public Member Functions
	DtTargetPriorityEntry ()

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

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

const DtTargetPriorityEntry &	operator= (const DtTargetPriorityEntry &orig)

virtual	~DtTargetPriorityEntry () override

virtual DtTargetPriorityEntry *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const

bool	operator== (const DtTargetPriorityEntry &) const

virtual const char *	readerWriterType () const override

virtual const char *	xmlType () const override


virtual void	setEntityType (const DtEntityType &entityType)

virtual const DtRwEntityType &	entityType () const


virtual void	setPriority (int priority)

virtual int	priority () const

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

virtual bool	peekChangedSinceLastChecked () const

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

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

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 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 Attributes
Parameters
These parameters are available for setting in the OPD files.
DtRwEntityType	myEntityType

DtRwInt	myPriority

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

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

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

Constructor & Destructor Documentation

DtTargetPriorityEntry::DtTargetPriorityEntry ( )

default constructor

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

real constructor

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

copy constructor

virtual DtTargetPriorityEntry::~DtTargetPriorityEntry ( )

overridevirtual

Member Function Documentation

const DtTargetPriorityEntry& DtTargetPriorityEntry::operator= ( const DtTargetPriorityEntry & orig )

assignment operator

virtual DtTargetPriorityEntry* DtTargetPriorityEntry::clone	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)		const

virtual

virtual void DtTargetPriorityEntry::setEntityType ( const DtEntityType & entityType )

virtual

Accessor/mutator for myEntityType.

virtual const DtRwEntityType& DtTargetPriorityEntry::entityType ( ) const

virtual

Accessor/mutator for myEntityType.

virtual void DtTargetPriorityEntry::setPriority ( int priority )

virtual

Accessor/mutator for myPriority.

virtual int DtTargetPriorityEntry::priority ( ) const

virtual

Accessor/mutator for myPriority.

bool DtTargetPriorityEntry::operator== ( const DtTargetPriorityEntry & ) const

virtual const char* DtTargetPriorityEntry::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 DtReaderWriter.

static const char* DtTargetPriorityEntry::theXmlType ( )

static

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

virtual const char* DtTargetPriorityEntry::xmlType ( ) const

inlineoverridevirtual

Reimplemented from DtReaderWriter.

References DtReaderWriter::theXmlType().

Member Data Documentation

DtRwEntityType DtTargetPriorityEntry::myEntityType

protected

Parameter Name: entity-type
Parameter Description: DIS/RPR enumerated entity type associated with priority value.
Parameter Default Value:

DtRwInt DtTargetPriorityEntry::myPriority

protected

Parameter Name: priority
Parameter Description: The priority assigned to this entity type when creating the target-list.
Parameter Default Value: 0.

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfobjparam/targetPriorityEntry.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation