DtDmgSurfaceEntry Class Reference

DtDmgSurfaceEntry is a readable/writable list of angle of incidence tables; the name of the list is a surface. More...

Inheritance diagram for DtDmgSurfaceEntry:

Public Member Functions
	DtDmgSurfaceEntry ()
	DtDmgSurfaceEntry (const DtString &surface, DtReaderWriterRegistry *parentRegistry=NULL)
	constructor with parameters to set up read/writability correctly
	DtDmgSurfaceEntry (const DtSymbolString &surface, DtReaderWriterRegistry *parentRegistry=NULL)
	DtDmgSurfaceEntry (const DtString &surface, const DtDmgSurfaceEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtDmgSurfaceEntry (const DtSymbolString &surface, const DtDmgSurfaceEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtDmgSurfaceEntry &	operator= (const DtDmgSurfaceEntry &orig)
virtual	~DtDmgSurfaceEntry ()
	destructor
virtual DtDmgSurfaceEntry *	clone (const DtString &surface, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtDmgSurfaceEntry *	clone (const DtSymbolString &surface, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual void	addAngleOfIncidenceTable (const DtDmgAngleOfIncidenceTable &angleTable)
	Adds angle of incidence table.
virtual bool	getProbabilities (DtReal angle, DtReal inputValue, DtPrbValueList *probList) const
	Fills in the DtPrbValueList with a category/value pair for each item on its list (including the actual calculation of the probability value).
virtual double	getMaximumInputValue () const
	Assuming that probability decreases as the input value increases, returns the maximum input value at which the munition can do damage for this surface.
virtual double	getMinimumInputValue () const
	Assuming that probability increases as the input value increases, returns the minimum input value at which the munition can do damage for this surface.
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())
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())
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	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
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 void	putData (std::string &fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
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 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 &)
	Restires 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	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())
	Gets data from the environment value.
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.

Static Public Member Functions
static void	setFactory (DtDmgAngleOfIncidenceTableFactory *factory)
	Set the factory used to create angle of incidence tables.
static DtDmgAngleOfIncidenceTableFactory *	factory ()
	Access the factory used to create angle of incidence tables.
Static Public Member Functions inherited from DtRwList
static const char *	theXmlType ()
	The type that is used when archiving to an XML stream.

Protected Member Functions
virtual DtDmgAngleOfIncidenceTable *	createAngleOfIncidenceTable (const DtString &tableType)
	Creates a new determinant of the given type.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	Creates the right kind of angle of incidence table, reads it, and adds it to the list.
virtual void	emptyList ()
virtual void	copyList (const DtDmgSurfaceEntry &orig)
virtual void	addAngleOfIncidenceTable (DtDmgAngleOfIncidenceTable *angleTable)
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 Member Functions inherited from DtObjectDebugger< DtReaderWriter >
	DtObjectDebugger ()
	DtObjectDebugger (const DtObjectDebugger &)
	~DtObjectDebugger ()

Static Protected Attributes
static DtDmgAngleOfIncidenceTableFactory *	theFactory
	Static pointer to the factory for angle of incidence tables.

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 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
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

Detailed Description

DtDmgSurfaceEntry is a readable/writable list of angle of incidence tables; the name of the list is a surface.

DtDmgSurfaceTable will contain a (readable/writable) list of these entries. A DtDmgSurfaceEntry will take an angle of incidence and a value, which can represent either range or a power, and return a DtDmRangeTableEntry.

Constructor & Destructor Documentation

DtDmgSurfaceEntry::DtDmgSurfaceEntry

(

)

DtDmgSurfaceEntry::DtDmgSurfaceEntry	(	const DtString &	surface,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

constructor with parameters to set up read/writability correctly

DtDmgSurfaceEntry::DtDmgSurfaceEntry	(	const DtSymbolString &	surface,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

DtDmgSurfaceEntry::DtDmgSurfaceEntry	(	const DtString &	surface,
		const DtDmgSurfaceEntry &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor

DtDmgSurfaceEntry::DtDmgSurfaceEntry	(	const DtSymbolString &	surface,
		const DtDmgSurfaceEntry &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

virtual DtDmgSurfaceEntry::~DtDmgSurfaceEntry ( )

virtual

destructor

Member Function Documentation

const DtDmgSurfaceEntry& DtDmgSurfaceEntry::operator=

(

const DtDmgSurfaceEntry &

orig

)

virtual DtDmgSurfaceEntry* DtDmgSurfaceEntry::clone ( const DtString &  surface, DtReaderWriterRegistry *  parentRegistry = NULL  ) const

virtual

virtual DtDmgSurfaceEntry* DtDmgSurfaceEntry::clone ( const DtSymbolString &  surface, DtReaderWriterRegistry *  parentRegistry = NULL  ) const

virtual

virtual void DtDmgSurfaceEntry::addAngleOfIncidenceTable ( const DtDmgAngleOfIncidenceTable &  angleTable )

virtual

Adds angle of incidence table.

List is kept in ascending order (by the angle specified in the tables on the list).

virtual bool DtDmgSurfaceEntry::getProbabilities ( DtReal  angle, DtReal  inputValue, DtPrbValueList *  probList  ) const

virtual

Fills in the DtPrbValueList with a category/value pair for each item on its list (including the actual calculation of the probability value).

Returns false if no entry found for angle specified. (Note: if no entry is found for the input value specified, the list will have 0.0s filled in for probabilities).

virtual double DtDmgSurfaceEntry::getMaximumInputValue ( ) const

virtual

Assuming that probability decreases as the input value increases, returns the maximum input value at which the munition can do damage for this surface.

virtual double DtDmgSurfaceEntry::getMinimumInputValue ( ) const

virtual

Assuming that probability increases as the input value increases, returns the minimum input value at which the munition can do damage for this surface.

static void DtDmgSurfaceEntry::setFactory ( DtDmgAngleOfIncidenceTableFactory *  factory )

static

Set the factory used to create angle of incidence tables.

static DtDmgAngleOfIncidenceTableFactory* DtDmgSurfaceEntry::factory ( )

static

Access the factory used to create angle of incidence tables.

If none has been set, creates the default factory.

Reimplemented from DtReaderWriter.

virtual DtDmgAngleOfIncidenceTable* DtDmgSurfaceEntry::createAngleOfIncidenceTable ( const DtString &  tableType )

protectedvirtual

Creates a new determinant of the given type.

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

protectedvirtual

Creates the right kind of angle of incidence table, reads it, and adds it to the list.

Implements DtRwList.

virtual void DtDmgSurfaceEntry::emptyList ( )

protectedvirtual

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

protectedvirtual

virtual void DtDmgSurfaceEntry::addAngleOfIncidenceTable ( DtDmgAngleOfIncidenceTable *  angleTable )

protectedvirtual

Member Data Documentation

DtDmgAngleOfIncidenceTableFactory* DtDmgSurfaceEntry::theFactory

staticprotected

Static pointer to the factory for angle of incidence tables.

---

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

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