SelectType is the basis used for SELECT_TYPE definitions from
the EXPRESS form. A SELECT_TYPE in EXPRESS is an enumeration
of Types, it corresponds in a way to a Super-Type, but with
no specific Methods, and no exclusivity (a given Type can be
member of several SELECT_TYPES, plus be itself a SUB_TYPE).

A SelectType can be field of a Transient Entity (it is itself
Storable) or only used to control an input Argument

This class implies to designate each member Type by a Case
Number which is a positive Integer value (this allows a faster
treatement).

With this class, a specific SelectType can :
More...

#include <StepData_SelectType.hxx>

Inheritance diagram for StepData_SelectType:

[legend]

Public Member Functions
virtual Standard_Integer	CaseNum (const Handle< Standard_Transient > &ent) const =0
	Recognizes the Type of an Entity. Returns a positive Number which identifies the Type in the definition List of the SelectType. Returns Zero if its Type in not in this List. More...

Standard_Boolean	Matches (const Handle< Standard_Transient > &ent) const
	Returns True if the Type of an Entity complies with the definition list of the SelectType. Also checks for a SelectMember Default Implementation looks for CaseNum or CaseMem positive More...

void	SetValue (const Handle< Standard_Transient > &ent)
	Stores an Entity. This allows to define a specific SelectType class with one read method per member Type, which returns the Value casted with the good Type. More...

void	Nullify ()
	Nullifies the Stored Entity More...

const Handle_Standard_Transient &	Value () const
	Returns the Stored Entity. Can be used to define specific read methods (see above) More...

Standard_Boolean	IsNull () const
	Returns True if there is no Stored Entity (i.e. it is Null) More...

Handle_Standard_Type	Type () const
	Returns the Effective (Dynamic) Type of the Stored Entity If it is Null, returns TYPE(Transient) More...

Standard_Integer	CaseNumber () const
	Recognizes the Type of the stored Entity, or zero if it is Null or SelectMember. Calls the first method CaseNum on Value More...

virtual Handle_StepData_PDescr	Description () const
	Returns the Description which corresponds to <me> Null if no specific description to give. This description is used to control reading an check validity. Default returns a Null Handle, i.e. undefined description It can suffice if CaseNum and CaseMem give enough control More...

virtual Handle_StepData_SelectMember	NewMember () const
	Returns a preferred SelectMember. Default returns a Null <br> By default, a SelectMember can be set according to data type <br> and Name : it is a SelectNamed if Name is defined <br> This method allows to define, for a specific SelectType, a specific SelectMember than SelectNamed. For instance for a Real plus a Name, a SelectReal plus a case number is a good solution, lighter than SelectNamed which is very multipurpose More...

virtual Standard_Integer	CaseMem (const Handle< StepData_SelectMember > &ent) const
	Recognize a SelectMember (kind, name). Returns a positive value which identifies the case in the List of immediate cases (distinct from the List of Entity Types). Zero if not recognizes Default returns 0, saying that no immediate value is allowed More...

Standard_Integer	CaseMember () const
	Returns the Type of the stored SelectMember, or zero if it is Null or Entity. Calls the method CaseMem on Value More...

Handle_StepData_SelectMember	Member () const
	Returns Value as a SelectMember. Null if not a SelectMember More...

Standard_CString	SelectName () const
	Returns the type name of SelectMember. If no SelectMember or with no type name, returns an empty string To change it, pass through the SelectMember itself More...

Standard_Integer	Int () const
	This internal method gives access to a value implemented by an Integer (to read it) More...

void	SetInt (const Standard_Integer val)
	This internal method gives access to a value implemented by an Integer (to set it) : a SelectMember MUST ALREADY BE THERE ! More...

Standard_Integer	Integer () const
	Gets the value as an Integer More...

void	SetInteger (const Standard_Integer val, const Standard_CString name="")
	Sets a new Integer value, with an optional type name <br> Warning : If a SelectMember is already set, works on it : value and name must then be accepted by this SelectMember More...

Standard_Boolean	Boolean () const

void	SetBoolean (const Standard_Boolean val, const Standard_CString name="")

StepData_Logical	Logical () const

void	SetLogical (const StepData_Logical val, const Standard_CString name="")

Standard_Real	Real () const

void	SetReal (const Standard_Real val, const Standard_CString name="")

virtual void	Destroy ()

virtual	~StepData_SelectType ()

Detailed Description

SelectType is the basis used for SELECT_TYPE definitions from
the EXPRESS form. A SELECT_TYPE in EXPRESS is an enumeration
of Types, it corresponds in a way to a Super-Type, but with
no specific Methods, and no exclusivity (a given Type can be
member of several SELECT_TYPES, plus be itself a SUB_TYPE).

