---

exotkParameter_Real Class Reference

Define a Real ( double ) parameter. More...

#include <exotkParameter_Real.hxx>

Inheritance diagram for exotkParameter_Real:

[legend]Collaboration diagram for exotkParameter_Real:

[legend]List of all members.

Public Methods
Standard_EXPORT	exotkParameter_Real (const Standard_Real aValue)
	Constructor. More...
virtual Standard_EXPORT	~exotkParameter_Real ()
	Destructor. More...
virtual Standard_EXPORT void	DeepCopy (const Handle_exotkParameter_Root &aParameterToCopy)
	copy all the fields of aParameterToCopy into this. More...
Standard_EXPORT Standard_Boolean	SetValue (const Standard_Real aValue)
	Set the parameter to aValue. More...
Standard_EXPORT Standard_Real	Value () const
	Return the parameter value. More...
Standard_EXPORT void	SetUpperRealLimit (const Standard_Real aValue)
	Set the upper limit to aValue. More...
Standard_EXPORT void	SetLowerRealLimit (const Standard_Real aValue)
	Set the lower limit to aValue. More...
Standard_EXPORT void	RealLimits (Standard_Real &aLowerRealLimit, Standard_Real &anUpperRealLimit)
	return the limits of the parameter. More...
virtual Standard_EXPORT Standard_Boolean	SetParameterAsString (const TCollection_AsciiString &aParameter)
	Set the parameter as string the function uses atof to convert the string into double. More...
virtual Standard_EXPORT TCollection_AsciiString	ParameterAsString () const
	Return the parameter as string. More...
Private Attributes
Standard_Real	myValue
Standard_Real	myLowerRealLimit
Standard_Real	myUpperRealLimit

---

Detailed Description

Define a Real ( double ) parameter.

Author:

Stephane Routelous

Definition at line 44 of file exotkParameter_Real.hxx.

---

Constructor & Destructor Documentation

exotkParameter_Real::exotkParameter_Real (  const Standard_Real    aValue )

Constructor. Parameters: aValue  const Standard_Real Definition at line 69 of file exotkParameter_Real.cxx. References exotkParameter_Type_Real, exotkParameter_Root::myLowerLimit, myLowerRealLimit, exotkParameter_Root::myType, exotkParameter_Root::myUpperLimit, and myUpperRealLimit.

exotkParameter_Real::~exotkParameter_Real (    )  [virtual]

Destructor. Definition at line 91 of file exotkParameter_Real.cxx.

---

Member Function Documentation

exotkParameter_Real::DeepCopy (  const Handle_exotkParameter_Root &    aParameterToCopy )  [virtual]

copy all the fields of aParameterToCopy into this. Parameters: aParameterToCopy  const Handle_exotkParameter_Root& Reimplemented from exotkParameter_Root. Definition at line 96 of file exotkParameter_Real.cxx. References exotkParameter_Root::DeepCopy(), myLowerRealLimit, myUpperRealLimit, myValue, and STANDARD_TYPE().

exotkParameter_Real::ParameterAsString (    )  const [virtual]

Return the parameter as string. Returns: TCollection_AsciiString Reimplemented from exotkParameter_Root. Definition at line 171 of file exotkParameter_Real.cxx. References myValue.

exotkParameter_Real::RealLimits (  Standard_Real &    aLowerRealLimit, Standard_Real &    anUpperRealLimit )

return the limits of the parameter. Return values: aLowerRealLimit  Standard_Real& anUpperRealLimit  Standard_Real& Definition at line 213 of file exotkParameter_Real.cxx. References myLowerRealLimit, and myUpperRealLimit.

exotkParameter_Real::SetLowerRealLimit (  const Standard_Real    aValue )

Set the lower limit to aValue. Parameters: aValue  const Standard_Real Definition at line 198 of file exotkParameter_Real.cxx. References exotkParameter_Root::myLowerLimit, and myLowerRealLimit.

exotkParameter_Real::SetParameterAsString (  const TCollection_AsciiString &    aParameter )  [virtual]

Set the parameter as string the function uses atof to convert the string into double. Returns: Standard_Boolean : return false if the parameter is outside the limits Parameters: const  TCollection_AsciiString& aParameter Reimplemented from exotkParameter_Root. Definition at line 146 of file exotkParameter_Real.cxx. References exotkUtils::AsciiStringToReal(), and SetValue().

exotkParameter_Real::SetUpperRealLimit (  const Standard_Real    aValue )

Set the upper limit to aValue. Parameters: aValue  const Standard_Real Definition at line 184 of file exotkParameter_Real.cxx. References exotkParameter_Root::myUpperLimit, and myUpperRealLimit.

exotkParameter_Real::SetValue (  const Standard_Real    aValue )

Set the parameter to aValue. Returns: Standard_Boolean return false if aValue is ouside the limits Parameters: aValue  const Standard_Real Definition at line 115 of file exotkParameter_Real.cxx. References myLowerRealLimit, myUpperRealLimit, and myValue. Referenced by SetParameterAsString().

exotkParameter_Real::Value (    )  const

Return the parameter value. Returns: Standard_Real Definition at line 133 of file exotkParameter_Real.cxx. References myValue.

---

Member Data Documentation

Standard_Real exotkParameter_Real::myLowerRealLimit [private]

the lower limit Definition at line 130 of file exotkParameter_Real.hxx. Referenced by DeepCopy(), exotkParameter_Real(), RealLimits(), SetLowerRealLimit(), and SetValue().

Standard_Real exotkParameter_Real::myUpperRealLimit [private]

the upper limit Definition at line 132 of file exotkParameter_Real.hxx. Referenced by DeepCopy(), exotkParameter_Real(), RealLimits(), SetUpperRealLimit(), and SetValue().

Standard_Real exotkParameter_Real::myValue [private]

the parameter value Definition at line 128 of file exotkParameter_Real.hxx. Referenced by DeepCopy(), ParameterAsString(), SetValue(), and Value().

---

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

• exotkParameter_Real.hxx
• exotkParameter_Real.cxx

---