---

exotkParameter_Root Class Reference

the Root class for all the parameter types. More...

#include <exotkParameter_Root.hxx>

Inheritance diagram for exotkParameter_Root:

[legend]List of all members.

Public Methods
virtual Standard_EXPORT	~exotkParameter_Root ()
	Destructor. More...
Standard_EXPORT Standard_Boolean	IsCompatible (const Handle_exotkParameter_Root &anOther)
	Return true if anOther as the same type and the same name as this. More...
virtual Standard_EXPORT void	DeepCopy (const Handle_exotkParameter_Root &aParameterToCopy)=0
	copy all the fields of aParameterToCopy into this. More...
Standard_EXPORT TCollection_AsciiString	Name () const
	Return the name of the parameter. More...
Standard_EXPORT void	SetName (const TCollection_AsciiString &aName)
	Set the name of the parameter. More...
virtual Standard_EXPORT Standard_Boolean	SetParameterAsString (const TCollection_AsciiString &aParameter)=0
	Set the parameter as string. More...
virtual Standard_EXPORT TCollection_AsciiString	ParameterAsString () const=0
	return the parameter as string. More...
Standard_EXPORT void	Limits (TCollection_AsciiString &aLowerParameter, TCollection_AsciiString &anUpperParameter)
	Return the limits as strings. More...
Standard_EXPORT exotkParameter_Type	Type () const
	Return the type of parameter. More...
virtual Standard_EXPORT Standard_OStream &	Dump (Standard_OStream &anOS) const
	Dump the parameter into the ostream. More...
Protected Methods
Standard_EXPORT	exotkParameter_Root ()
	Constructor. More...
Protected Attributes
TCollection_AsciiString	myName
TCollection_AsciiString	myLowerLimit
TCollection_AsciiString	myUpperLimit
exotkParameter_Type	myType

---

Detailed Description

the Root class for all the parameter types.

Author:

Stephane Routelous

Definition at line 59 of file exotkParameter_Root.hxx.

---

Constructor & Destructor Documentation

exotkParameter_Root::exotkParameter_Root (    )  [protected]

Constructor. Definition at line 63 of file exotkParameter_Root.cxx. References exotkParameter_Type_Root.

exotkParameter_Root::~exotkParameter_Root (    )  [virtual]

Destructor. Definition at line 79 of file exotkParameter_Root.cxx.

---

Member Function Documentation

exotkParameter_Root::DeepCopy (  const Handle_exotkParameter_Root &    aParameterToCopy )  [pure virtual]

copy all the fields of aParameterToCopy into this. Parameters: aParameterToCopy  const Handle_exotkParameter_Root& Reimplemented in exotkParameter_Boolean, exotkParameter_Enumeration, exotkParameter_Integer, exotkParameter_Real, and exotkParameter_String. Definition at line 161 of file exotkParameter_Root.cxx. References myLowerLimit, myName, myType, and myUpperLimit. Referenced by exotkParameter_String::DeepCopy(), exotkParameter_Real::DeepCopy(), exotkParameter_Integer::DeepCopy(), exotkParameter_Enumeration::DeepCopy(), and exotkParameter_Boolean::DeepCopy().

Standard_OStream & exotkParameter_Root::Dump (  Standard_OStream &    anOS )  const [virtual]

Dump the parameter into the ostream. Returns: Standard_OStream& Return values: anOS  Standard_OStream& Reimplemented in exotkParameter_Enumeration. Definition at line 145 of file exotkParameter_Root.cxx. References myLowerLimit, myName, myUpperLimit, and ParameterAsString(). Referenced by exotkParameter_Enumeration::Dump().

exotkParameter_Root::IsCompatible (  const Handle_exotkParameter_Root &    anOther )

Return true if anOther as the same type and the same name as this. Returns: Standard_Boolean Parameters: anOther  const Handle_exotkParameter_Root& Definition at line 178 of file exotkParameter_Root.cxx. References myName, and myType.

exotkParameter_Root::Limits (  TCollection_AsciiString &    aLowerParameter, TCollection_AsciiString &    anUpperParameter )

Return the limits as strings. Return values: aLowerParameter  TCollection_AsciiString& anUpperParameter  TCollection_AsciiString& Definition at line 130 of file exotkParameter_Root.cxx. References myLowerLimit, and myUpperLimit.

exotkParameter_Root::Name (    )  const

Return the name of the parameter. Returns: TCollection_AsciiString Definition at line 103 of file exotkParameter_Root.cxx. References myName.

exotkParameter_Root::ParameterAsString (    )  const [pure virtual]

return the parameter as string. Returns: TCollection_AsciiString Reimplemented in exotkParameter_Boolean, exotkParameter_Enumeration, exotkParameter_Integer, exotkParameter_Real, and exotkParameter_String. Referenced by Dump().

exotkParameter_Root::SetName (  const TCollection_AsciiString &    aName )

Set the name of the parameter. Parameters: aName  const TCollection_AsciiString& Definition at line 116 of file exotkParameter_Root.cxx. References myName.

exotkParameter_Root::SetParameterAsString (  const TCollection_AsciiString &    aParameter )  [pure virtual]

Set the parameter as string. Returns: Standard_Boolean Parameters: aParameter  const TCollection_AsciiString& Reimplemented in exotkParameter_Boolean, exotkParameter_Enumeration, exotkParameter_Integer, exotkParameter_Real, and exotkParameter_String.

exotkParameter_Root::Type (    )  const

Return the type of parameter. Returns: exotkParameter_Type Definition at line 91 of file exotkParameter_Root.cxx. References exotkParameter_Type, and myType.

---

Member Data Documentation

TCollection_AsciiString exotkParameter_Root::myLowerLimit [protected]

the lower limit as string Definition at line 154 of file exotkParameter_Root.hxx. Referenced by DeepCopy(), Dump(), exotkParameter_Integer::exotkParameter_Integer(), exotkParameter_Real::exotkParameter_Real(), Limits(), exotkParameter_Integer::SetLowerIntegerLimit(), and exotkParameter_Real::SetLowerRealLimit().

TCollection_AsciiString exotkParameter_Root::myName [protected]

the name of the parameter ( application dependent ) Definition at line 152 of file exotkParameter_Root.hxx. Referenced by DeepCopy(), Dump(), IsCompatible(), Name(), and SetName().

exotkParameter_Type exotkParameter_Root::myType [protected]

the parameter type Definition at line 158 of file exotkParameter_Root.hxx. Referenced by DeepCopy(), exotkParameter_Boolean::exotkParameter_Boolean(), exotkParameter_Enumeration::exotkParameter_Enumeration(), exotkParameter_Integer::exotkParameter_Integer(), exotkParameter_Real::exotkParameter_Real(), exotkParameter_String::exotkParameter_String(), IsCompatible(), and Type().

TCollection_AsciiString exotkParameter_Root::myUpperLimit [protected]

the upper limit as string Definition at line 156 of file exotkParameter_Root.hxx. Referenced by DeepCopy(), Dump(), exotkParameter_Integer::exotkParameter_Integer(), exotkParameter_Real::exotkParameter_Real(), Limits(), exotkParameter_Integer::SetUpperIntegerLimit(), and exotkParameter_Real::SetUpperRealLimit().

---

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

• exotkParameter_Root.hxx
• exotkParameter_Root.cxx

---