A SelectType can be field of a Transient Entity (it is itself
Storable) or only used to control an input Argument

This class implies to designate each member Type by a Case
Number which is a positive Integer value (this allows a faster
treatement).

With this class, a specific SelectType can :

recognize an Entity as complying or not with its definition,
storing it, with the garanty that the stored Entity complies
with the definition of the SelectType
and (if judged useful) give the stored Entity under the good
Type rather than simply "Transient".

Constructor & Destructor Documentation

virtual StepData_SelectType::~StepData_SelectType ( )

inlinevirtual

Member Function Documentation

Standard_Boolean StepData_SelectType::Boolean ( ) const

virtual Standard_Integer StepData_SelectType::CaseMem ( const Handle< StepData_SelectMember > & ent ) const

virtual

Recognize a SelectMember (kind, name). Returns a positive
value which identifies the case in the List of immediate cases
(distinct from the List of Entity Types). Zero if not
recognizes
Default returns 0, saying that no immediate value is allowed

Reimplemented in StepElement_ElementAspect, StepGeom_TrimmingSelect, StepFEA_SymmetricTensor23d, StepElement_CurveElementFreedom, StepElement_CurveElementPurpose, StepElement_SurfaceElementPurpose, StepElement_VolumeElementPurpose, StepFEA_DegreeOfFreedom, StepFEA_SymmetricTensor43d, StepElement_MeasureOrUnspecifiedValue, StepBasic_SizeSelect, and StepVisual_MarkerSelect.

Standard_Integer StepData_SelectType::CaseMember ( ) const

Returns the Type of the stored SelectMember, or zero if it is
Null or Entity. Calls the method CaseMem on Value

virtual Standard_Integer StepData_SelectType::CaseNum ( const Handle< Standard_Transient > & ent ) const

pure virtual

Recognizes the Type of an Entity. Returns a positive Number
which identifies the Type in the definition List of the
SelectType. Returns Zero if its Type in not in this List.

Implemented in StepAP214_AutoDesignReferencingItem, StepAP214_ApprovalItem, StepBasic_RoleSelect, StepAP214_AutoDesignGroupedItem, StepAP203_ApprovedItem, StepAP203_PersonOrganizationItem, StepAP214_AutoDesignDateAndPersonItem, StepAP203_DateTimeItem, StepAP214_AutoDesignGeneralOrgItem, StepRepr_CharacterizedDefinition, StepAP214_DocumentReferenceItem, StepAP214_DateAndTimeItem, StepAP214_DateItem, StepShape_CsgPrimitive, StepShape_ReversibleTopologyItem, StepAP214_AutoDesignPresentedItemSelect, StepRepr_RepresentedDefinition, StepAP214_ExternalIdentificationItem, StepVisual_PresentationStyleSelect, StepVisual_SurfaceStyleElementSelect, StepAP214_PersonAndOrganizationItem, StepBasic_DateTimeSelect, StepBasic_PersonOrganizationSelect, StepBasic_ProductOrFormationOrDefinition, StepRepr_ShapeDefinition, StepGeom_CurveOnSurface, StepShape_GeometricSetSelect, StepVisual_CurveStyleFontSelect, StepVisual_InvisibleItem, StepVisual_PresentationSizeAssignmentSelect, StepVisual_StyleContextSelect, StepVisual_TextOrCharacter, StepFEA_CurveElementEndCoordinateSystem, StepAP214_AutoDesignDateAndTimeItem, StepAP214_AutoDesignDatedItem, StepGeom_TrimmingSelect, StepElement_CurveElementFreedom, StepElement_CurveElementPurpose, StepElement_SurfaceElementPurpose, StepElement_VolumeElementPurpose, StepFEA_DegreeOfFreedom, StepFEA_SymmetricTensor23d, StepRepr_ConfigurationDesignItem, StepRepr_Transformation, StepGeom_Axis2Placement, StepGeom_PcurveOrSurface, StepGeom_SurfaceBoundary, StepGeom_VectorOrDirection, StepShape_DimensionalCharacteristic, StepShape_Shell, StepShape_ValueQualifier, StepVisual_AreaOrView, StepVisual_FontSelect, StepVisual_InvisibilityContext, StepVisual_LayeredItem, StepVisual_PresentationRepresentationSelect, StepDimTol_ShapeToleranceSelect, StepElement_ElementAspect, StepElement_MeasureOrUnspecifiedValue, StepFEA_ElementOrElementGroup, StepAP214_PresentedItemSelect, StepAP203_ClassifiedItem, StepAP203_SpecifiedItem, StepBasic_SourceItem, StepBasic_Unit, StepShape_ToleranceMethodDefinition, StepVisual_FillStyleSelect, StepBasic_SizeSelect, StepVisual_MarkerSelect, StepFEA_SymmetricTensor43d, StepAP214_AutoDesignOrganizationItem, StepAP214_OrganizationItem, StepShape_SurfaceModel, StepFEA_SymmetricTensor22d, StepFEA_SymmetricTensor42d, StepAP214_GroupItem, StepAP203_CertifiedItem, StepAP203_ChangeRequestItem, StepAP203_ContractedItem, StepAP203_StartRequestItem, and StepAP203_WorkItem.

