Open CASCADE Technology  7.1.0.beta
Public Member Functions
StepData_SelectMember Class Reference

The general form for a Select Member. A Select Member can, either define a value of a basic type (such as an integer) with an additional information : a name or list of names which precise the meaning of this value or be an alternate value in a select, which also accepts an entity (in this case, the name is not mandatory) More...

#include <StepData_SelectMember.hxx>

Inheritance diagram for StepData_SelectMember:
Inheritance graph
[legend]

Public Member Functions

 StepData_SelectMember ()
 
virtual Standard_Boolean HasName () const
 Tells if a SelectMember has a name. Default is False. More...
 
virtual Standard_CString Name () const
 Returns the name of a SelectMember. Default is empty. More...
 
virtual Standard_Boolean SetName (const Standard_CString name)
 Sets the name of a SelectMember, returns True if done, False if no name is allowed Default does nothing and returns False. More...
 
virtual Standard_Boolean Matches (const Standard_CString name) const
 Tells if the name of a SelectMember matches a given one By default, compares the strings, can be redefined (optimised) More...
 
virtual Standard_Integer Kind () const
 
virtual void SetKind (const Standard_Integer kind)
 
Interface_ParamType ParamType () const
 Returns the Kind of the SelectMember, under the form of an enum ParamType. More...
 
virtual Standard_Integer Int () const
 This internal method gives access to a value implemented by an Integer (to read it) More...
 
virtual void SetInt (const Standard_Integer val)
 This internal method gives access to a value implemented by an Integer (to set it) More...
 
Standard_Integer Integer () const
 Gets the value as an Integer. More...
 
void SetInteger (const Standard_Integer val)
 
Standard_Boolean Boolean () const
 
void SetBoolean (const Standard_Boolean val)
 
StepData_Logical Logical () const
 
void SetLogical (const StepData_Logical val)
 
virtual Standard_Real Real () const
 
virtual void SetReal (const Standard_Real val)
 
virtual Standard_CString String () const
 
virtual void SetString (const Standard_CString val)
 
Standard_Integer Enum () const
 
virtual Standard_CString EnumText () const
 
void SetEnum (const Standard_Integer val, const Standard_CString text="")
 
virtual void SetEnumText (const Standard_Integer val, const Standard_CString text)
 
- Public Member Functions inherited from MMgt_TShared
virtual void Delete () const override
 Memory deallocator for transient classes. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean IsKind (const opencascade::handle< Standard_Type > &theType) const
 Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_Boolean IsKind (const Standard_CString theTypeName) const
 Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_TransientThis () const
 Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 

Detailed Description

The general form for a Select Member. A Select Member can, either define a value of a basic type (such as an integer) with an additional information : a name or list of names which precise the meaning of this value or be an alternate value in a select, which also accepts an entity (in this case, the name is not mandatory)

Several sub-types of SelectMember are defined for integer and real value, plus an "universal" one for any, and one more to describe a select with several names

It is also possible to define a specific subtype by redefining virtual method, then give a better control

Remark : this class itself could be deferred, because at least one of its virtual methods must be redefined to be usable

Constructor & Destructor Documentation

StepData_SelectMember::StepData_SelectMember ( )

Member Function Documentation

Standard_Boolean StepData_SelectMember::Boolean ( ) const
Standard_Integer StepData_SelectMember::Enum ( ) const
virtual Standard_CString StepData_SelectMember::EnumText ( ) const
virtual
virtual Standard_Boolean StepData_SelectMember::HasName ( ) const
virtual
virtual Standard_Integer StepData_SelectMember::Int ( ) const
virtual

This internal method gives access to a value implemented by an Integer (to read it)

Reimplemented in StepData_SelectNamed, and StepData_SelectInt.

Standard_Integer StepData_SelectMember::Integer ( ) const

Gets the value as an Integer.

virtual Standard_Integer StepData_SelectMember::Kind ( ) const
virtual
StepData_Logical StepData_SelectMember::Logical ( ) const
virtual Standard_Boolean StepData_SelectMember::Matches ( const Standard_CString  name) const
virtual
virtual Standard_CString StepData_SelectMember::Name ( ) const
virtual
Interface_ParamType StepData_SelectMember::ParamType ( ) const

Returns the Kind of the SelectMember, under the form of an enum ParamType.

virtual Standard_Real StepData_SelectMember::Real ( ) const
virtual

Reimplemented in StepData_SelectNamed, and StepData_SelectReal.

void StepData_SelectMember::SetBoolean ( const Standard_Boolean  val)
void StepData_SelectMember::SetEnum ( const Standard_Integer  val,
const Standard_CString  text = "" 
)
virtual void StepData_SelectMember::SetEnumText ( const Standard_Integer  val,
const Standard_CString  text 
)
virtual
virtual void StepData_SelectMember::SetInt ( const Standard_Integer  val)
virtual

This internal method gives access to a value implemented by an Integer (to set it)

Reimplemented in StepData_SelectNamed, and StepData_SelectInt.

void StepData_SelectMember::SetInteger ( const Standard_Integer  val)
virtual void StepData_SelectMember::SetKind ( const Standard_Integer  kind)
virtual

Reimplemented in StepData_SelectNamed, and StepData_SelectInt.

void StepData_SelectMember::SetLogical ( const StepData_Logical  val)
virtual Standard_Boolean StepData_SelectMember::SetName ( const Standard_CString  name)
virtual
virtual void StepData_SelectMember::SetReal ( const Standard_Real  val)
virtual

Reimplemented in StepData_SelectNamed, and StepData_SelectReal.

virtual void StepData_SelectMember::SetString ( const Standard_CString  val)
virtual

Reimplemented in StepData_SelectNamed.

virtual Standard_CString StepData_SelectMember::String ( ) const
virtual

Reimplemented in StepData_SelectNamed.


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