DtAmmoSelectEntry Class Reference

DtAmmoSelectEntry. More...

Inheritance diagram for DtAmmoSelectEntry:

Public Member Functions
	DtAmmoSelectEntry ()
	default constructor
	DtAmmoSelectEntry (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor
	DtAmmoSelectEntry (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtAmmoSelectEntry (const DtString &name, const DtAmmoSelectEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtAmmoSelectEntry (const DtSymbolString &name, const DtAmmoSelectEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtAmmoSelectEntry &	operator= (const DtAmmoSelectEntry &orig)
	assignment operator
virtual	~DtAmmoSelectEntry ()
virtual DtAmmoSelectEntry *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtAmmoSelectEntry *	clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual const DtRwEntityType &	targetType () const
	Accessor/mutator for myTargetType.
virtual void	setTargetType (const DtEntityType &targetType)
	Accessor/mutator for myTargetType.
virtual const DtSimMunitionList &	simMunitionList () const
	Accessor/mutator for myMunitionList.
virtual void	setSimMunitionList (const DtSimMunitionList &munList)
	Accessor/mutator for myMunitionList.
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)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
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 (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	writeSelf (FILE *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 bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
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 const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
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 void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
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)
	The variable name, if this object is a variable reference.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwEntityType	myTargetType
	Parameter Name: target-type Parameter Description: DIS/RPR entity type enumeration representing the kind of entity to target.
DtSimMunitionList	myMunitionList
	Parameter Name: ammo Parameter Description: List of munition types that can be used against that type of target, in order of preference.
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
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.

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::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (FILE *fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
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 DtReaderWriterFactory *	factory ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
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	putData (FILE *fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.
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

Detailed Description

DtAmmoSelectEntry.

DtAmmoSelectEntry is a readable/writable doublet of DtEntityType and a DtSimMunitionList. It describes the list of ammo types that can be used against a particular target, in order of preference.

Constructor & Destructor Documentation

DtAmmoSelectEntry::DtAmmoSelectEntry

(

)

default constructor

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

real constructor

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

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

copy constructor

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

virtual DtAmmoSelectEntry::~DtAmmoSelectEntry ( )

virtual

Member Function Documentation

const DtAmmoSelectEntry& DtAmmoSelectEntry::operator=

(

const DtAmmoSelectEntry &

orig

)

assignment operator

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

virtual

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

virtual

virtual const DtRwEntityType& DtAmmoSelectEntry::targetType ( ) const

virtual

Accessor/mutator for myTargetType.

virtual void DtAmmoSelectEntry::setTargetType ( const DtEntityType &  targetType )

virtual

Accessor/mutator for myTargetType.

virtual const DtSimMunitionList& DtAmmoSelectEntry::simMunitionList ( ) const

virtual

Accessor/mutator for myMunitionList.

virtual void DtAmmoSelectEntry::setSimMunitionList ( const DtSimMunitionList &  munList )

virtual

Accessor/mutator for myMunitionList.

Member Data Documentation

DtRwEntityType DtAmmoSelectEntry::myTargetType

protected

Parameter Name: target-type
Parameter Description: DIS/RPR entity type enumeration representing the kind of entity to target.

Parameter Default Value:

DtSimMunitionList DtAmmoSelectEntry::myMunitionList

protected

Parameter Name: ammo
Parameter Description: List of munition types that can be used against that type of target, in order of preference.

Parameter Default Value:

---

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

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