Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members Related Pages

exotkParameter_Enumeration Class Reference

Define Enumeration parameter. More...

#include <exotkParameter_Enumeration.hxx>

Inheritance diagram for exotkParameter_Enumeration:

[legend]Collaboration diagram for exotkParameter_Enumeration:

[legend]List of all members.

Public Methods
Standard_EXPORT	exotkParameter_Enumeration (const Standard_Integer aValue)
	Constructor. More...
virtual Standard_EXPORT	~exotkParameter_Enumeration ()
	Destructor. More...
Standard_EXPORT void	EnumInit ()
	Initialize the enumeration iterator. More...
Standard_EXPORT Standard_Boolean	EnumMore ()
	iterator. More...
Standard_EXPORT void	EnumNext ()
	iterator. More...
Standard_EXPORT Standard_Integer	EnumCurrentIndex ()
	Return the current index of the enumeration in the iterator process. More...
Standard_EXPORT TCollection_AsciiString	EnumCurrentName ()
	Return the current name of the enumeration in the iterator process. 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. More...
Standard_EXPORT Standard_Boolean	AddEnumerationMember (const Standard_Integer anIndex, const TCollection_AsciiString &aName)
	Function do document the possible parameters. More...
Standard_EXPORT Standard_Boolean	EnumerationMember (const Standard_Integer anIndex, TCollection_AsciiString &aName) const
	Return the enumeration member corresponding to anIndex. More...
virtual Standard_EXPORT Standard_Boolean	SetParameterAsString (const TCollection_AsciiString &aParameter)
	Set the parameter with a string input. More...
virtual Standard_EXPORT TCollection_AsciiString	ParameterAsString () const
	Return the parameter value as string. More...
virtual Standard_EXPORT Standard_OStream &	Dump (Standard_OStream &anOS) const
	Dump the parameter. More...
Private Attributes
Standard_Integer	myValue
exotkParameter_DoubleMapIntegerAsciiString	myMapIntegerAsciiString
exotkParameter_DoubleMapIteratorOfDoubleMapIntegerAsciiString	myMapIterator

Detailed Description

Define Enumeration parameter.

Author:: Stephane Routelous

Definition at line 50 of file exotkParameter_Enumeration.hxx.

Constructor & Destructor Documentation

exotkParameter_Enumeration::exotkParameter_Enumeration ( const Standard_Integer aValue )

Constructor.

Parameters:

aValue const Standard_Integer the value of the parameter

Definition at line 68 of file exotkParameter_Enumeration.cxx.
References exotkParameter_Type_Enumeration, and exotkParameter_Root::myType.

exotkParameter_Enumeration::~exotkParameter_Enumeration ( ) [virtual]

Destructor.

Definition at line 82 of file exotkParameter_Enumeration.cxx.

Member Function Documentation

exotkParameter_Enumeration::AddEnumerationMember ( const Standard_Integer anIndex,

const TCollection_AsciiString & aName

)

Function do document the possible parameters.

Returns:
Standard_Boolean : return false if anIndex is outside the limits
Parameters:

anIndex const Standard_Integer : the enumeration member to define

aName const TCollection_AsciiString& : the name or the human readable string associated with anIndex

Definition at line 214 of file exotkParameter_Enumeration.cxx.
References exotkParameter_DoubleMapIntegerAsciiString::Bind(), exotkParameter_DoubleMapIntegerAsciiString::IsBound1(), exotkParameter_DoubleMapIntegerAsciiString::IsBound2(), and myMapIntegerAsciiString.

exotkParameter_Enumeration::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 95 of file exotkParameter_Enumeration.cxx.
References exotkParameter_DoubleMapIntegerAsciiString::Bind(), exotkParameter_DoubleMapIntegerAsciiString::Clear(), exotkParameter_Root::DeepCopy(), myMapIntegerAsciiString, myValue, and STANDARD_TYPE().

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

Dump the parameter.

Returns:
Standard_OStream&
Parameters:

anOS Standard_OStream&

Reimplemented from exotkParameter_Root.
Definition at line 254 of file exotkParameter_Enumeration.cxx.
References exotkParameter_Root::Dump(), exotkParameter_DoubleMapIteratorOfDoubleMapIntegerAsciiString::Initialize(), exotkParameter_DoubleMapIteratorOfDoubleMapIntegerAsciiString::Key1(), exotkParameter_DoubleMapIteratorOfDoubleMapIntegerAsciiString::Key2(), and myMapIntegerAsciiString.

exotkParameter_Enumeration::EnumCurrentIndex ( )

Return the current index of the enumeration in the iterator process.

Returns:
Standard_Integer

