OCC Main Page | DataExchange | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

DataExchange
TKXSBase
StepData


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)

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
.

#include <StepData_SelectMember.hxx>

Inheritance diagram for StepData_SelectMember:

Inheritance graph
[legend]

Public Member Functions

Standard_EXPORT StepData_SelectMember ()
virtual Standard_EXPORT Standard_Boolean HasName () const
 Tells if a SelectMember has a name. Default is False
.
virtual Standard_EXPORT Standard_CString Name () const
 Returns the name of a SelectMember. Default is empty
.
virtual Standard_EXPORT 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
.
virtual Standard_EXPORT 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)
.
virtual Standard_EXPORT Standard_Integer Kind () const
virtual Standard_EXPORT void SetKind (const Standard_Integer kind)
Standard_EXPORT Interface_ParamType ParamType () const
 Returns the Kind of the SelectMember, under the form of an
enum ParamType
.
virtual Standard_EXPORT Standard_Integer Int () const
 This internal method gives access to a value implemented by an
Integer (to read it)
.
virtual Standard_EXPORT void SetInt (const Standard_Integer val)
 This internal method gives access to a value implemented by an
Integer (to set it)
.
Standard_EXPORT Standard_Integer Integer () const
 Gets the value as an Integer
.
Standard_EXPORT void SetInteger (const Standard_Integer val)
Standard_EXPORT Standard_Boolean Boolean () const
Standard_EXPORT void SetBoolean (const Standard_Boolean val)
Standard_EXPORT StepData_Logical Logical () const
Standard_EXPORT void SetLogical (const StepData_Logical val)
virtual Standard_EXPORT Standard_Real Real () const
virtual Standard_EXPORT void SetReal (const Standard_Real val)
virtual Standard_EXPORT Standard_CString String () const
virtual Standard_EXPORT void SetString (const Standard_CString val)
Standard_EXPORT Standard_Integer Enum () const
virtual Standard_EXPORT Standard_CString EnumText () const
Standard_EXPORT void SetEnum (const Standard_Integer val, const Standard_CString text="")
virtual Standard_EXPORT void SetEnumText (const Standard_Integer val, const Standard_CString text)
Standard_EXPORT const Handle (Standard_Type)&DynamicType() const

Constructor & Destructor Documentation

Standard_EXPORT StepData_SelectMember::StepData_SelectMember  ) 
 


Member Function Documentation

Standard_EXPORT Standard_Boolean StepData_SelectMember::Boolean  )  const
 

Standard_EXPORT Standard_Integer StepData_SelectMember::Enum  )  const
 

virtual Standard_EXPORT Standard_CString StepData_SelectMember::EnumText  )  const [virtual]
 

Reimplemented in StepVisual_MarkerMember.

Standard_EXPORT const StepData_SelectMember::Handle Standard_Type   )  const
 

Reimplemented in StepBasic_MeasureValueMember, StepBasic_SizeMember, StepData_SelectArrReal, StepData_SelectInt, StepData_SelectNamed, StepData_SelectReal, StepElement_CurveElementFreedomMember, StepElement_CurveElementPurposeMember, StepElement_ElementAspectMember, StepElement_MeasureOrUnspecifiedValueMember, StepElement_SurfaceElementPurposeMember, StepElement_VolumeElementPurposeMember, StepFEA_DegreeOfFreedomMember, StepFEA_SymmetricTensor23dMember, StepFEA_SymmetricTensor43dMember, StepGeom_TrimmingMember, and StepVisual_MarkerMember.

virtual Standard_EXPORT Standard_Boolean StepData_SelectMember::HasName  )  const [virtual]
 

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, and StepVisual_MarkerMember.

virtual Standard_EXPORT Standard_Integer StepData_SelectMember::Int  )  const [virtual]
 

Reimplemented in StepData_SelectInt, and StepData_SelectNamed.

Standard_EXPORT Standard_Integer StepData_SelectMember::Integer  )  const
 

virtual Standard_EXPORT Standard_Integer StepData_SelectMember::Kind  )  const [virtual]
 

Reimplemented in StepData_SelectArrReal, StepData_SelectInt, StepData_SelectNamed, and StepData_SelectReal.

Standard_EXPORT StepData_Logical StepData_SelectMember::Logical  )  const
 

virtual Standard_EXPORT Standard_Boolean StepData_SelectMember::Matches const Standard_CString  name  )  const [virtual]
 

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

virtual Standard_EXPORT Standard_CString StepData_SelectMember::Name  )  const [virtual]
 

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, and StepVisual_MarkerMember.

Standard_EXPORT Interface_ParamType StepData_SelectMember::ParamType  )  const
 

virtual Standard_EXPORT Standard_Real StepData_SelectMember::Real  )  const [virtual]
 

Reimplemented in StepData_SelectNamed, and StepData_SelectReal.

Standard_EXPORT void StepData_SelectMember::SetBoolean const Standard_Boolean  val  ) 
 

Standard_EXPORT void StepData_SelectMember::SetEnum const Standard_Integer  val,
const Standard_CString  text = ""
 

virtual Standard_EXPORT void StepData_SelectMember::SetEnumText const Standard_Integer  val,
const Standard_CString  text
[virtual]
 

Reimplemented in StepVisual_MarkerMember.

virtual Standard_EXPORT void StepData_SelectMember::SetInt const Standard_Integer  val  )  [virtual]
 

Reimplemented in StepData_SelectInt, and StepData_SelectNamed.

Standard_EXPORT void StepData_SelectMember::SetInteger const Standard_Integer  val  ) 
 

virtual Standard_EXPORT void StepData_SelectMember::SetKind const Standard_Integer  kind  )  [virtual]
 

Reimplemented in StepData_SelectInt, and StepData_SelectNamed.

Standard_EXPORT void StepData_SelectMember::SetLogical const StepData_Logical  val  ) 
 

virtual Standard_EXPORT Standard_Boolean StepData_SelectMember::SetName const Standard_CString  name  )  [virtual]
 

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, and StepVisual_MarkerMember.

virtual Standard_EXPORT void StepData_SelectMember::SetReal const Standard_Real  val  )  [virtual]
 

Reimplemented in StepData_SelectNamed, and StepData_SelectReal.

virtual Standard_EXPORT void StepData_SelectMember::SetString const Standard_CString  val  )  [virtual]
 

Reimplemented in StepData_SelectNamed.

virtual Standard_EXPORT Standard_CString StepData_SelectMember::String  )  const [virtual]
 

Reimplemented in StepData_SelectNamed.


The documentation for this class was generated from the following file:
Generated on Mon Aug 25 14:43:11 2008 for OpenCASCADE by  doxygen 1.4.1