DtDmgSurfaceTable Class Reference

Instances of DtDmgSurfaceTable are (readable/writable) lists of DtDmgSurfaceEntrys. More...

Inheritance diagram for DtDmgSurfaceTable:

Public Member Functions
	DtDmgSurfaceTable (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	constructor
	DtDmgSurfaceTable (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtDmgSurfaceTable (const DtString &name, const DtDmgSurfaceTable &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtDmgSurfaceTable (const DtSymbolString &name, const DtDmgSurfaceTable &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtDmgSurfaceTable &	operator= (const DtDmgSurfaceTable &orig)
	Assignment operator; removes and deletes all entries on the left hand side - then clones all entries on the right side list, adding them to the left side list.
virtual	~DtDmgSurfaceTable ()
	destructor
virtual DtDmgSurfaceTable *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual DtDmgSurfaceTable *	clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual void	addSurfaceEntry (const DtDmgSurfaceEntry &surfaceEntry)
virtual void	removeSurfaceEntry (DtDmgSurfaceEntry *surfaceEntry)
	Removes entry pointed to by surfaceEntry, but does not delete.
virtual bool	getProbabilities (const DtString &surface, DtReal angleOfIncidence, DtReal inputValue, DtPrbValueList *probList) const
	Fills in the probability list passed based on the remaining arguments.
virtual double	getMaximumInputValue () const
	Returns the maximum input value at which the munition can do damage for this surface.
virtual double	getMinimumInputValue () const
	Returns the minimum input value at which the munition can do damage for this surface.
bool	operator== (const DtDmgSurfaceTable &) const
bool	operator!= (const DtDmgSurfaceTable &rhs) const
virtual bool	isValid () const
	Returns true if this is a valid table.
Public Member Functions inherited from DtRwList
	DtRwList ()
	default constructor
	DtRwList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor
	DtRwList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtRwList ()
const DtRwList &	operator= (const DtRwList &orig)
	Calls down to DtReaderWriter::operator=(). List elements are not copied.
virtual DtListItem *	add (DtReaderWriter *data)
	Add element to the end of the list.
virtual DtListItem *	addWithAlternateName (DtReaderWriter *data, const DtString &name)
	Add element to the end of the list, but use the provided name in place of the object name on the data object.
virtual DtListItem *	addToStart (DtReaderWriter *data)
	Add element to the beginning of the list.
virtual DtListItem *	addToEnd (DtReaderWriter *data)
	Add element to the end of the list.
virtual void *	remove (DtReaderWriter *data, DtListItem *item)
	Remove an element from the list.
virtual DtlObjPtr	getLocalData (DtlObjPtr args)
	Since getData is usually used for local data, and we're overloading it here to get the list data, use this if you want any data before your lists.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual DtListItem *	addBefore (DtReaderWriter *data, DtReaderWriter *before)
	Add element to the list just before the indicated item.
virtual DtListItem *	addAfter (DtReaderWriter *data, DtReaderWriter *after)
	Add element to the list just after the indicated item.
virtual void	removeAll ()
	Removes all the items in the list.
virtual void	removeAndDeleteAll ()
	Removes and deletes all items in the list.
virtual void	reset ()
	Calls removeAndDeleteAll.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
bool	operator== (const DtRwList &rhs) const
	Iterates over all items and calls the factory to compare.
bool	operator!= (const DtRwList &rhs) const
virtual void	populateList (boost::function< void(DtReaderWriter *)> addFunction, DtEnvironmentSP env, DtEnvValueSP node, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &bindings)
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)
	Invokes DtReaderWriter copy constructor.
	DtRwList (const DtSymbolString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
virtual DtListItem *	addBefore (DtReaderWriter *data, const DtString &before)
	Add element to the list just before the indicated item.
virtual DtListItem *	addBefore (DtReaderWriter *data, const DtSymbolString &before)
virtual DtListItem *	addAfter (DtReaderWriter *data, const DtString &after)
	Add element to the list just after the indicated item.
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())
	Gets data from the environment value.
virtual const char *	xmlType () const
virtual std::set< DtString >	supportedXmlTypes () const
	Returns the list of xml types supported by this list. Default is all.
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
bool	isReadonly () const
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual bool	changedSinceLastChecked ()
	Returns true if this objects value has changed since the last time this function was called.
virtual bool	peekChangedSinceLastChecked () const
	Returns the value that changedSinceLastChecked would return but does not reset the internal flag.
virtual void	putData (std::string &fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual DtRwVariableBindings *	generateVariableBindings () const
	Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class.
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restores object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.

Protected Member Functions
	DtDmgSurfaceTable ()
	default constructor
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	Constructs a DtDmgSurfaceEntry, reads it from the mtl stream, and then adds it to the list.
virtual void	emptyList ()
	Removes all descriptors from the list, and destroys them.
virtual void	copyList (const DtDmgSurfaceTable &orig)
virtual void	addSurfaceEntry (DtDmgSurfaceEntry *surfaceEntry)
virtual void	removeSurfaceEntry (DtDmgSurfaceEntry *surfaceEntry, DtListItem *item)
Protected Member Functions inherited from DtRwList
virtual DtListItem *	addBefore (DtReaderWriter *data, DtListItem *before)
	Add element to the list just before the indicated item.
virtual DtListItem *	addAfter (DtReaderWriter *data, DtListItem *after)
	Add element to the list just after the indicated item.
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.

Protected Attributes
DtHashlist	myHashIndex

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 Public Member Functions inherited from DtRwList
static const char *	theXmlType ()
	The type that is used when archiving to an XML stream.
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 DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
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)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	Given a xml environment, returns a newly created reader/writer object from the object found within.
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP.
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

Detailed Description

Instances of DtDmgSurfaceTable are (readable/writable) lists of DtDmgSurfaceEntrys.

A string hash index is maintained for quick lookup. Given a surface, angle, and some input value, this class's getProbabilities() method will fill in the supplied DtPrbValueList.

Constructor & Destructor Documentation

DtDmgSurfaceTable::DtDmgSurfaceTable ( )

protected

default constructor

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

constructor

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

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

copy constructor

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

virtual DtDmgSurfaceTable::~DtDmgSurfaceTable ( )

virtual

destructor

Member Function Documentation

DtDmgSurfaceTable& DtDmgSurfaceTable::operator=

(

const DtDmgSurfaceTable &

orig

)

Assignment operator; removes and deletes all entries on the left hand side - then clones all entries on the right side list, adding them to the left side list.

virtual DtDmgSurfaceTable* DtDmgSurfaceTable::clone ( const DtString &  name, DtReaderWriterRegistry *  parentRegistry = NULL  )

virtual

virtual DtDmgSurfaceTable* DtDmgSurfaceTable::clone ( const DtSymbolString &  name, DtReaderWriterRegistry *  parentRegistry = NULL  )

virtual

virtual void DtDmgSurfaceTable::addSurfaceEntry ( const DtDmgSurfaceEntry &  surfaceEntry )

virtual

virtual void DtDmgSurfaceTable::removeSurfaceEntry ( DtDmgSurfaceEntry *  surfaceEntry )

virtual

Removes entry pointed to by surfaceEntry, but does not delete.

virtual bool DtDmgSurfaceTable::getProbabilities ( const DtString &  surface, DtReal  angleOfIncidence, DtReal  inputValue, DtPrbValueList *  probList  ) const

virtual

Fills in the probability list passed based on the remaining arguments.

false is returned if appropriate data cannot be found.

virtual double DtDmgSurfaceTable::getMaximumInputValue ( ) const

virtual

Returns the maximum input value at which the munition can do damage for this surface.

virtual double DtDmgSurfaceTable::getMinimumInputValue ( ) const

virtual

Returns the minimum input value at which the munition can do damage for this surface.

bool DtDmgSurfaceTable::operator==

(

const DtDmgSurfaceTable &

)

const

bool DtDmgSurfaceTable::operator!= ( const DtDmgSurfaceTable &  rhs ) const

inline

virtual bool DtDmgSurfaceTable::isValid ( ) const

virtual

Returns true if this is a valid table.

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

protectedvirtual

Constructs a DtDmgSurfaceEntry, reads it from the mtl stream, and then adds it to the list.

Implements DtRwList.

virtual void DtDmgSurfaceTable::emptyList ( )

protectedvirtual

Removes all descriptors from the list, and destroys them.

virtual void DtDmgSurfaceTable::copyList ( const DtDmgSurfaceTable &  orig )

protectedvirtual

virtual void DtDmgSurfaceTable::addSurfaceEntry ( DtDmgSurfaceEntry *  surfaceEntry )

protectedvirtual

virtual void DtDmgSurfaceTable::removeSurfaceEntry ( DtDmgSurfaceEntry *  surfaceEntry, DtListItem *  item  )

protectedvirtual

Member Data Documentation

DtHashlist DtDmgSurfaceTable::myHashIndex

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjparam/dmgSurfaceTable.h