Standard_Integer StepData_SelectType::CaseNumber ( ) const

Recognizes the Type of the stored Entity, or zero if it is
Null or SelectMember. Calls the first method CaseNum on Value

virtual Handle_StepData_PDescr StepData_SelectType::Description ( ) const

virtual

Returns the Description which corresponds to <me>
Null if no specific description to give. This description is
used to control reading an check validity.
Default returns a Null Handle, i.e. undefined description
It can suffice if CaseNum and CaseMem give enough control

virtual void StepData_SelectType::Destroy ( )

virtual

Standard_Integer StepData_SelectType::Int ( ) const

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

Standard_Integer StepData_SelectType::Integer ( ) const

Gets the value as an Integer

Standard_Boolean StepData_SelectType::IsNull ( ) const

Returns True if there is no Stored Entity (i.e. it is Null)

StepData_Logical StepData_SelectType::Logical ( ) const

Standard_Boolean StepData_SelectType::Matches ( const Handle< Standard_Transient > & ent ) const

Returns True if the Type of an Entity complies with the
definition list of the SelectType.
Also checks for a SelectMember
Default Implementation looks for CaseNum or CaseMem positive

Handle_StepData_SelectMember StepData_SelectType::Member ( ) const

Returns Value as a SelectMember. Null if not a SelectMember

virtual Handle_StepData_SelectMember StepData_SelectType::NewMember ( ) const

virtual

 Returns a preferred SelectMember. Default returns a Null <br>
      By default, a SelectMember can be set according to data type <br>
      and Name : it is a SelectNamed if Name is defined <br>

This method allows to define, for a specific SelectType, a
specific SelectMember than SelectNamed. For instance for a
Real plus a Name, a SelectReal plus a case number is a good
solution, lighter than SelectNamed which is very multipurpose

Reimplemented in StepElement_ElementAspect, StepFEA_SymmetricTensor23d, StepElement_CurveElementFreedom, StepElement_CurveElementPurpose, StepElement_SurfaceElementPurpose, StepElement_VolumeElementPurpose, StepFEA_DegreeOfFreedom, StepFEA_SymmetricTensor43d, StepElement_MeasureOrUnspecifiedValue, StepGeom_TrimmingSelect, StepBasic_SourceItem, StepBasic_SizeSelect, and StepVisual_MarkerSelect.

void StepData_SelectType::Nullify ( )

Nullifies the Stored Entity

Standard_Real StepData_SelectType::Real ( ) const

Standard_CString StepData_SelectType::SelectName ( ) const

Returns the type name of SelectMember. If no SelectMember or
with no type name, returns an empty string
To change it, pass through the SelectMember itself

void StepData_SelectType::SetBoolean	(	const Standard_Boolean	val,
		const Standard_CString	name = `""`
	)

void StepData_SelectType::SetInt ( const Standard_Integer val )

This internal method gives access to a value implemented by an
Integer (to set it) : a SelectMember MUST ALREADY BE THERE !

void StepData_SelectType::SetInteger	(	const Standard_Integer	val,
		const Standard_CString	name = `""`
	)

Sets a new Integer value, with an optional type name <br>

Warning : If a SelectMember is already set, works on it : value and
name must then be accepted by this SelectMember

void StepData_SelectType::SetLogical	(	const StepData_Logical	val,
		const Standard_CString	name = `""`
	)

void StepData_SelectType::SetReal	(	const Standard_Real	val,
		const Standard_CString	name = `""`
	)

void StepData_SelectType::SetValue ( const Handle< Standard_Transient > & ent )

Stores an Entity. This allows to define a specific SelectType
class with one read method per member Type, which returns the
Value casted with the good Type.

Handle_Standard_Type StepData_SelectType::Type ( ) const

Returns the Effective (Dynamic) Type of the Stored Entity
If it is Null, returns TYPE(Transient)

const Handle_Standard_Transient& StepData_SelectType::Value ( ) const

Returns the Stored Entity. Can be used to define specific
read methods (see above)

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

StepData_SelectType.hxx

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation