DtSimulationObjectGroupModelSetEntry Class Reference

Description: A model is a set of items that defines a model to create in the back-end from the front-end. More...

Inheritance diagram for DtSimulationObjectGroupModelSetEntry:

Public Member Functions
	DtSimulationObjectGroupModelSetEntry ()
	default constructor
	DtSimulationObjectGroupModelSetEntry (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
	real constructor
	DtSimulationObjectGroupModelSetEntry (const DtSimulationObjectGroupModelSetEntry &orig, DtReaderWriterRegistry *const parentRegistry=NULL)
	copy constructor
DtSimulationObjectGroupModelSetEntry &	operator= (const DtSimulationObjectGroupModelSetEntry &orig)
	Assign to DtString. Assigns value only.
DtSimulationObjectGroupModelSetEntry &	operator= (const DtModelSetEntry &orig)
	Assign to DtString. Assigns value only.
virtual	~DtSimulationObjectGroupModelSetEntry ()
virtual DtModelSetEntry *	clone ()
virtual const char *	readerWriterType ()
virtual void	setGroupDescription (const DtString &)
virtual const DtString &	groupDescription () const
virtual void	setGroupCreationFlags (int)
virtual int	groupCreationFlags () const
virtual void	readFromEnvironment (DtEnvironmentSP, DtEnvValueSP objectNode)
	Loads the model set entry information from the specified environment.
virtual void	writeToEnvironment (DtEnvironmentSP, DtEnvValueSP objectNode) const
	Writes the contents of the entry to the specified environment using the guiInformation.
virtual void	addSimulatonObject (const DtSimulationObjectEntityState &)
	Clones object and adds to internal data.
virtual void	addSimulatonObject (const DtSimulationObjectAggregateState &)
virtual void	addSimulatonObject (const DtSimulationObjectEnvironmentalState &)
virtual void	clearSimulationObjects ()
	Clears out simulation objects.
virtual bool	load (const DtFilename &)
	Loads this entry from the specified file.
virtual void	save ()
	Saves with the current filename.
virtual void	save (const DtFilename &)
	Saves to the filename and sets myFilename.
virtual const DtFilename &	filename () const
	The directory and file that represents this simulation object group.
virtual void	setFilename (const DtFilename &)
virtual void	setInZipFile (bool)
	Whether or not the simulation object group files are in a zip file.
virtual bool	inZipFile () const
virtual bool	operator== (const DtModelSetEntry &) const
const std::vector < DtSimulationObjectBaseState * > &	simulationObjects () const
virtual void	setAdditionalInformation (const std::map< DtString, DtString > &)
virtual void	setAdditionalInformation (const DtRwStringAttributeList &)
virtual const DtRwStringAttributeList &	additionalInformation () const
Public Member Functions inherited from DtModelSetEntry
	DtModelSetEntry ()
	default constructor
	DtModelSetEntry (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
	real constructor
	DtModelSetEntry (const DtModelSetEntry &orig, DtReaderWriterRegistry *const parentRegistry=NULL)
	copy constructor
virtual	~DtModelSetEntry ()
DtString	label () const
void	setLabel (const DtString &)
DtString	platform () const
void	setPlatform (const DtString &)
DtString	uniqueID () const
void	setUniqueID (const DtString &)
void	setIsRandomized (bool)
	Whether or not this model represents a randomized object type.
bool	isRandomized () const
bool	canCreate () const
void	setCanCreate (bool)
bool	canAggregate () const
void	setCanAggregate (bool)
void	setObjectType (const DtObjectType &)
DtObjectType	objectType () const
DtString	menuIcon () const
void	setMenuIcon (const DtString &)
void	setKeywords (const DtString &)
DtString	keywords () const
void	setIncludeInBVSPCalcs (bool)
	Whether or not to include in bounding volume or support point calcs from the entity editor.
bool	includeInBVSPCalcs () const
void	setForces (const DtRwForces &)
const DtRwForces &	forces () const
DtRwForces &	forces ()
void	setCategories (const DtRwNLengthStringVector &)
const DtRwNLengthStringVector &	categories () const
void	addOnPalette (const DtString &)
void	removeOnPalette (const DtString &)
void	setOnlyOnPalette (const DtString &)
void	setOnPalettes (const DtRwNLengthStringVector &)
const DtRwNLengthStringVector &	onPalettes () const
void	setDefaultOverlayLayer (const DtString &)
DtString	defaultOverlayLayer () const
void	setDeployableCountries (const DtRwNLengthStringVector &)
const DtRwNLengthStringVector &	deployableCountries () const
virtual bool	operator!= (const DtModelSetEntry &) const
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
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 void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to original state Default is no-op.
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 const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual const char *	xmlType () const
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 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 &)
	Restores object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
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 DtModelSetEntry *	create (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)

Protected Member Functions
virtual void	readAllSimulationObject (DtEnvironmentSP e, DtEnvValueSP objectName, const DtString &objectKind)
	Reads in all simulation objects of the particular type.

Protected Attributes
DtRwString	myGroupDescription
DtRwInt	myGroupCreationFlags
std::vector < DtSimulationObjectBaseState * >	mySimulationObjects
DtFilename	myFilename
DtRwStringAttributeList	myAdditionalInformation
DtRwBoolean	myInZipFile
Protected Attributes inherited from DtModelSetEntry
DtRwBoolean	myCanCreate
DtRwBoolean	myCanAggregate
DtRwString	myLabel
DtRwString	myUniqueID
DtRwString	myKeywords
DtRwString	myMenuIcon
DtRwString	myDefaultOverlayLayer
DtRwObjectType	myObjectType
DtRwForces	myForces
DtRwNLengthStringVector	myOnPalettes
DtRwNLengthStringVector	myCategories
DtRwNLengthStringVector	myDeployableCountries
DtRwBoolean	myIncludeInBVSPCalcs
DtString	myPlatform
DtRwBoolean	myIsRandomized
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.
bool	myChangedFlag
	Set to true when value changes Set to false when value checked with changedSinceLastChecked.

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

Detailed Description

Description: A model is a set of items that defines a model to create in the back-end from the front-end.

Constructor & Destructor Documentation

DtSimulationObjectGroupModelSetEntry::DtSimulationObjectGroupModelSetEntry

(

)

default constructor

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

real constructor

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

copy constructor

virtual DtSimulationObjectGroupModelSetEntry::~DtSimulationObjectGroupModelSetEntry ( )

virtual

Member Function Documentation

DtSimulationObjectGroupModelSetEntry& DtSimulationObjectGroupModelSetEntry::operator=

(

const DtSimulationObjectGroupModelSetEntry &

orig

)

Assign to DtString. Assigns value only.

DtSimulationObjectGroupModelSetEntry& DtSimulationObjectGroupModelSetEntry::operator=

(

const DtModelSetEntry &

orig

)

Assign to DtString. Assigns value only.

Reimplemented from DtModelSetEntry.

virtual DtModelSetEntry* DtSimulationObjectGroupModelSetEntry::clone ( )

virtual

Reimplemented from DtModelSetEntry.

virtual const char* DtSimulationObjectGroupModelSetEntry::readerWriterType ( )

virtual

Reimplemented from DtModelSetEntry.

virtual void DtSimulationObjectGroupModelSetEntry::setGroupDescription ( const DtString &  )

virtual

virtual const DtString& DtSimulationObjectGroupModelSetEntry::groupDescription ( ) const

virtual

virtual void DtSimulationObjectGroupModelSetEntry::setGroupCreationFlags ( int  )

virtual

virtual int DtSimulationObjectGroupModelSetEntry::groupCreationFlags ( ) const

virtual

static DtModelSetEntry* DtSimulationObjectGroupModelSetEntry::create ( const DtString &  name, DtReaderWriterRegistry *const  parentRegistry = NULL  )

static

Reimplemented from DtModelSetEntry.

virtual void DtSimulationObjectGroupModelSetEntry::readFromEnvironment ( DtEnvironmentSP  , DtEnvValueSP  objectNode  )

virtual

Loads the model set entry information from the specified environment.

It will look for a variable in the environment called guiInformation and pull the attributes from that

Reimplemented from DtModelSetEntry.

virtual void DtSimulationObjectGroupModelSetEntry::writeToEnvironment ( DtEnvironmentSP  , DtEnvValueSP  objectNode  ) const

virtual

Writes the contents of the entry to the specified environment using the guiInformation.

Reimplemented from DtModelSetEntry.

virtual void DtSimulationObjectGroupModelSetEntry::addSimulatonObject ( const DtSimulationObjectEntityState &  )

virtual

Clones object and adds to internal data.

virtual void DtSimulationObjectGroupModelSetEntry::addSimulatonObject ( const DtSimulationObjectAggregateState &  )

virtual

virtual void DtSimulationObjectGroupModelSetEntry::addSimulatonObject ( const DtSimulationObjectEnvironmentalState &  )

virtual

virtual void DtSimulationObjectGroupModelSetEntry::clearSimulationObjects ( )

virtual

Clears out simulation objects.

virtual bool DtSimulationObjectGroupModelSetEntry::load ( const DtFilename &  )

virtual

Loads this entry from the specified file.

virtual void DtSimulationObjectGroupModelSetEntry::save ( )

virtual

Saves with the current filename.

virtual void DtSimulationObjectGroupModelSetEntry::save ( const DtFilename &  )

virtual

Saves to the filename and sets myFilename.

virtual const DtFilename& DtSimulationObjectGroupModelSetEntry::filename ( ) const

virtual

The directory and file that represents this simulation object group.

virtual void DtSimulationObjectGroupModelSetEntry::setFilename ( const DtFilename &  )

virtual

virtual void DtSimulationObjectGroupModelSetEntry::setInZipFile ( bool  )

virtual

Whether or not the simulation object group files are in a zip file.

virtual bool DtSimulationObjectGroupModelSetEntry::inZipFile ( ) const

virtual

virtual bool DtSimulationObjectGroupModelSetEntry::operator== ( const DtModelSetEntry &  ) const

virtual

Reimplemented from DtModelSetEntry.

const std::vector<DtSimulationObjectBaseState*>& DtSimulationObjectGroupModelSetEntry::simulationObjects ( ) const

inline

virtual void DtSimulationObjectGroupModelSetEntry::setAdditionalInformation ( const std::map< DtString, DtString > &  )

virtual

virtual void DtSimulationObjectGroupModelSetEntry::setAdditionalInformation ( const DtRwStringAttributeList &  )

virtual

virtual const DtRwStringAttributeList& DtSimulationObjectGroupModelSetEntry::additionalInformation ( ) const

virtual

virtual void DtSimulationObjectGroupModelSetEntry::readAllSimulationObject ( DtEnvironmentSP  e, DtEnvValueSP  objectName, const DtString &  objectKind  )

protectedvirtual

Reads in all simulation objects of the particular type.

Member Data Documentation

DtRwString DtSimulationObjectGroupModelSetEntry::myGroupDescription

protected

DtRwInt DtSimulationObjectGroupModelSetEntry::myGroupCreationFlags

protected

std::vector<DtSimulationObjectBaseState*> DtSimulationObjectGroupModelSetEntry::mySimulationObjects

protected

DtFilename DtSimulationObjectGroupModelSetEntry::myFilename

protected

DtRwStringAttributeList DtSimulationObjectGroupModelSetEntry::myAdditionalInformation

protected

DtRwBoolean DtSimulationObjectGroupModelSetEntry::myInZipFile

protected

---

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

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