SIM_DopDescription Class Reference

#include <SIM_DopDescription.h>

List of all members.

Public Member Functions
	SIM_DopDescription (bool createdop, const char *dopname, const char *dopenglish, const char *dataname, const char *datatypename, const PRM_Template *templates)
	~SIM_DopDescription ()
	The SIM_DopDescription destructor.
bool	getCreateDop () const
const UT_String &	getDopName () const
const UT_String &	getDopEnglish () const
const UT_String &	getDataName () const
const UT_String &	getDataTypeName () const
const PRM_Template *	getTemplates () const
void	setLCDDataTypeName (const char *lcddatatype)
const UT_String &	getLCDDataTypeName () const
	Set the "lowest common denominator" data type name.
void	setDefaultShareData (int share)
	Set the Share Data parameter default. The default if off.
int	getDefaultShareData () const
	Get the Share Data parameter default.
void	setDefaultUniqueDataName (int unique)
	Set the Unique Data Name parameter default. The default is off.
int	getDefaultUniqueDataName () const
	Get the Unique Data Name parameter default.
void	setGuideTemplates (const PRM_Template *tplates)
	Set the templates to use for controlling guide geometry.
const PRM_Template *	getGuideTemplates () const
	Get the templates to use for controlling guide geometry.
void	setObsoleteTemplates (PRM_Template *tplates)
	Set the templates to use for obsolete parameters.
PRM_Template *	getObsoleteTemplates () const
	Get the templates to use for obsolete parameters.

---

Detailed Description

This class is used to create a new DOP type based on a SIM_Data subclass. This class stores the information that describes the automatic DOP that should be created to represent this data type. An automatic DOP outputs an instance of a SIM_Data subclass to be attached to one or more objects.

Examples:

SIM/SIM_ElectricalProperties.C, SIM/SIM_ElectricalProperties.h, SIM/SIM_ForceOrbit.C, SIM/SIM_ForceOrbit.h, SIM/SIM_GasAdd.C, SIM/SIM_GasAdd.h, SIM/SIM_SolverHair.C, SIM/SIM_SolverHair.h, SIM/SIM_SolverSNOW.C, and SIM/SIM_SolverSNOW.h.

Definition at line 26 of file SIM_DopDescription.h.

---

Constructor & Destructor Documentation

SIM_DopDescription::SIM_DopDescription	(	bool	createdop,
		const char *	dopname,
		const char *	dopenglish,
		const char *	dataname,
		const char *	datatypename,
		const PRM_Template *	templates
	)

The SIM_DopDescription constructor. All features of this class are set on construction and cannot be altered once set. Generally this class will be created in a static member function of some SIM_Data subclass and used when registering the data factory. See the various data access functions for a desription of what each constructor argument means.

SIM_DopDescription::~SIM_DopDescription

(

)

The SIM_DopDescription destructor.

---

Member Function Documentation

bool SIM_DopDescription::getCreateDop

(

)

const

Returns true if an automatic DOP should be created. Many SIM_Data subclasses are for internal use only and do not want to be created explicitly by users. In that case this value should be set to false, in which case all other values will be ignored.

const UT_String& SIM_DopDescription::getDataName

(

)

const

Returns the name of the data within the simulation object. This name should be a unique value that specifies the name under which this data is stored in each simulation object.

const UT_String& SIM_DopDescription::getDataTypeName

(

)

const

Returns the name of the SIM_Data subclass type. This is the name under which the SIM_Data subclass is registered. This value is used to create the new data.

int SIM_DopDescription::getDefaultShareData

(

)

const

Get the Share Data parameter default.

int SIM_DopDescription::getDefaultUniqueDataName

(

)

const

Get the Unique Data Name parameter default.

const UT_String& SIM_DopDescription::getDopEnglish

(

)

const

Returns the descriptive name for the DOP operator type. This is the value that appears in toolbars to represent the automatic DOP operator type created from this DOP description.

const UT_String& SIM_DopDescription::getDopName

(

)

const

Returns the name of the automatic DOP operator type. This name must be unique among DOP operator types.

const PRM_Template* SIM_DopDescription::getGuideTemplates

(

)

const

Get the templates to use for controlling guide geometry.

const UT_String& SIM_DopDescription::getLCDDataTypeName

(

)

const

Set the "lowest common denominator" data type name.

PRM_Template* SIM_DopDescription::getObsoleteTemplates

(

)

const

Get the templates to use for obsolete parameters.

const PRM_Template* SIM_DopDescription::getTemplates

(

)

const

Returns an array of PRM_Templates for setting options. The values from each parameter are placed into a SIM_Options, which is then sent to the SIM_Data::setParameters() function to set up the SIM_Data class based on the parameter values.

void SIM_DopDescription::setDefaultShareData

(

int

share

)

Set the Share Data parameter default. The default if off.

void SIM_DopDescription::setDefaultUniqueDataName

(

int

unique

)

Set the Unique Data Name parameter default. The default is off.

void SIM_DopDescription::setGuideTemplates

(

const PRM_Template *

tplates

)

Set the templates to use for controlling guide geometry.

void SIM_DopDescription::setLCDDataTypeName

(

const char *

lcddatatype

)

Set the "lowest common denominator" data type name. This is the data type that DOP nodes compare existing data against to see if the requested data already exists and is of a "compatible" type. This affects whether the DOP node uses its "set initial" parameters or only its "set always" parameters. This defaults to the actual data type name.

void SIM_DopDescription::setObsoleteTemplates

(

PRM_Template *

tplates

)

Set the templates to use for obsolete parameters.

---

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

• SIM/SIM_DopDescription.h