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

exotkParameter_Boolean Class Reference

Define Boolean parameter. More...

#include <exotkParameter_Boolean.hxx>

Inheritance diagram for exotkParameter_Boolean:

Inheritance graph
[legend]
Collaboration diagram for exotkParameter_Boolean:

Collaboration graph
[legend]
List of all members.

Public Methods

Standard_EXPORT exotkParameter_Boolean (const Standard_Boolean aValue)
 Constructor. More...

virtual Standard_EXPORT ~exotkParameter_Boolean ()
 Destructor. More...

virtual Standard_EXPORT void DeepCopy (const Handle_exotkParameter_Root &aParameterToCopy)
 copy all the fields of aParameterToCopy into this. More...

Standard_EXPORT void SetValue (const Standard_Boolean aValue)
 Set the parameter value to aValue. More...

Standard_EXPORT Standard_Boolean Value () const
 return the parameter value. More...

virtual Standard_EXPORT Standard_Boolean SetParameterAsString (const TCollection_AsciiString &aParameter)
 set the parameter as string if you enter "Standard_True" , "True" , the value is Standard_True if you enter "Standard_False" , "False" , the value is Standard_False else the parameter is not set the string is not case sensitive, it meens that if you write "TrUe" , the parameter is Standard_True. More...

virtual Standard_EXPORT TCollection_AsciiString ParameterAsString () const
 return the parameter as string. The string is either "true" or "false". More...


Private Attributes

Standard_Boolean myValue

Detailed Description

Define Boolean parameter.

Author:
Stephane Routelous

Definition at line 44 of file exotkParameter_Boolean.hxx.


Constructor & Destructor Documentation

exotkParameter_Boolean::exotkParameter_Boolean const Standard_Boolean    aValue
 

Constructor.

Parameters:
aValue  const Standard_Boolean

Definition at line 65 of file exotkParameter_Boolean.cxx.

References exotkParameter_Type_Boolean, and exotkParameter_Root::myType.

exotkParameter_Boolean::~exotkParameter_Boolean   [virtual]
 

Destructor.

Definition at line 79 of file exotkParameter_Boolean.cxx.


Member Function Documentation

exotkParameter_Boolean::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 93 of file exotkParameter_Boolean.cxx.

References exotkParameter_Root::DeepCopy(), myValue, and STANDARD_TYPE().

exotkParameter_Boolean::ParameterAsString   const [virtual]
 

return the parameter as string. The string is either "true" or "false".

Returns:
TCollection_AsciiString

Reimplemented from exotkParameter_Root.

Definition at line 160 of file exotkParameter_Boolean.cxx.

exotkParameter_Boolean::SetParameterAsString const TCollection_AsciiString &    aParameter [virtual]
 

set the parameter as string if you enter "Standard_True" , "True" , the value is Standard_True if you enter "Standard_False" , "False" , the value is Standard_False else the parameter is not set the string is not case sensitive, it meens that if you write "TrUe" , the parameter is Standard_True.

Returns:
Standard_Boolean : true if the parameter is set
Parameters:
aParameter  const TCollection_AsciiString&

Reimplemented from exotkParameter_Root.

Definition at line 136 of file exotkParameter_Boolean.cxx.

References myValue.

exotkParameter_Boolean::SetValue const Standard_Boolean    aValue
 

Set the parameter value to aValue.

Parameters:
aValue  const Standard_Boolean

Definition at line 111 of file exotkParameter_Boolean.cxx.

References myValue.

exotkParameter_Boolean::Value   const
 

return the parameter value.

Returns:
Standard_Boolean

Definition at line 123 of file exotkParameter_Boolean.cxx.

References myValue.


Member Data Documentation

Standard_Boolean exotkParameter_Boolean::myValue [private]
 

the parameter value

Definition at line 107 of file exotkParameter_Boolean.hxx.

Referenced by DeepCopy(), SetParameterAsString(), 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 doxygen1.2.12 written by Dimitri van Heesch, © 1997-2001