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

Inheritance diagram for DtSimulationObjectGroupModelSetEntry:

Public Member Functions
	DtSimulationObjectGroupModelSetEntry ()

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

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

DtSimulationObjectGroupModelSetEntry &	operator= (const DtSimulationObjectGroupModelSetEntry &orig)

DtSimulationObjectGroupModelSetEntry &	operator= (const DtModelSetEntry &orig)

virtual	~DtSimulationObjectGroupModelSetEntry ()

virtual DtModelSetEntry *	clone ()

virtual const char *	readerWriterType ()

virtual void	setGroupCreationFlags (int)

virtual int	groupCreationFlags () const

virtual void	readFromEnvironment (DtEnvironmentSP, DtEnvValueSP objectNode)

virtual void	writeToEnvironment (DtEnvironmentSP, DtEnvValueSP objectNode) const

virtual void	addSimulatonObject (const DtSimulationObjectEntityState &)

virtual void	addSimulatonObject (const DtSimulationObjectAggregateState &)

virtual void	addSimulatonObject (const DtSimulationObjectEnvironmentalState &)

virtual void	clearSimulationObjects ()

virtual bool	load (const DtFilename &)

virtual void	save ()

virtual void	save (const DtFilename &)

virtual const DtFilename &	filename () const

virtual void	setFilename (const DtFilename &)

virtual void	setInZipFile (bool)

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

	DtModelSetEntry (const DtString &name, DtReaderWriterRegistry *const parentRegistry=nullptr)

	DtModelSetEntry (const DtModelSetEntry &orig, DtReaderWriterRegistry *const parentRegistry=nullptr)

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)

bool	isRandomized () const

bool	canCreate () const

void	setCanCreate (bool)

bool	canAggregate () const

void	setCanAggregate (bool)

void	setObjectType (const DtObjectType &)

const DtObjectType &	objectType () const

void	setMatchType (const DtObjectType &)

const DtObjectType &	matchType () const

const std::list< DtObjectType > &	additionalMatchTypes () const

std::list< DtObjectType > &	additionalMatchTypes ()

DtString	menuIcon () const

void	setMenuIcon (const DtString &)

void	setKeywords (const DtString &)

DtString	keywords () const

void	setShortName (const DtString &)

const DtString &	shortName () const

void	setIncludeInBVSPCalcs (bool)

bool	includeInBVSPCalcs () const

virtual void	setDescription (const DtString &)

virtual const DtString &	description () const

void	setForces (const DtRwForces &)

const DtRwForces &	forces () const

DtRwForces &	forces ()

void	setCategories (const DtRwNLengthStringVector &)

const DtRwNLengthStringVector &	categories () const

bool	hasCategory (const DtString &) const

void	setDefaultOverlayLayer (const DtString &)

DtString	defaultOverlayLayer () const

void	setDeployableCountries (const DtRwNLengthStringVector &)

const DtRwNLengthStringVector &	deployableCountries () const

const DtRwStringAttributeList &	iconLists () const

DtRwStringAttributeList &	iconLists ()

void	setIconLists (const DtRwStringAttributeList &)

void	setIconForList (const DtString &, const DtString &)

DtString	iconForList (const DtString &) const

virtual bool	operator!= (const DtModelSetEntry &) const

virtual void	readFromEnvironment (DtEnvironmentSP, DtEnvValueSP objectNode, bool keepCurrentData=false)

virtual void	writeToEnvironment (DtEnvironmentSP, DtEnvValueSP objectNode, std::vector< DtString > =nullptr, DtModelSetEntry =nullptr) const

virtual void	updateImageData (char from, char to) const

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

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	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

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 void	reset ()

virtual int	alignment () const

virtual bool	variableIsBound () const

virtual void	unbindVariable ()

virtual void	setName (const DtString &)

virtual const char *	readerWriterType () const

virtual const char *	xmlType () const

virtual DtString	prettyPrint () const

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 DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)

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	putData (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const

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

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 DtModelSetEntry *	create (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)

Static Public Member Functions inherited from DtModelSetEntry
static DtModelSetEntryCreatorFcn	SetModelSetEntryCreatorFcn (DtModelSetEntryCreatorFcn)

static DtModelSetEntryCreatorFcn	ModelSetEntryCreatorFcn ()

static DtModelSetEntry *	Create (const DtString &name="model-set-entry", DtReaderWriterRegistry *const parentRegistry=nullptr)

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)

Protected Member Functions
virtual void	readAllSimulationObject (DtEnvironmentSP e, DtEnvValueSP objectName, const DtString &objectKind)

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

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

DtRwString	myDescription

DtRwObjectType	myObjectType

DtRwForces	myForces

DtRwNLengthStringVector	myCategories

DtRwNLengthStringVector	myDeployableCountries

DtRwStringAttributeList	myIconLists

DtRwBoolean	myIncludeInBVSPCalcs

DtString	myPlatform

DtString	myShortName

DtRwBoolean	myIsRandomized

std::list< DtObjectType >	myAdditionalMatchTypes

DtObjectType	myMatchType

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

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 DtModelSetEntry
static DtModelSetEntryCreatorFcn	theModelSetEntryCreatorFcn

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

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 )

virtual

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::setGroupCreationFlags ( int )

virtual

virtual int DtSimulationObjectGroupModelSetEntry::groupCreationFlags ( ) const

virtual

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

static

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.

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

virtual

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

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

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:

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfobjparam/simulationObjectGroupModelSetEntry.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation