DtScriptedTaskVariable Class Reference

A class for keeping track of meta data for variables of scripted tasks. More...

Public Member Functions
	DtScriptedTaskVariable ()
	default constructor
virtual	~DtScriptedTaskVariable ()
	destructor
	DtScriptedTaskVariable (const DtScriptedTaskVariable &orig)
	copy constructor
DtScriptedTaskVariable &	operator= (const DtScriptedTaskVariable &orig)
	assignment operator
virtual bool	load (const std::string &)
	Loads the object from the given xml string buffer.
virtual bool	save (std::string &) const
	Saves the value to the given string buffer.
virtual DtReaderWriter *	toRwPtr () const
	Creates a new reader writer object based on the variable itself though it will lose much of the class data in the conversion process.
virtual void	fromRwPtr (const DtReaderWriter *)
	Sets the default value of the variable from the value suppled in the reader/writer pointer.
virtual void	setVariableName (const std::string &)
virtual const std::string &	variableName () const
virtual void	setType (const std::string &)
virtual const std::string &	type () const
virtual void	setLabel (const std::string &)
virtual const std::string &	label () const
virtual void	setToolTip (const std::string &)
virtual const std::string &	toolTip () const
virtual void	setDefaultValue (const std::string &)
virtual const std::string &	defaultValue () const
virtual int	indexOfDefaultInVariableData () const
	Returns the index of the default value in the variable data. Used in combo box. Presumes variable data is ; separated.
virtual void	setIndent (int)
virtual int	indent () const
virtual void	setVariableRange (double bottom, double top)
virtual void	variableRange (double &bottom, double &top) const
virtual void	setInternal (bool)
virtual bool	isInternal () const
virtual void	setVariableData (const std::string &)
virtual const std::string &	variableData () const
virtual void	setVisible (bool)
virtual bool	visible () const

Protected Member Functions
virtual DtString	convertToString (const DtRwNLengthStringVector &) const
	Converts some values to a string for easier parsing.
virtual DtString	convertToString (const DtVector &) const
virtual DtString	convertToString (const DtTaitBryan &) const
virtual DtString	convertToString (const DtVertexList &) const
virtual DtString	convertOffsetToString (const DtVector &) const
template<class Archive >
void	serialize (Archive &ar, const unsigned int version)
	When the class Archive corresponds to an output archive, the & operator is defined similar to <<.

Protected Attributes
std::string	myVariableName
std::string	myType
std::string	myLabel
std::string	myToolTip
std::string	myDefaultValue
double	myRangeBottom
double	myRangeTop
std::string	myVariableData
bool	myVisible
bool	myInternal
int	myIndent

Friends
class	boost::serialization::access
	Serialization/Deserialization //.

Detailed Description

A class for keeping track of meta data for variables of scripted tasks.

The information is currently stored in an XML format

Constructor & Destructor Documentation

DtScriptedTaskVariable::DtScriptedTaskVariable

(

)

default constructor

virtual DtScriptedTaskVariable::~DtScriptedTaskVariable ( )

virtual

destructor

DtScriptedTaskVariable::DtScriptedTaskVariable

(

const DtScriptedTaskVariable &

orig

)

copy constructor

Member Function Documentation

DtScriptedTaskVariable& DtScriptedTaskVariable::operator=

(

const DtScriptedTaskVariable &

orig

)

assignment operator

virtual bool DtScriptedTaskVariable::load ( const std::string &  )

virtual

Loads the object from the given xml string buffer.

virtual bool DtScriptedTaskVariable::save ( std::string &  ) const

virtual

Saves the value to the given string buffer.

virtual void DtScriptedTaskVariable::setVariableName ( const std::string &  )

virtual

Accessor for the variable name. This is the name that will be bound in the script. The label field should be used for the user presented name

virtual const std::string& DtScriptedTaskVariable::variableName ( ) const

virtual

Accessor for the variable name. This is the name that will be bound in the script. The label field should be used for the user presented name

virtual void DtScriptedTaskVariable::setType ( const std::string &  )

virtual

Accessor for the variable type. Only meaningful for those elements that care to represent the variable in some type of GUI

virtual const std::string& DtScriptedTaskVariable::type ( ) const

virtual

Accessor for the variable type. Only meaningful for those elements that care to represent the variable in some type of GUI

virtual void DtScriptedTaskVariable::setLabel ( const std::string &  )

virtual

Accessor for the variable label. Only meaningful for those elements that care to represent the variable in some type of GUI

virtual const std::string& DtScriptedTaskVariable::label ( ) const

virtual

Accessor for the variable label. Only meaningful for those elements that care to represent the variable in some type of GUI

virtual void DtScriptedTaskVariable::setToolTip ( const std::string &  )

virtual

Accessor for the variable tool tip. Only meaningful for those elements that care to represent the variable in some type of GUI

virtual const std::string& DtScriptedTaskVariable::toolTip ( ) const

virtual

Accessor for the variable tool tip. Only meaningful for those elements that care to represent the variable in some type of GUI

virtual void DtScriptedTaskVariable::setDefaultValue ( const std::string &  )

virtual

Accessor for the variable default value. Only meaningful for those elements that care to represent the variable in some type of GUI

virtual const std::string& DtScriptedTaskVariable::defaultValue ( ) const

virtual

Accessor for the variable default value. Only meaningful for those elements that care to represent the variable in some type of GUI

virtual int DtScriptedTaskVariable::indexOfDefaultInVariableData ( ) const

virtual

Returns the index of the default value in the variable data. Used in combo box. Presumes variable data is ; separated.

virtual void DtScriptedTaskVariable::setIndent ( int  )

virtual

Accessor for indent of widget. This indent will be a level of indent to space the widget from the left of the dialog

virtual int DtScriptedTaskVariable::indent ( ) const

virtual

Accessor for indent of widget. This indent will be a level of indent to space the widget from the left of the dialog

virtual void DtScriptedTaskVariable::setVariableRange ( double  bottom, double  top  )

virtual

Accessor for the variables range. Only meaningful for those elements that care to represent the variable in some type of GUI and the value entered is some kind of ranged value

virtual void DtScriptedTaskVariable::variableRange ( double &  bottom, double &  top  ) const

virtual

Accessor for the variables range. Only meaningful for those elements that care to represent the variable in some type of GUI and the value entered is some kind of ranged value

virtual void DtScriptedTaskVariable::setInternal ( bool  )

virtual

Internal variables are not visible to the user for changing or removal on the scripted task dialog, but are still sent through as part of the task

virtual bool DtScriptedTaskVariable::isInternal ( ) const

virtual

Internal variables are not visible to the user for changing or removal on the scripted task dialog, but are still sent through as part of the task

virtual void DtScriptedTaskVariable::setVariableData ( const std::string &  )

virtual

Accessor for the variable data of the variable. This data will be specific for the variable type. Only meaningful for those elements that care to represent the variable in some type of GUI

virtual const std::string& DtScriptedTaskVariable::variableData ( ) const

virtual

Accessor for the variable data of the variable. This data will be specific for the variable type. Only meaningful for those elements that care to represent the variable in some type of GUI

virtual void DtScriptedTaskVariable::setVisible ( bool  )

virtual

Whether or not variable is visible or simply contains a value that the user cannot modify. Default is visible

virtual bool DtScriptedTaskVariable::visible ( ) const

virtual

Whether or not variable is visible or simply contains a value that the user cannot modify. Default is visible

virtual DtReaderWriter* DtScriptedTaskVariable::toRwPtr ( ) const

virtual

Creates a new reader writer object based on the variable itself though it will lose much of the class data in the conversion process.

The conversion is based on the types listed in vrfutil/vrfScriptedTasksConstants.h and generally maps to a base reader writer type (such as DtRwInt). The intended use is to get a Reader writer with the correct name and a default value for the object based on the default in this object. Returns null if there is no default value (empty string) or if the type has no conversion (from the type() function).

virtual void DtScriptedTaskVariable::fromRwPtr ( const DtReaderWriter *  )

virtual

Sets the default value of the variable from the value suppled in the reader/writer pointer.

virtual DtString DtScriptedTaskVariable::convertToString ( const DtRwNLengthStringVector &  ) const

protectedvirtual

Converts some values to a string for easier parsing.

virtual DtString DtScriptedTaskVariable::convertToString ( const DtVector &  ) const

protectedvirtual

virtual DtString DtScriptedTaskVariable::convertToString ( const DtTaitBryan &  ) const

protectedvirtual

virtual DtString DtScriptedTaskVariable::convertToString ( const DtVertexList &  ) const

protectedvirtual

virtual DtString DtScriptedTaskVariable::convertOffsetToString ( const DtVector &  ) const

protectedvirtual

template<class Archive >

void DtScriptedTaskVariable::serialize ( Archive &  ar, const unsigned int  version  )

inlineprotected

When the class Archive corresponds to an output archive, the & operator is defined similar to <<.

Likewise, when the class Archive is a type of input archive the & operator is defined similar to >>.

Friends And Related Function Documentation

friend class boost::serialization::access

friend

Serialization/Deserialization //.

Member Data Documentation

std::string DtScriptedTaskVariable::myVariableName

protected

std::string DtScriptedTaskVariable::myType

protected

std::string DtScriptedTaskVariable::myLabel

protected

std::string DtScriptedTaskVariable::myToolTip

protected

std::string DtScriptedTaskVariable::myDefaultValue

protected

double DtScriptedTaskVariable::myRangeBottom

protected

double DtScriptedTaskVariable::myRangeTop

protected

std::string DtScriptedTaskVariable::myVariableData

protected

bool DtScriptedTaskVariable::myVisible

protected

bool DtScriptedTaskVariable::myInternal

protected

int DtScriptedTaskVariable::myIndent

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-3-branch/include/vrfutil/scriptedTaskVariable.h