---

exotkParameter_Integer Class Reference

Define an Integer parameter. More...

#include <exotkParameter_Integer.hxx>

Inheritance diagram for exotkParameter_Integer:

[legend]Collaboration diagram for exotkParameter_Integer:

[legend]List of all members.

Public Methods
Standard_EXPORT	exotkParameter_Integer (const Standard_Integer aValue)
	Constructor. More...
virtual Standard_EXPORT	~exotkParameter_Integer ()
	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_Integer aValue)
	Set the parameter value to aValue. More...
Standard_EXPORT Standard_Integer	Value () const
	Return the parameter value. More...
Standard_EXPORT void	SetUpperIntegerLimit (const Standard_Integer aValue)
	Set the upper limit for the parameter. More...
Standard_EXPORT void	SetLowerIntegerLimit (const Standard_Integer aValue)
	Set the lower limit for the parameter. More...
Standard_EXPORT void	IntegerLimits (Standard_Integer &aLowerIntegerLimit, Standard_Integer &anUpperIntegerLimit)
	Return the limits for the parameter. More...
virtual Standard_EXPORT Standard_Boolean	SetParameterAsString (const TCollection_AsciiString &aParameter)
	Set the parameter with the contant of the string. this function uses atoi to convert the string into integer. More...
virtual Standard_EXPORT TCollection_AsciiString	ParameterAsString () const
	Return the paramater as string. More...
Private Attributes
Standard_Integer	myValue
Standard_Integer	myLowerIntegerLimit
Standard_Integer	myUpperIntegerLimit

---

Detailed Description

Define an Integer parameter.

Author:

Stephane Routelous

Definition at line 44 of file exotkParameter_Integer.hxx.

---

Constructor & Destructor Documentation

exotkParameter_Integer::exotkParameter_Integer (  const Standard_Integer    aValue )

Constructor. Parameters: aValue  const Standard_Integer Definition at line 68 of file exotkParameter_Integer.cxx. References exotkParameter_Type_Integer, myLowerIntegerLimit, exotkParameter_Root::myLowerLimit, exotkParameter_Root::myType, myUpperIntegerLimit, and exotkParameter_Root::myUpperLimit.

exotkParameter_Integer::~exotkParameter_Integer (    )  [virtual]

Destructor. Definition at line 86 of file exotkParameter_Integer.cxx.

---

Member Function Documentation

exotkParameter_Integer::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 90 of file exotkParameter_Integer.cxx. References exotkParameter_Root::DeepCopy(), myValue, and STANDARD_TYPE().

exotkParameter_Integer::IntegerLimits (  Standard_Integer &    aLowerIntegerLimit, Standard_Integer &    anUpperIntegerLimit )

Return the limits for the parameter. Return values: aLowerIntegerLimit  Standard_Integer& anUpperIntegerLimit  Standard_Integer& Definition at line 204 of file exotkParameter_Integer.cxx. References myLowerIntegerLimit, and myUpperIntegerLimit.

exotkParameter_Integer::ParameterAsString (    )  const [virtual]

Return the paramater as string. Returns: TCollection_AsciiString Reimplemented from exotkParameter_Root. Definition at line 162 of file exotkParameter_Integer.cxx. References myValue.

exotkParameter_Integer::SetLowerIntegerLimit (  const Standard_Integer    aValue )

Set the lower limit for the parameter. Parameters: aValue  const Standard_Integer Definition at line 189 of file exotkParameter_Integer.cxx. References myLowerIntegerLimit, and exotkParameter_Root::myLowerLimit.

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

Set the parameter with the contant of the string. this function uses atoi to convert the string into integer. Returns: Standard_Boolean : true is the generated parameter is inside the limits Parameters: const  TCollection_AsciiString& aParameter Reimplemented from exotkParameter_Root. Definition at line 141 of file exotkParameter_Integer.cxx. References exotkUtils::AsciiStringToInteger(), and SetValue().

exotkParameter_Integer::SetUpperIntegerLimit (  const Standard_Integer    aValue )

Set the upper limit for the parameter. Parameters: aValue  const Standard_Integer Definition at line 175 of file exotkParameter_Integer.cxx. References myUpperIntegerLimit, and exotkParameter_Root::myUpperLimit.

exotkParameter_Integer::SetValue (  const Standard_Integer    aValue )

Set the parameter value to aValue. Returns: Standard_Boolean : retur nfalse if aValue is outside the limits Parameters: aValue  const Standard_Integer Definition at line 110 of file exotkParameter_Integer.cxx. References myLowerIntegerLimit, myUpperIntegerLimit, and myValue. Referenced by SetParameterAsString().

exotkParameter_Integer::Value (    )  const

Return the parameter value. Returns: Standard_Integer Definition at line 128 of file exotkParameter_Integer.cxx. References myValue.

---

Member Data Documentation

Standard_Integer exotkParameter_Integer::myLowerIntegerLimit [private]

the lower limit Definition at line 130 of file exotkParameter_Integer.hxx. Referenced by exotkParameter_Integer(), IntegerLimits(), SetLowerIntegerLimit(), and SetValue().

Standard_Integer exotkParameter_Integer::myUpperIntegerLimit [private]

the upper limit Definition at line 132 of file exotkParameter_Integer.hxx. Referenced by exotkParameter_Integer(), IntegerLimits(), SetUpperIntegerLimit(), and SetValue().

Standard_Integer exotkParameter_Integer::myValue [private]

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

---

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

• exotkParameter_Integer.hxx
• exotkParameter_Integer.cxx

---