Open CASCADE Technology 7.8.2.dev
StepVisual_AnnotationPlaneElement Class Reference

#include <StepVisual_AnnotationPlaneElement.hxx>

Inheritance diagram for StepVisual_AnnotationPlaneElement:

Public Member Functions

 StepVisual_AnnotationPlaneElement ()
 Returns a AnnotationPlaneElement select type.
 
Standard_Integer CaseNum (const Handle< Standard_Transient > &ent) const
 Recognizes a IdAttributeSelect Kind Entity that is : 1 -> DraughtingCallout 2 -> StyledItem 0 else.
 
Handle< StepVisual_DraughtingCalloutDraughtingCallout () const
 returns Value as a DraughtingCallout (Null if another type)
 
Handle< StepVisual_StyledItemStyledItem () const
 returns Value as a StyledItem (Null if another type)
 
- Public Member Functions inherited from StepData_SelectType
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.
 
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.
 
void Nullify ()
 Nullifies the Stored Entity.
 
const Handle< Standard_Transient > & Value () const
 Returns the Stored Entity. Can be used to define specific read methods (see above)
 
Standard_Boolean IsNull () const
 Returns True if there is no Stored Entity (i.e. it is Null)
 
Handle< Standard_TypeType () const
 Returns the Effective (Dynamic) Type of the Stored Entity If it is Null, returns TYPE(Transient)
 
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.
 
virtual Handle< StepData_PDescrDescription () 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.
 
virtual Handle< StepData_SelectMemberNewMember () const
 Returns a preferred SelectMember. Default returns a Null By default, a SelectMember can be set according to data type and Name : it is a SelectNamed if Name is defined.
 
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.
 
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.
 
Handle< StepData_SelectMemberMember () const
 Returns Value as a SelectMember. Null if not a SelectMember.
 
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.
 
Standard_Integer Int () const
 This internal method gives access to a value implemented by an Integer (to read it)
 
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 !
 
Standard_Integer Integer () const
 Gets the value as an Integer.
 
void SetInteger (const Standard_Integer val, const Standard_CString name="")
 Sets a new Integer value, with an optional type name Warning : If a SelectMember is already set, works on it : value and name must then be accepted by this SelectMember.
 
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 ~StepData_SelectType ()
 

Constructor & Destructor Documentation

◆ StepVisual_AnnotationPlaneElement()

StepVisual_AnnotationPlaneElement::StepVisual_AnnotationPlaneElement ( )

Returns a AnnotationPlaneElement select type.

Member Function Documentation

◆ CaseNum()

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

Recognizes a IdAttributeSelect Kind Entity that is : 1 -> DraughtingCallout 2 -> StyledItem 0 else.

Implements StepData_SelectType.

◆ DraughtingCallout()

Handle< StepVisual_DraughtingCallout > StepVisual_AnnotationPlaneElement::DraughtingCallout ( ) const

returns Value as a DraughtingCallout (Null if another type)

◆ StyledItem()

Handle< StepVisual_StyledItem > StepVisual_AnnotationPlaneElement::StyledItem ( ) const

returns Value as a StyledItem (Null if another type)


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