OCCT3D OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    IGESDefs_TabularData Class Reference

    Defines IGES Tabular Data, Type <406> Form <11>, in package IGESDefs This Class is used to provide a Structure to accommodate point form data. More...

    #include <IGESDefs_TabularData.hxx>

    Inheritance diagram for IGESDefs_TabularData:

    Public Member Functions

     IGESDefs_TabularData ()
    void Init (const int nbProps, const int propType, const occ::handle< NCollection_HArray1< int > > &typesInd, const occ::handle< NCollection_HArray1< int > > &nbValuesInd, const occ::handle< IGESBasic_HArray1OfHArray1OfReal > &valuesInd, const occ::handle< IGESBasic_HArray1OfHArray1OfReal > &valuesDep)
     This method is used to set the fields of the class TabularData.
    int NbPropertyValues () const
     returns the number of property values (recorded)
    int ComputedNbPropertyValues () const
     determines the number of property values required
    bool OwnCorrect ()
     checks, and correct as necessary, the number of property values. Returns True if corrected, False if already OK
    int PropertyType () const
     returns the property type
    int NbDependents () const
     returns the number of dependent variables
    int NbIndependents () const
     returns the number of independent variables
    int TypeOfIndependents (const int numnum) const
     returns the type of the num'th independent variable raises exception if num <= 0 or num > NbIndependents()
    int NbValues (const int numnum) const
     returns the number of different values of the num'th indep. variable raises exception if num <= 0 or num > NbIndependents()
    double IndependentValue (const int variablenum, const int valuenum) const
    occ::handle< NCollection_HArray1< double > > DependentValues (const int numnum) const
    double DependentValue (const int variablenum, const int valuenum) const
    Public Member Functions inherited from IGESData_IGESEntity
    IGESData_IGESType IGESType () const
     gives IGES typing info (includes "Type" and "Form" data)
    int TypeNumber () const
     gives IGES Type Number (often coupled with Form Number)
    int FormNumber () const
     Returns the form number for that type of an IGES entity. The default form number is 0.
    occ::handle< IGESData_IGESEntityDirFieldEntity (const int 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.
    bool HasStructure () const
     returns True if an IGESEntity is defined with a Structure (it is normally reserved for certain classes, such as Macros)
    occ::handle< IGESData_IGESEntityStructure () 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.
    int RankLineFont () const
     Returns LineFont definition as an Integer (if defined as Rank) If LineFont is defined as an Entity, returns a negative value.
    occ::handle< IGESData_LineFontEntityLineFont () 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.
    int Level () const
     Returns the level the entity belongs to. Returns -1 if the entity belongs to more than one level.
    occ::handle< IGESData_LevelListEntityLevelList () 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.
    occ::handle< IGESData_ViewKindEntityView () 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.
    occ::handle< IGESData_ViewKindEntitySingleView () 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.
    occ::handle< IGESData_ViewKindEntityViewList () 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.
    bool HasTransf () const
     Returns True if a Transformation Matrix is defined.
    occ::handle< IGESData_TransfEntityTransf () const
     Returns the Transformation Matrix (under IGES definition) Returns a Null Handle if there is none for a more complete use, see Location & CompoundLocation.
    bool HasLabelDisplay () const
     Returns True if a LabelDisplay mode is defined for this entity.
    occ::handle< IGESData_LabelDisplayEntityLabelDisplay () const
     Returns the Label Display Associativity Entity if there is one. Returns a null handle if there is none.
    int BlankStatus () const
     gives Blank Status (0 visible, 1 blanked)
    int SubordinateStatus () const
     gives Subordinate Switch (0-1-2-3)
    int UseFlag () const
     gives Entity's Use Flag (0 to 5)
    int HierarchyStatus () const
     gives Hierarchy status (0-1-2)
    int LineWeightNumber () const
     Returns the LineWeight Number (0 not defined), see also LineWeight.
    double 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.
    int 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.
    occ::handle< IGESData_ColorEntityColor () const
     Returns the IGES entity which describes the color of the entity. Returns a null handle if this entity was defined as an integer.
    bool CResValues (char *res1, char *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
    bool HasShortLabel () const
     Returns true if a short label is defined. A short label is a non-blank 8-character string.
    occ::handle< TCollection_HAsciiStringShortLabel () const
     Returns the label value for this IGES entity as a string. Warning If the label is blank, this string is null.
    virtual bool HasSubScriptNumber () const
     Returns true if a subscript number is defined. A subscript number is an integer used to identify a label.
    int 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 int fieldnum, const occ::handle< IGESData_IGESEntity > &ent)
     Initializes a directory field as an Entity of any kind See DirFieldEntity for more details.
    void InitTransf (const occ::handle< IGESData_TransfEntity > &ent)
     Initializes Transf, or erases it if <ent> is given Null.
    void InitView (const occ::handle< IGESData_ViewKindEntity > &ent)
     Initializes View, or erases it if <ent> is given Null.
    void InitLineFont (const occ::handle< IGESData_LineFontEntity > &ent, const int rank=0)
     Initializes LineFont : if <ent> is not Null, it gives LineFont, else <rank> gives or erases (if zero) RankLineFont.
    void InitLevel (const occ::handle< IGESData_LevelListEntity > &ent, const int valval=0)
     Initializes Level : if <ent> is not Null, it gives LevelList, else <val> gives or erases (if zero) unique Level.
    void InitColor (const occ::handle< IGESData_ColorEntity > &ent, const int rank=0)
     Initializes Color data : if <ent> is not Null, it gives Color, else <rank> gives or erases (if zero) RankColor.
    void InitStatus (const int blank, const int subordinate, const int useflag, const int hierarchy)
     Initializes the Status of Directory Part.
    void SetLabel (const occ::handle< TCollection_HAsciiString > &labellabel, const int 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 occ::handle< IGESData_IGESEntity > &str, const occ::handle< IGESData_LabelDisplayEntity > &lab, const int 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.
    bool 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).
    occ::handle< IGESData_IGESEntityUniqueParent () 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.
    bool HasName () const
     says if a Name is defined, as Short Label or as Name Property (Property is looked first, else ShortLabel is considered)
    occ::handle< TCollection_HAsciiStringNameValue () 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
    bool 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.
    int 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.
    int NbTypedAssociativities (const occ::handle< Standard_Type > &atype) const
     gives how many Associativities have a given type
    occ::handle< IGESData_IGESEntityTypedAssociativity (const occ::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 occ::handle< IGESData_IGESEntity > &ent) const
     Sets "me" in the Associativity list of another Entity.
    void Dissociate (const occ::handle< IGESData_IGESEntity > &ent) const
     Resets "me" from the Associativity list of another Entity.
    bool 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.
    int NbProperties () const
     Gives number of recorded properties (0 no list defined).
    Interface_EntityIterator Properties () const
     Returns Property List under the form of an EntityIterator.
    int NbTypedProperties (const occ::handle< Standard_Type > &atype) const
     gives how many Properties have a given type
    occ::handle< IGESData_IGESEntityTypedProperty (const occ::handle< Standard_Type > &atype, const int anum=0) const
     returns the Property of a given Type Error if none or more than one
    void AddProperty (const occ::handle< IGESData_IGESEntity > &ent)
     Adds a Property in the list.
    void RemoveProperty (const occ::handle< IGESData_IGESEntity > &ent)
     Removes a Property from the list.
    void SetLineWeight (const double defw, const double maxw, const int 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
    Public Member Functions inherited from Standard_Transient
     Standard_Transient ()
     Empty constructor.
     Standard_Transient (const Standard_Transient &)
     Copy constructor – does nothing.
    Standard_Transientoperator= (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_TransientThis () 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

    typedef void base_type
     Returns a type descriptor about this object.
    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.
    Protected Member Functions inherited from IGESData_IGESEntity
     IGESData_IGESEntity ()
     prepares lists of optional data, set values to defaults
    void InitTypeAndForm (const int typenum, const int 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.

    Detailed Description

    Defines IGES Tabular Data, Type <406> Form <11>, in package IGESDefs This Class is used to provide a Structure to accommodate point form data.

    Constructor & Destructor Documentation

    ◆ IGESDefs_TabularData()

    IGESDefs_TabularData::IGESDefs_TabularData ( )

    Member Function Documentation

    ◆ ComputedNbPropertyValues()

    int IGESDefs_TabularData::ComputedNbPropertyValues ( ) const

    determines the number of property values required

    ◆ DependentValue()

    double IGESDefs_TabularData::DependentValue ( const int variablenum,
    const int valuenum ) const

    ◆ DependentValues()

    occ::handle< NCollection_HArray1< double > > IGESDefs_TabularData::DependentValues ( const int num) const

    ◆ IndependentValue()

    double IGESDefs_TabularData::IndependentValue ( const int variablenum,
    const int valuenum ) const

    ◆ Init()

    void IGESDefs_TabularData::Init ( const int nbProps,
    const int propType,
    const occ::handle< NCollection_HArray1< int > > & typesInd,
    const occ::handle< NCollection_HArray1< int > > & nbValuesInd,
    const occ::handle< IGESBasic_HArray1OfHArray1OfReal > & valuesInd,
    const occ::handle< IGESBasic_HArray1OfHArray1OfReal > & valuesDep )

    This method is used to set the fields of the class TabularData.

    • nbProps : Number of property values
    • propType : Property Type
    • typesInd : Type of independent variables
    • nbValuesInd : Number of values of independent variables
    • valuesInd : Values of independent variables
    • valuesDep : Values of dependent variables raises exception if lengths of typeInd and nbValuesInd are not same

    ◆ NbDependents()

    int IGESDefs_TabularData::NbDependents ( ) const

    returns the number of dependent variables

    ◆ NbIndependents()

    int IGESDefs_TabularData::NbIndependents ( ) const

    returns the number of independent variables

    ◆ NbPropertyValues()

    int IGESDefs_TabularData::NbPropertyValues ( ) const

    returns the number of property values (recorded)

    ◆ NbValues()

    int IGESDefs_TabularData::NbValues ( const int num) const

    returns the number of different values of the num'th indep. variable raises exception if num <= 0 or num > NbIndependents()

    ◆ OwnCorrect()

    bool IGESDefs_TabularData::OwnCorrect ( )

    checks, and correct as necessary, the number of property values. Returns True if corrected, False if already OK

    ◆ PropertyType()

    int IGESDefs_TabularData::PropertyType ( ) const

    returns the property type

    ◆ TypeOfIndependents()

    int IGESDefs_TabularData::TypeOfIndependents ( const int num) const

    returns the type of the num'th independent variable raises exception if num <= 0 or num > NbIndependents()


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