A signature modifier which can change the signature of a target based on any feature areas it is in contact with which may be affecting its signature.

Inheritance diagram for DtFeatureAreaSignatureModifier:

[legend]

Public Member Functions
	DtFeatureAreaSignatureModifier ()

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

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

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

DtFeatureAreaSignatureModifier &	operator= (const DtFeatureAreaSignatureModifier &orig)

virtual DtSignatureModifier *	clone (DtReaderWriterRegistry *const parentRegistry=NULL) const override

virtual	~DtFeatureAreaSignatureModifier () override

virtual void	clearSensorDegradationFeatureQueries ()

virtual void	addFeatureAreaSignatureModifier (const DtFeatureAreaSignatureModifierEntry &)

virtual const DtList *	featureAreaSignatureModifiers () const

virtual const DtFeatureAreaSignatureModifierEntry *	featureAreaSignatureModifier (const DtString &queryName) const


virtual void	setTickPeriod (double period)

virtual double	tickPeriod () const

Public Member Functions inherited from DtSignatureModifier
	DtSignatureModifier ()

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

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

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

DtSignatureModifier &	operator= (const DtSignatureModifier &orig)

virtual	~DtSignatureModifier () override

virtual DtString	type () const

virtual bool	operator== (const DtSignatureModifier &) const

bool	operator!= (const DtSignatureModifier &rhs) 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 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	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 DtSignatureModifier *	create ()

Static Public Member Functions inherited from DtSignatureModifier
static void	setFactory (DtSignatureModifierFactory *factory)

static DtSignatureModifier *	createSignatureModifier (const DtString &type)

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

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

Protected Attributes
DtFeatureAreaSignatureModifierEntryList	mySignatureModifiers

DtRwReal	myTickPeriod

std::map< DtString, const DtFeatureAreaSignatureModifierEntry * >	mySignatureModifiersByQuery

bool	mySignatureModifiersByQueryInitialized

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

Static Protected Attributes inherited from DtSignatureModifier
static DtSignatureModifierFactory *	theFactory

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

DtFeatureAreaSignatureModifier::DtFeatureAreaSignatureModifier ( )

default constructor

DtFeatureAreaSignatureModifier::DtFeatureAreaSignatureModifier	(	const DtString &	name,
		DtReaderWriterRegistry *const	parentRegistry = `NULL`
	)

real constructor

DtFeatureAreaSignatureModifier::DtFeatureAreaSignatureModifier	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *const	parentRegistry = `NULL`
	)

DtFeatureAreaSignatureModifier::DtFeatureAreaSignatureModifier	(	const DtFeatureAreaSignatureModifier &	orig,
		DtReaderWriterRegistry *const	parentRegistry = `NULL`
	)

copy constructor

virtual DtFeatureAreaSignatureModifier::~DtFeatureAreaSignatureModifier ( )

overridevirtual

Member Function Documentation

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

virtual DtSignatureModifier* DtFeatureAreaSignatureModifier::clone ( DtReaderWriterRegistry *const parentRegistry = NULL ) const

overridevirtual

Returns a copy of this class.

Implements DtSignatureModifier.

virtual void DtFeatureAreaSignatureModifier::clearSensorDegradationFeatureQueries ( )

virtual

Clears the list of feature area queries and their associated signature modifiers.

virtual void DtFeatureAreaSignatureModifier::addFeatureAreaSignatureModifier ( const DtFeatureAreaSignatureModifierEntry & )

virtual

Adds a new feature area query and an associated signature modifier.

virtual const DtList* DtFeatureAreaSignatureModifier::featureAreaSignatureModifiers ( ) const

virtual

Returns the list of DtFeatureAreaSignatureModifierEntry items.

virtual const DtFeatureAreaSignatureModifierEntry* DtFeatureAreaSignatureModifier::featureAreaSignatureModifier ( const DtString & queryName ) const

virtual

Returns the signature modifier information matching the specified feature query name.

virtual void DtFeatureAreaSignatureModifier::setTickPeriod ( double period )

virtual

The tick period at which the engineering area effects should be checked.

virtual double DtFeatureAreaSignatureModifier::tickPeriod ( ) const

virtual

The tick period at which the engineering area effects should be checked.

static DtSignatureModifier* DtFeatureAreaSignatureModifier::create ( )

static

virtual void DtFeatureAreaSignatureModifier::populateSignatureModifiersByQuery ( ) const

protectedvirtual

Populates the map of signature modifier information by feature query name based on the current list of signature modifiers. This function is const so that it may be called by other const methods. However, it does edit the mutable mySignatureModifiersByQuery, which functions as a cache for faster look up of signature modifiers by query name.

Member Data Documentation

DtFeatureAreaSignatureModifierEntryList DtFeatureAreaSignatureModifier::mySignatureModifiers

protected

DtRwReal DtFeatureAreaSignatureModifier::myTickPeriod

protected

std::map<DtString, const DtFeatureAreaSignatureModifierEntry*> DtFeatureAreaSignatureModifier::mySignatureModifiersByQuery

mutableprotected

Cached map for faster access to signature modifiers by feature query name.

bool DtFeatureAreaSignatureModifier::mySignatureModifiersByQueryInitialized

mutableprotected

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation