Inheritance diagram for DtModelSetEntry:

Public Member Functions
	DtModelSetEntry ()

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

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

virtual DtModelSetEntry &	operator= (const DtModelSetEntry &orig)

virtual	~DtModelSetEntry () override

virtual DtModelSetEntry *	clone ()

virtual const char *	readerWriterType ()

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 DtEntityType &)

const DtEntityType &	objectType () const

void	setMatchType (const DtEntityType &)

const DtEntityType &	matchType () const

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

std::list< DtEntityType > &	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	setInternalNotes (const DtString &)

const DtString &	internalNotes () 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 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 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 Attributes
DtRwBoolean	myCanCreate

DtRwBoolean	myCanAggregate

DtRwString	myLabel

DtRwString	myUniqueID

DtRwString	myKeywords

DtRwString	myMenuIcon

DtRwString	myDefaultOverlayLayer

DtRwString	myDescription

DtRwEntityType	myObjectType

DtRwForces	myForces

DtRwNLengthStringVector	myCategories

DtRwNLengthStringVector	myDeployableCountries

DtRwStringAttributeList	myIconLists

DtRwBoolean	myIncludeInBVSPCalcs

DtString	myPlatform

DtString	myShortName

DtRwBoolean	myIsRandomized

std::list< DtEntityType >	myAdditionalMatchTypes

DtEntityType	myMatchType

DtString	myInternalNotes

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

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

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 Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Constructor & Destructor Documentation

DtModelSetEntry::DtModelSetEntry ( )

default constructor

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

real constructor

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

copy constructor

virtual DtModelSetEntry::~DtModelSetEntry ( )

overridevirtual

Member Function Documentation

virtual DtModelSetEntry& DtModelSetEntry::operator= ( const DtModelSetEntry & orig )

virtual

Assign to DtString. Assigns value only.

Reimplemented in DtSimulationObjectGroupModelSetEntry.

virtual DtModelSetEntry* DtModelSetEntry::clone ( )

virtual

Reimplemented in DtSimulationObjectGroupModelSetEntry.

virtual const char* DtModelSetEntry::readerWriterType ( )

virtual

Reimplemented in DtSimulationObjectGroupModelSetEntry.

static DtModelSetEntryCreatorFcn DtModelSetEntry::SetModelSetEntryCreatorFcn ( DtModelSetEntryCreatorFcn )

static

Factory creator methods call to set and create a DtModelSet.

static DtModelSetEntryCreatorFcn DtModelSetEntry::ModelSetEntryCreatorFcn ( )

static

Factory creator methods call to set and create a DtModelSet.

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

static

Factory creator methods call to set and create a DtModelSet.

DtString DtModelSetEntry::label ( ) const

inline

References myLabel.

void DtModelSetEntry::setLabel ( const DtString & s )

inline

References myLabel.

DtString DtModelSetEntry::platform ( ) const

inline

References myPlatform.

void DtModelSetEntry::setPlatform ( const DtString & s )

inline

References myPlatform.

DtString DtModelSetEntry::uniqueID ( ) const

inline

References myUniqueID.

void DtModelSetEntry::setUniqueID ( const DtString & s )

inline

References myUniqueID.

void DtModelSetEntry::setIsRandomized ( bool b )

inline

Whether or not this model represents a randomized object type. Randomized object types are just containers for objects that could be created. Defined in the objects subordinate objects member.

References myIsRandomized.

bool DtModelSetEntry::isRandomized ( ) const

inline

References myIsRandomized.

bool DtModelSetEntry::canCreate ( ) const

inline

References myCanCreate.

void DtModelSetEntry::setCanCreate ( bool b )

inline

References myCanCreate.

bool DtModelSetEntry::canAggregate ( ) const

inline

References myCanAggregate.

void DtModelSetEntry::setCanAggregate ( bool b )

inline

References myCanAggregate.

void DtModelSetEntry::setObjectType ( const DtEntityType & o )

inline

References myObjectType.

const DtEntityType & DtModelSetEntry::objectType ( ) const

inline

References myObjectType.

void DtModelSetEntry::setMatchType ( const DtEntityType & o )

inline

The match type is a second entry that can be used to match against an object type. When finding this entry in a model set by matching by pattern, this match type (if specified) will be looked at first, then the more general object type for pattern matching.

References myMatchType.

const DtEntityType & DtModelSetEntry::matchType ( ) const

inline

References myMatchType.

const std::list< DtEntityType > & DtModelSetEntry::additionalMatchTypes ( ) const

inline

References myAdditionalMatchTypes.

std::list< DtEntityType > & DtModelSetEntry::additionalMatchTypes ( )

inline

References myAdditionalMatchTypes.

DtString DtModelSetEntry::menuIcon ( ) const

inline

References myMenuIcon.

void DtModelSetEntry::setMenuIcon ( const DtString & s )

inline

References myMenuIcon.

void DtModelSetEntry::setKeywords ( const DtString & s )

inline

References myKeywords.

DtString DtModelSetEntry::keywords ( ) const

inline

References myKeywords.

void DtModelSetEntry::setShortName ( const DtString & )

This will only be not empty if present in able to be read from .entity file.

const DtString& DtModelSetEntry::shortName ( ) const

void DtModelSetEntry::setIncludeInBVSPCalcs ( bool b )

inline

Whether or not to include in bounding volume or support point calcs from the entity editor. Default is true.

References myIncludeInBVSPCalcs.

bool DtModelSetEntry::includeInBVSPCalcs ( ) const

inline

References myIncludeInBVSPCalcs.

virtual void DtModelSetEntry::setDescription ( const DtString & )

virtual

virtual const DtString& DtModelSetEntry::description ( ) const

virtual

void DtModelSetEntry::setInternalNotes ( const DtString & s )

inline

Not saved or read from a file. This can be used for temporary storage of information about this entry.

References myInternalNotes.

const DtString & DtModelSetEntry::internalNotes ( ) const

inline

References myInternalNotes.

void DtModelSetEntry::setForces ( const DtRwForces & f )

inline

References myForces.

const DtRwForces & DtModelSetEntry::forces ( ) const

inline

References myForces.

DtRwForces & DtModelSetEntry::forces ( )

inline

References myForces.

void DtModelSetEntry::setCategories ( const DtRwNLengthStringVector & c )

inline

References myCategories.

const DtRwNLengthStringVector & DtModelSetEntry::categories ( ) const

inline

References myCategories.

bool DtModelSetEntry::hasCategory ( const DtString & cat ) const

inline

References DtRwNLengthStringVector::indexOfValue(), and myCategories.

void DtModelSetEntry::setDefaultOverlayLayer ( const DtString & s )

inline

References myDefaultOverlayLayer.

DtString DtModelSetEntry::defaultOverlayLayer ( ) const

inline

References myDefaultOverlayLayer.

void DtModelSetEntry::setDeployableCountries ( const DtRwNLengthStringVector & c )

inline

References myDeployableCountries.

const DtRwNLengthStringVector & DtModelSetEntry::deployableCountries ( ) const

inline

References myDeployableCountries.

const DtRwStringAttributeList & DtModelSetEntry::iconLists ( ) const

inline

Accesor/mutator for list icons that can be applied to a category of list selected. If the object does not have an icon for the list then the default font (or menu image) will be used as a display.

References myIconLists.

DtRwStringAttributeList & DtModelSetEntry::iconLists ( )

inline

References myIconLists.

void DtModelSetEntry::setIconLists ( const DtRwStringAttributeList & l )

inline

References myIconLists.

void DtModelSetEntry::setIconForList	(	const DtString &	icon,
		const DtString &	list
	)

inline

References DtRwStringAttributeList::addStringAttribute(), myIconLists, and DtRwStringAttributeList::removeStringAttribute().

DtString DtModelSetEntry::iconForList ( const DtString & key ) const

inline

References myIconLists, and DtRwStringAttributeList::value().

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

virtual

Reimplemented in DtSimulationObjectGroupModelSetEntry.

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

virtual

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

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. Match type will be read from the environment, if it exists.

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

virtual

Writes the contents of the entry to the specified environment using the guiInformation. Match type is not written to the environment. This is done by the Simulation Object Editor as a separate process. Optional argument returns a list of elements that were written Second optional argument is an MSE to compare against before writing a particular element to the environment.