Definition at line 309 of file exotkParameter_Enumeration.cxx.
References exotkParameter_DoubleMapIteratorOfDoubleMapIntegerAsciiString::Key1(), and myMapIterator.

exotkParameter_Enumeration::EnumCurrentName ( )

Return the current name of the enumeration in the iterator process.

Returns:
TCollection_AsciiString

Definition at line 321 of file exotkParameter_Enumeration.cxx.
References exotkParameter_DoubleMapIteratorOfDoubleMapIntegerAsciiString::Key2(), and myMapIterator.

exotkParameter_Enumeration::EnumerationMember ( const Standard_Integer anIndex,

TCollection_AsciiString & aName

) const

Return the enumeration member corresponding to anIndex.

Returns:
Standard_Boolean : return false if anIndex is outside the boundaries
Parameters:

anIndex const Standard_Integer : the index to get

Return values:

aName TCollection_AsciiString& : the returned name

Definition at line 236 of file exotkParameter_Enumeration.cxx.
References exotkParameter_DoubleMapIntegerAsciiString::Find1(), exotkParameter_DoubleMapIntegerAsciiString::IsBound1(), and myMapIntegerAsciiString.

exotkParameter_Enumeration::EnumInit ( )

Initialize the enumeration iterator.

Definition at line 273 of file exotkParameter_Enumeration.cxx.
References exotkParameter_DoubleMapIteratorOfDoubleMapIntegerAsciiString::Initialize(), myMapIntegerAsciiString, and myMapIterator.

exotkParameter_Enumeration::EnumMore ( )

iterator.

Returns:
Standard_Boolean

Definition at line 285 of file exotkParameter_Enumeration.cxx.
References myMapIterator.

exotkParameter_Enumeration::EnumNext ( )

iterator.

Definition at line 297 of file exotkParameter_Enumeration.cxx.
References myMapIterator.

exotkParameter_Enumeration::ParameterAsString ( ) const [virtual]

Return the parameter value as string.

Returns:
TCollection_AsciiString

Reimplemented from exotkParameter_Root.
Definition at line 190 of file exotkParameter_Enumeration.cxx.
References exotkParameter_DoubleMapIntegerAsciiString::Find1(), exotkParameter_DoubleMapIntegerAsciiString::IsBound1(), myMapIntegerAsciiString, and myValue.

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

Set the parameter with a string input.

Returns:
Standard_Boolean : return false if aParameter is outside the limits
Parameters:

aParameter const TCollection_AsciiString& : the parameter to set

Reimplemented from exotkParameter_Root.
Definition at line 153 of file exotkParameter_Enumeration.cxx.
References exotkUtils::AsciiStringToInteger(), exotkParameter_DoubleMapIteratorOfDoubleMapIntegerAsciiString::Initialize(), exotkParameter_DoubleMapIteratorOfDoubleMapIntegerAsciiString::Key1(), exotkParameter_DoubleMapIteratorOfDoubleMapIntegerAsciiString::Key2(), myMapIntegerAsciiString, and SetValue().

exotkParameter_Enumeration::SetValue ( const Standard_Integer aValue )

Set the parameter value to aValue.

Returns:
Standard_Boolean : return Standard_False if the value is outside the limits
Parameters:

aValue const Standard_Integer : the enumeration member

Definition at line 121 of file exotkParameter_Enumeration.cxx.
References exotkParameter_DoubleMapIntegerAsciiString::IsBound1(), myMapIntegerAsciiString, and myValue.
Referenced by SetParameterAsString().

exotkParameter_Enumeration::Value ( ) const

Return the parameter.

Returns:
Standard_Integer

Definition at line 140 of file exotkParameter_Enumeration.cxx.
References myValue.

Member Data Documentation

exotkParameter_DoubleMapIntegerAsciiString exotkParameter_Enumeration::myMapIntegerAsciiString [private]

the possible enumeration members
Definition at line 173 of file exotkParameter_Enumeration.hxx.
Referenced by AddEnumerationMember(), DeepCopy(), Dump(), EnumerationMember(), EnumInit(), ParameterAsString(), SetParameterAsString(), and SetValue().

exotkParameter_DoubleMapIteratorOfDoubleMapIntegerAsciiString exotkParameter_Enumeration::myMapIterator [private]

the iterator for the enumeration members
Definition at line 175 of file exotkParameter_Enumeration.hxx.
Referenced by EnumCurrentIndex(), EnumCurrentName(), EnumInit(), EnumMore(), and EnumNext().

Standard_Integer exotkParameter_Enumeration::myValue [private]

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

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

Generated on Wed Jan 23 12:18:34 2002 for exotk by

exotkParameter_Enumeration Class Reference

Public Methods

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation