Open CASCADE Technology  6.5.4
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Protected Member Functions
IGESData_IGESEntity Class Reference

defines root of IGES Entity definition, including Directory
Part, lists of (optionnal) Properties and Associativities

#include <IGESData_IGESEntity.hxx>

Inherits MMgt_TShared.

Inherited by IGESAppli_DrilledHole, IGESAppli_ElementResults, IGESAppli_FiniteElement, IGESAppli_Flow, IGESAppli_FlowLineSpec, IGESAppli_LevelFunction, IGESAppli_LevelToPWBLayerMap, IGESAppli_LineWidening, IGESAppli_NodalConstraint, IGESAppli_NodalDisplAndRot, IGESAppli_NodalResults, IGESAppli_Node, IGESAppli_PartNumber, IGESAppli_PinNumber, IGESAppli_PipingFlow, IGESAppli_PWBArtworkStackup, IGESAppli_PWBDrilledHole, IGESAppli_ReferenceDesignator, IGESAppli_RegionRestriction, IGESBasic_AssocGroupType, IGESBasic_ExternalReferenceFile, IGESBasic_ExternalRefFile, IGESBasic_ExternalRefFileIndex, IGESBasic_ExternalRefFileName, IGESBasic_ExternalRefLibName, IGESBasic_ExternalRefName, IGESBasic_Group, IGESBasic_Hierarchy, IGESBasic_SingularSubfigure, IGESBasic_SubfigureDef, IGESData_ColorEntity, IGESData_LabelDisplayEntity, IGESData_LevelListEntity, IGESData_LineFontEntity, IGESData_NameEntity, IGESData_SingleParentEntity, IGESData_TransfEntity, IGESData_UndefinedEntity, IGESData_ViewKindEntity, IGESDefs_AssociativityDef, IGESDefs_AttributeDef, IGESDefs_AttributeTable, IGESDefs_GenericData, IGESDefs_MacroDef, IGESDefs_TabularData, IGESDefs_UnitsData, IGESDimen_AngularDimension, IGESDimen_BasicDimension, IGESDimen_CenterLine, IGESDimen_CurveDimension, IGESDimen_DiameterDimension, IGESDimen_DimensionDisplayData, IGESDimen_DimensionedGeometry, IGESDimen_DimensionTolerance, IGESDimen_DimensionUnits, IGESDimen_FlagNote, IGESDimen_GeneralLabel, IGESDimen_GeneralNote, IGESDimen_GeneralSymbol, IGESDimen_LeaderArrow, IGESDimen_LinearDimension, IGESDimen_NewDimensionedGeometry, IGESDimen_NewGeneralNote, IGESDimen_OrdinateDimension, IGESDimen_PointDimension, IGESDimen_RadiusDimension, IGESDimen_Section, IGESDimen_SectionedArea, IGESDimen_WitnessLine, IGESDraw_CircArraySubfigure, IGESDraw_ConnectPoint, IGESDraw_Drawing, IGESDraw_DrawingWithRotation, IGESDraw_NetworkSubfigure, IGESDraw_NetworkSubfigureDef, IGESDraw_Planar, IGESDraw_RectArraySubfigure, IGESGeom_Boundary, IGESGeom_BoundedSurface, IGESGeom_BSplineCurve, IGESGeom_BSplineSurface, IGESGeom_CircularArc, IGESGeom_CompositeCurve, IGESGeom_ConicArc, IGESGeom_CopiousData, IGESGeom_CurveOnSurface, IGESGeom_Direction, IGESGeom_Flash, IGESGeom_Line, IGESGeom_OffsetCurve, IGESGeom_OffsetSurface, IGESGeom_Plane, IGESGeom_Point, IGESGeom_RuledSurface, IGESGeom_SplineCurve, IGESGeom_SplineSurface, IGESGeom_SurfaceOfRevolution, IGESGeom_TabulatedCylinder, IGESGeom_TrimmedSurface, IGESGraph_DrawingSize, IGESGraph_DrawingUnits, IGESGraph_HighLight, IGESGraph_IntercharacterSpacing, IGESGraph_LineFontPredefined, IGESGraph_NominalSize, IGESGraph_Pick, IGESGraph_TextDisplayTemplate, IGESGraph_TextFontDef, IGESGraph_UniformRectGrid, IGESSolid_Block, IGESSolid_BooleanTree, IGESSolid_ConeFrustum, IGESSolid_ConicalSurface, IGESSolid_Cylinder, IGESSolid_CylindricalSurface, IGESSolid_EdgeList, IGESSolid_Ellipsoid, IGESSolid_Face, IGESSolid_Loop, IGESSolid_ManifoldSolid, IGESSolid_PlaneSurface, IGESSolid_RightAngularWedge, IGESSolid_SelectedComponent, IGESSolid_Shell, IGESSolid_SolidAssembly, IGESSolid_SolidInstance, IGESSolid_SolidOfLinearExtrusion, IGESSolid_SolidOfRevolution, IGESSolid_Sphere, IGESSolid_SphericalSurface, IGESSolid_ToroidalSurface, IGESSolid_Torus, and IGESSolid_VertexList.

Public Member Functions

IGESData_IGESType IGESType () const
 gives IGES typing info (includes "Type" and "Form" data)

Standard_Integer TypeNumber () const
 gives IGES Type Number (often coupled with Form Number)

Standard_Integer FormNumber () const
 Returns the form number for that
type of an IGES entity. The default form number is 0.

Handle_IGESData_IGESEntity DirFieldEntity (const Standard_Integer fieldnum) const
 Returns the Entity which has been recorded for a given
Field Number, i.e. without any cast. Maps with :
3 : Structure 4 : LineFont 5 : LevelList 6 : View
7 : Transf(ormation Matrix) 8 : LabelDisplay
13 : Color. Other values give a null handle
It can then be of any kind, while specific items have a Type

Standard_Boolean HasStructure () const
 returns True if an IGESEntity is defined with a Structure
(it is normally reserved for certain classes, such as Macros)

Handle_IGESData_IGESEntity Structure () const
 Returns Structure (used by some types of IGES Entities only)
Returns a Null Handle if Structure is not defined

virtual IGESData_DefType DefLineFont () const
 Returns the definition status of LineFont

Standard_Integer RankLineFont () const
 Returns LineFont definition as an Integer (if defined as Rank)
If LineFont is defined as an Entity, returns a negative value

Handle_IGESData_LineFontEntity LineFont () const
 Returns LineFont as an Entity (if defined as Reference)
Returns a Null Handle if DefLineFont is not "DefReference"

virtual IGESData_DefList DefLevel () const
 Returns the definition status of Level

Standard_Integer Level () const
 Returns the level the entity
belongs to. Returns -1 if the entity belongs to more than one level.

Handle_IGESData_LevelListEntity LevelList () const
 Returns LevelList if Level is
defined as a list. Returns a null handle if DefLevel is not DefSeveral.

virtual IGESData_DefList DefView () const
 Returns the definition status of
the view. This can be: none, one or several.

Handle_IGESData_ViewKindEntity View () const
 Returns the view of this IGES entity.
This view can be a single view or a list of views.
Warning A null handle is returned if the view is not defined.

Handle_IGESData_ViewKindEntity SingleView () const
 Returns the view as a single view
if it was defined as such and not as a list of views.
Warning A null handle is returned if DefView does not have the value DefOne.

Handle_IGESData_ViewKindEntity ViewList () const
 Returns the view of this IGES entity as a list.
Warning A null handle is returned if the
definition status does not have the value DefSeveral.

Standard_Boolean HasTransf () const
 Returns True if a Transformation Matrix is defined

Handle_IGESData_TransfEntity Transf () const
 Returns the Transformation Matrix (under IGES definition)
Returns a Null Handle if there is none
for a more complete use, see Location & CompoundLocation

Standard_Boolean HasLabelDisplay () const
 Returns True if a LabelDisplay mode is defined for this entity

Handle_IGESData_LabelDisplayEntity LabelDisplay () const
 Returns the Label Display
Associativity Entity if there is one. Returns a null handle if there is none.

Standard_Integer BlankStatus () const
 gives Blank Status (0 visible, 1 blanked)

Standard_Integer SubordinateStatus () const
 gives Subordinate Switch (0-1-2-3)

Standard_Integer UseFlag () const
 gives Entity's Use Flag (0 to 5)

Standard_Integer HierarchyStatus () const
 gives Hierarchy status (0-1-2)

Standard_Integer LineWeightNumber () const
 Returns the LineWeight Number (0 not defined), see also LineWeight

Standard_Real LineWeight () const
 Returns the true Line Weight, computed from LineWeightNumber and
Global Parameter in the Model by call to SetLineWeight

virtual IGESData_DefType DefColor () const
 Returns the definition status of Color.

Standard_Integer RankColor () const
 Returns the color definition as
an integer value if the color was defined as a rank.
Warning A negative value is returned if the color was defined as an entity.

Handle_IGESData_ColorEntity Color () const
 Returns the IGES entity which
describes the color of the entity.
Returns a null handle if this entity was defined as an integer.

Standard_Boolean CResValues (const Standard_CString res1, const Standard_CString res2) const
 returns "reserved" alphanumeric values res1 and res2
res1 and res2 have to be reserved as Character[9 at least]
(remark : their content is changed)
returned values are ended by null character in 9th
returned Boolean is False if res1 and res2 are blank, true else

Standard_Boolean HasShortLabel () const
 Returns true if a short label is defined.
A short label is a non-blank 8-character string.

Handle_TCollection_HAsciiString ShortLabel () const
 Returns the label value for this IGES entity as a string.
Warning If the label is blank, this string is null.

virtual Standard_Boolean HasSubScriptNumber () const
 Returns true if a subscript number is defined.
A subscript number is an integer used to identify a label.

Standard_Integer SubScriptNumber () const
 Returns the integer subscript number used to identify this IGES entity.
Warning 0 is returned if no subscript number is defined for this IGES entity.

void InitDirFieldEntity (const Standard_Integer fieldnum, const Handle< IGESData_IGESEntity > &ent)
 Initializes a directory field as an Entiy of any kind
See DirFieldEntity for more details

void InitTransf (const Handle< IGESData_TransfEntity > &ent)
 Initializes Transf, or erases it if <ent> is given Null

void InitView (const Handle< IGESData_ViewKindEntity > &ent)
 Initializes View, or erases it if <ent> is given Null

void InitLineFont (const Handle< IGESData_LineFontEntity > &ent, const Standard_Integer rank=0)
 Initializes LineFont : if <ent> is not Null, it gives LineFont,
else <rank> gives or erases (if zero) RankLineFont

void InitLevel (const Handle< IGESData_LevelListEntity > &ent, const Standard_Integer val=0)
 Initializes Level : if <ent> is not Null, it gives LevelList,
else <val> gives or erases (if zero) unique Level

void InitColor (const Handle< IGESData_ColorEntity > &ent, const Standard_Integer rank=0)
 Initializes Color data : if <ent> is not Null, it gives Color,
else <rank> gives or erases (if zero) RankColor

void InitStatus (const Standard_Integer blank, const Standard_Integer subordinate, const Standard_Integer useflag, const Standard_Integer hierarchy)
 Initializes the Status of Directory Part

void SetLabel (const Handle< TCollection_HAsciiString > &label, const Standard_Integer sub=-1)
 Sets a new Label to an IGES Entity
If is given, it sets value of SubScriptNumber
else, SubScriptNumber is erased

void InitMisc (const Handle< IGESData_IGESEntity > &str, const Handle< IGESData_LabelDisplayEntity > &lab, const Standard_Integer weightnum)
 Initializes various data (those not yet seen above), or erases
them if they are given as Null (Zero for <weightnum>) :
<str> for Structure, <lab> for LabelDisplay, and
<weightnum> for WeightNumber

Standard_Boolean HasOneParent () const
 Returns True if an entity has one and only one parent, defined
by a SingleParentEntity Type Associativity (explicit sharing).
Thus, implicit sharing remains defined at model level
(see class ToolLocation)

Handle_IGESData_IGESEntity UniqueParent () const
 Returns the Unique Parent (in the sense given by HasOneParent)
Error if there is none or several

gp_GTrsf Location () const
 Returns Location given by Transf in Directory Part (see above)
It must be considered for local definition : if the Entity is
set in a "Parent", that one can add its one Location, but this
is not taken in account here : see CompoundLocation for that.
If no Transf is defined, returns Identity
If Transf is itself compound, gives the final result

gp_GTrsf VectorLocation () const
 Returns Location considered for Vectors, i.e. without its
Translation Part. As Location, it gives local definition.

gp_GTrsf CompoundLocation () const
 Returns Location by taking in account a Parent which has its
own Location : that one will be combined to that of <me>
The Parent is considered only if HasOneParent is True,
else it is ignored and CompoundLocation = Location

Standard_Boolean HasName () const
 says if a Name is defined, as Short Label or as Name Property
(Property is looked first, else ShortLabel is considered)

Handle_TCollection_HAsciiString NameValue () const
 returns Name value as a String (Property Name or ShortLabel)
if SubNumber is defined, it is concatenated after ShortLabel
as follows label(number). Ignored with a Property Name

Standard_Boolean ArePresentAssociativities () const
 Returns True if the Entity is defined with an Associativity
list, even empty (that is, file contains its length 0)
Else, the file contained NO idencation at all about this list.

Standard_Integer NbAssociativities () const
 gives number of recorded associativities (0 no list defined)

Interface_EntityIterator Associativities () const
 Returns the Associativity List under the form of an EntityIterator.

