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:

Public Member Functions
	StepData_SelectMember ()
virtual bool	HasName () const
	Tells if a SelectMember has a name. Default is False.
virtual const char *	Name () const
	Returns the name of a SelectMember. Default is empty.
virtual bool	SetName (const char *const name)
	Sets the name of a SelectMember, returns True if done, False if no name is allowed Default does nothing and returns False.
virtual bool	Matches (const char *const name) const
	Tells if the name of a SelectMember matches a given one By default, compares the strings, can be redefined (optimised)
virtual int	Kind () const
virtual void	SetKind (const int kind)
Interface_ParamType	ParamType () const
	Returns the Kind of the SelectMember, under the form of an enum ParamType.
virtual int	Int () const
	This internal method gives access to a value implemented by an Integer (to read it)
virtual void	SetInt (const int val)
	This internal method gives access to a value implemented by an Integer (to set it)
int	Integer () const
	Gets the value as an Integer.
void	SetInteger (const int val)
bool	Boolean () const
void	SetBoolean (const bool val)
StepData_Logical	Logical () const
void	SetLogical (const StepData_Logical val)
virtual double	Real () const
virtual void	SetReal (const double val)
virtual const char *	String () const
virtual void	SetString (const char *const val)
int	Enum () const
virtual const char *	EnumText () const
void	SetEnum (const int val, const char *const text="")
virtual void	SetEnumText (const int val, const char *const text)
Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.
	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.
Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.
virtual	~Standard_Transient ()=default
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
bool	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.
bool	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.
bool	IsKind (const char *const 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.
Standard_Transient *	This () 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.
int	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
virtual void	Delete () const
	Memory deallocator for transient classes.

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

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::StepData_SelectMember

(

)

Member Function Documentation

Boolean()

bool StepData_SelectMember::Boolean

(

)

const

Enum()

int StepData_SelectMember::Enum

(

)

const

EnumText()

virtual const char * StepData_SelectMember::EnumText ( ) const

virtual

Reimplemented in StepDimTol_SimpleDatumReferenceModifierMember, StepVisual_MarkerMember, and StepVisual_NullStyleMember.

HasName()

virtual bool StepData_SelectMember::HasName ( ) const

virtual

Tells if a SelectMember has a name. Default is False.

Reimplemented in StepBasic_MeasureValueMember, StepBasic_SizeMember, StepData_SelectNamed, StepDimTol_SimpleDatumReferenceModifierMember, StepElement_CurveElementFreedomMember, StepElement_CurveElementPurposeMember, StepElement_ElementAspectMember, StepElement_MeasureOrUnspecifiedValueMember, StepElement_SurfaceElementPurposeMember, StepElement_VolumeElementPurposeMember, StepFEA_DegreeOfFreedomMember, StepFEA_SymmetricTensor23dMember, StepFEA_SymmetricTensor43dMember, StepGeom_TrimmingMember, StepVisual_MarkerMember, and StepVisual_NullStyleMember.

Int()

virtual int StepData_SelectMember::Int ( ) const

virtual

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

Reimplemented in StepData_SelectInt, and StepData_SelectNamed.

Integer()

int StepData_SelectMember::Integer

(

)

const

Gets the value as an Integer.

Kind()

virtual int StepData_SelectMember::Kind ( ) const

virtual

Reimplemented in StepData_SelectArrReal, StepData_SelectInt, StepData_SelectNamed, StepData_SelectReal, StepDimTol_SimpleDatumReferenceModifierMember, and StepVisual_NullStyleMember.

Logical()

StepData_Logical StepData_SelectMember::Logical

(

)

const

Matches()

virtual bool StepData_SelectMember::Matches ( const char *const name ) const

virtual

Tells if the name of a SelectMember matches a given one By default, compares the strings, can be redefined (optimised)

Reimplemented in StepElement_CurveElementFreedomMember, StepElement_CurveElementPurposeMember, StepElement_ElementAspectMember, StepElement_MeasureOrUnspecifiedValueMember, StepElement_SurfaceElementPurposeMember, StepElement_VolumeElementPurposeMember, StepFEA_DegreeOfFreedomMember, StepFEA_SymmetricTensor23dMember, and StepFEA_SymmetricTensor43dMember.

Name()

virtual const char * StepData_SelectMember::Name ( ) const

virtual

Returns the name of a SelectMember. Default is empty.

Reimplemented in StepBasic_MeasureValueMember, StepBasic_SizeMember, StepData_SelectNamed, StepDimTol_SimpleDatumReferenceModifierMember, StepElement_CurveElementFreedomMember, StepElement_CurveElementPurposeMember, StepElement_ElementAspectMember, StepElement_MeasureOrUnspecifiedValueMember, StepElement_SurfaceElementPurposeMember, StepElement_VolumeElementPurposeMember, StepFEA_DegreeOfFreedomMember, StepFEA_SymmetricTensor23dMember, StepFEA_SymmetricTensor43dMember, StepGeom_TrimmingMember, StepVisual_MarkerMember, and StepVisual_NullStyleMember.

ParamType()

Interface_ParamType StepData_SelectMember::ParamType

(

)

const

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

Real()

virtual double StepData_SelectMember::Real ( ) const

virtual

Reimplemented in StepData_SelectNamed, and StepData_SelectReal.

SetBoolean()

void StepData_SelectMember::SetBoolean

(

const bool

val

)

SetEnum()

void StepData_SelectMember::SetEnum	(	const int	val,
		const char *const	text = "" )

SetEnumText()

virtual void StepData_SelectMember::SetEnumText ( const int val, const char *const text )

virtual

Reimplemented in StepDimTol_SimpleDatumReferenceModifierMember, StepVisual_NullStyleMember, and StepVisual_MarkerMember.

SetInt()

virtual void StepData_SelectMember::SetInt ( const int val )

virtual

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

Reimplemented in StepData_SelectInt, and StepData_SelectNamed.

SetInteger()

void StepData_SelectMember::SetInteger

(

const int

val

)

SetKind()

virtual void StepData_SelectMember::SetKind ( const int kind )

virtual

Reimplemented in StepData_SelectInt, and StepData_SelectNamed.

SetLogical()

void StepData_SelectMember::SetLogical

(

const StepData_Logical

val

)

SetName()

virtual bool StepData_SelectMember::SetName ( const char *const name )

virtual

Sets the name of a SelectMember, returns True if done, False if no name is allowed Default does nothing and returns False.

Reimplemented in StepBasic_MeasureValueMember, StepBasic_SizeMember, StepData_SelectNamed, StepElement_CurveElementFreedomMember, StepElement_CurveElementPurposeMember, StepElement_ElementAspectMember, StepElement_MeasureOrUnspecifiedValueMember, StepElement_SurfaceElementPurposeMember, StepElement_VolumeElementPurposeMember, StepFEA_DegreeOfFreedomMember, StepFEA_SymmetricTensor23dMember, StepFEA_SymmetricTensor43dMember, StepGeom_TrimmingMember, StepVisual_MarkerMember, StepDimTol_SimpleDatumReferenceModifierMember, and StepVisual_NullStyleMember.

SetReal()

virtual void StepData_SelectMember::SetReal ( const double val )

virtual

Reimplemented in StepData_SelectNamed, and StepData_SelectReal.

SetString()

virtual void StepData_SelectMember::SetString ( const char *const val )

virtual

Reimplemented in StepData_SelectNamed.

String()

virtual const char * StepData_SelectMember::String ( ) const

virtual

Reimplemented in StepData_SelectNamed.

---

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

• StepData_SelectMember.hxx