DtRwIntelCollectionArea Class Reference

class DtRwIntelCollectionArea:

Information for an intel collection area. The templated list has a modifier value to apply to a force that is the name of the items contained in this list

Inheritance diagram for DtRwIntelCollectionArea:

Public Member Functions
	DtRwIntelCollectionArea ()
	DtRwIntelCollectionArea (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
virtual	~DtRwIntelCollectionArea ()
	DtRwIntelCollectionArea (const DtString &name, const DtRwIntelCollectionArea &orig, DtReaderWriterRegistry *const parentRegistry=NULL)
DtRwIntelCollectionArea &	operator= (const DtRwIntelCollectionArea &orig)
virtual const char *	readerWriterType () const
virtual const char *	xmlType () const
virtual double	modifierForForce (int force)
Public Member Functions inherited from DtRwTemplatedRealList
	DtRwTemplatedRealList ()
	DtRwTemplatedRealList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwTemplatedRealList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwTemplatedRealList (const DtString &name, const DtRwTemplatedRealList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwTemplatedRealList (const DtSymbolString &name, const DtRwTemplatedRealList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwTemplatedRealList (const DtRwTemplatedRealList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
Public Member Functions inherited from DtRwTemplatedListPtr< DtRwReal, true >
	DtRwTemplatedListPtr ()
	DtRwTemplatedListPtr (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwTemplatedListPtr (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwTemplatedListPtr (const DtString &name, const DtRwTemplatedListPtr &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwTemplatedListPtr (const DtSymbolString &name, const DtRwTemplatedListPtr &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwTemplatedListPtr (const DtRwTemplatedListPtr &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtRwTemplatedListPtr &	operator= (const DtRwTemplatedListPtr &orig)
virtual	~DtRwTemplatedListPtr ()
virtual DtReaderWriter *	createPrototype (const char *name="") const override
DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual DtListItem *	insertItemAt (DtRwReal *data, int index)
virtual DtListItem *	add (DtReaderWriter *item) override
virtual DtListItem *	add (DtRwReal *data)
void	removeAll ()
void *	remove (DtListItem *item)
void *	remove (DtRwReal *item)
virtual std::set< DtString >	supportedXmlTypes () const
void	removeAndDeleteAll () override
bool	operator== (const DtRwTemplatedListPtr &) const
bool	operator!= (const DtRwTemplatedListPtr &) const
virtual void	populateList (boost::function< void(DtReaderWriter *)> addFunction, DtEnvironmentSP env, DtEnvValueSP node, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &bindings)
DtListItem *	find (boost::function< bool(const DtRwReal &)> predFcn) const
virtual DtString	prettyPrint () const
const char *	readerWriterType () const
void	copyList (const DtRwTemplatedListPtr &orig)
Public Member Functions inherited from DtRwList
	DtRwList ()
	DtRwList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtRwList ()
const DtRwList &	operator= (const DtRwList &orig)
virtual DtListItem *	addWithAlternateName (DtReaderWriter *data, const DtString &name)
virtual DtListItem *	addToStart (DtReaderWriter *data)
virtual DtListItem *	addToEnd (DtReaderWriter *data)
virtual void *	remove (DtReaderWriter *data, DtListItem *item)
virtual DtlObjPtr	getLocalData (DtlObjPtr args)
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual DtListItem *	addBefore (DtReaderWriter *data, DtReaderWriter *before)
virtual DtListItem *	addAfter (DtReaderWriter *data, DtReaderWriter *after)
virtual void	reset ()
bool	operator== (const DtRwList &rhs) const
bool	operator!= (const DtRwList &rhs) const
virtual void	populateListByType (boost::function< void(DtReaderWriter *)> addFunction, DtEnvironmentSP env, DtEnvValueSP node, const DtString &bindingType, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &bindings)
	DtRwList (const DtString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwList (const DtSymbolString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
virtual DtListItem *	addBefore (DtReaderWriter *data, const DtString &before)
virtual DtListItem *	addBefore (DtReaderWriter *data, const DtSymbolString &before)
virtual DtListItem *	addAfter (DtReaderWriter *data, const DtString &after)
virtual DtListItem *	addAfter (DtReaderWriter *data, const DtSymbolString &after)
virtual void	putData (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP value, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
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	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 int	alignment () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
virtual void	setName (const DtString &)
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 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	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
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 DtRwTemplatedListPtr< DtRwReal, true >
static const char *	theXmlType ()
static const char *	ListReaderWriterType ()
Static Public Member Functions inherited from DtRwList
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)

Additional Inherited Members
Public Types inherited from DtRwTemplatedListPtr< DtRwReal, true >
typedef DtIteratorBase< DtRwReal >	iterator
typedef DtIteratorBase< const DtRwReal >	const_iterator
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 DtRwList
virtual DtListItem *	addBefore (DtReaderWriter *data, DtListItem *before)
virtual DtListItem *	addAfter (DtReaderWriter *data, DtListItem *after)
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
Protected Attributes inherited from DtRwTemplatedListPtr< DtRwReal, true >
DtString	myXmlType
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
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

DtRwIntelCollectionArea::DtRwIntelCollectionArea ( )

inline

default constructor

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

inline

constructor

virtual DtRwIntelCollectionArea::~DtRwIntelCollectionArea ( )

inlinevirtual

destructor

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

inline

copy constructor

Member Function Documentation

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

inline

assignment operator

References DtRwTemplatedListPtr< DtRwReal, true >::operator=().

virtual const char* DtRwIntelCollectionArea::readerWriterType ( ) const

inlinevirtual

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

References DtRwIntelCollectionAreaType.

static const char* DtRwIntelCollectionArea::theXmlType ( )

inlinestatic

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

References DtRwIntelCollectionAreaType.

virtual const char* DtRwIntelCollectionArea::xmlType ( ) const

inlinevirtual

Routines to archive/dearchive from an XML Environment.

Reimplemented from DtRwTemplatedListPtr< DtRwReal, true >.

References DtRwTemplatedListPtr< DtRwReal, true >::theXmlType().

virtual double DtRwIntelCollectionArea::modifierForForce ( int  force )

inlinevirtual

References DtSymbolString::c_str(), DtIteratorBase< T >::current(), and DtReaderWriter::name().

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfutil/rwIntelCollectionArea.h