Standard_Integer NbTypedAssociativities (const Handle< Standard_Type > &atype) const
 gives how many Associativities have a given type

Handle_IGESData_IGESEntity TypedAssociativity (const Handle< Standard_Type > &atype) const
 returns the Associativity of a given Type (if only one exists)
Error if none or more than one

void Associate (const Handle< IGESData_IGESEntity > &ent) const
 Sets "me" in the Associativity list of another Entity

void Dissociate (const Handle< IGESData_IGESEntity > &ent) const
 Resets "me" from the Associativity list of another Entity

Standard_Boolean ArePresentProperties () const
 Returns True if the Entity is defined with a Property list,
even empty (that is, file contains its length 0)
Else, the file contained NO idencation at all about this list

Standard_Integer NbProperties () const
 Gives number of recorded properties (0 no list defined)

Interface_EntityIterator Properties () const
 Returns Property List under the form of an EntityIterator

Standard_Integer NbTypedProperties (const Handle< Standard_Type > &atype) const
 gives how many Properties have a given type

Handle_IGESData_IGESEntity TypedProperty (const Handle< Standard_Type > &atype, const Standard_Integer anum=0) const
 returns the Property of a given Type
Error if none or more than one

void AddProperty (const Handle< IGESData_IGESEntity > &ent)
 Adds a Property in the list

void RemoveProperty (const Handle< IGESData_IGESEntity > &ent)
 Removes a Property from the list

void SetLineWeight (const Standard_Real defw, const Standard_Real maxw, const Standard_Integer gradw)
 computes and sets "true" line weight according IGES rules from
global data MaxLineWeight (maxv) and LineWeightGrad (gradw),
or sets it to defw (Default) if LineWeightNumber is null

Protected Member Functions

 IGESData_IGESEntity ()
 prepares lists of optionnal data, set values to defaults

void InitTypeAndForm (const Standard_Integer typenum, const Standard_Integer formnum)
 Initializes Type and Form Numbers to new values. Reserved for
special uses

void LoadAssociativities (const Interface_EntityList &list)
 Loads a complete, already loaded, List of Asociativities
(used during Read or Copy Operations)

void LoadProperties (const Interface_EntityList &list)
 Loads a complete, already loaded, List of Properties
(used during Read or Copy Operations)

void ClearProperties ()
 Removes all properties in once


Constructor & Destructor Documentation


Member Function Documentation

Handle_IGESData_ColorEntity IGESData_IGESEntity::Color ( ) const
virtual IGESData_DefType IGESData_IGESEntity::DefColor ( ) const [virtual]

Reimplemented in IGESData_UndefinedEntity.

virtual IGESData_DefList IGESData_IGESEntity::DefLevel ( ) const [virtual]

Reimplemented in IGESData_UndefinedEntity.

Reimplemented in IGESData_UndefinedEntity.

virtual IGESData_DefList IGESData_IGESEntity::DefView ( ) const [virtual]

Reimplemented in IGESData_UndefinedEntity.

Handle_IGESData_IGESEntity IGESData_IGESEntity::DirFieldEntity ( const Standard_Integer  fieldnum) const

Reimplemented in IGESData_UndefinedEntity.

Handle_IGESData_LabelDisplayEntity IGESData_IGESEntity::LabelDisplay ( ) const
Handle_IGESData_LevelListEntity IGESData_IGESEntity::LevelList ( ) const
Handle_IGESData_LineFontEntity IGESData_IGESEntity::LineFont ( ) const
Handle_TCollection_HAsciiString IGESData_IGESEntity::NameValue ( ) const
Handle_TCollection_HAsciiString IGESData_IGESEntity::ShortLabel ( ) const
Handle_IGESData_ViewKindEntity IGESData_IGESEntity::SingleView ( ) const
Handle_IGESData_IGESEntity IGESData_IGESEntity::Structure ( ) const
Handle_IGESData_TransfEntity IGESData_IGESEntity::Transf ( ) const
Handle_IGESData_IGESEntity IGESData_IGESEntity::TypedAssociativity ( const Handle< Standard_Type > &  atype) const
Handle_IGESData_IGESEntity IGESData_IGESEntity::TypedProperty ( const Handle< Standard_Type > &  atype,
const Standard_Integer  anum = 0 
) const
Handle_IGESData_IGESEntity IGESData_IGESEntity::UniqueParent ( ) const
Handle_IGESData_ViewKindEntity IGESData_IGESEntity::View ( ) const
Handle_IGESData_ViewKindEntity IGESData_IGESEntity::ViewList ( ) const

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