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
    XCAFDoc_DimTolTool Class Reference

    Attribute containing GD&T section of XCAF document. Provide tools for GD&T section management. More...

    #include <XCAFDoc_DimTolTool.hxx>

    Inheritance diagram for XCAFDoc_DimTolTool:

    Public Member Functions

     XCAFDoc_DimTolTool ()
    TDF_Label BaseLabel () const
     Returns the label under which GD&T table is stored.
    const occ::handle< XCAFDoc_ShapeTool > & ShapeTool ()
     Returns internal XCAFDoc_ShapeTool tool.
    bool IsDimension (const TDF_Label &theLab) const
     Returns True if the label belongs to a GD&T table and is a Dimension definition.
    void GetDimensionLabels (NCollection_Sequence< TDF_Label > &theLabels) const
     Returns a sequence of Dimension labels currently stored in the GD&T table.
    void SetDimension (const NCollection_Sequence< TDF_Label > &theFirstLS, const NCollection_Sequence< TDF_Label > &theSecondLS, const TDF_Label &theDimL) const
     Sets a dimension to sequences target labels.
    void SetDimension (const TDF_Label &theFirstL, const TDF_Label &theSecondL, const TDF_Label &theDimL) const
     Sets a dimension to target labels.
    void SetDimension (const TDF_Label &theL, const TDF_Label &theDimL) const
     Sets a dimension to the target label.
    bool GetRefDimensionLabels (const TDF_Label &theShapeL, NCollection_Sequence< TDF_Label > &theDimensions) const
     Returns all Dimension labels defined for theShapeL.
    TDF_Label AddDimension ()
     Adds a dimension definition to the GD&T table and returns its label.
    bool IsGeomTolerance (const TDF_Label &theLab) const
     Returns True if the label belongs to the GD&T table and is a dimension tolerance.
    void GetGeomToleranceLabels (NCollection_Sequence< TDF_Label > &theLabels) const
     Returns a sequence of Tolerance labels currently stored in the GD&T table.
    void SetGeomTolerance (const TDF_Label &theL, const TDF_Label &theGeomTolL) const
     Sets a geometry tolerance from theGeomTolL to theL label. Checks if theGeomTolL is a geometry tolerance definition first.
    void SetGeomTolerance (const NCollection_Sequence< TDF_Label > &theL, const TDF_Label &theGeomTolL) const
     Sets a geometry tolerance from theGeomTolL to sequence of labels theL. Checks if theGeomTolL is a geometry tolerance definition first.
    bool GetRefGeomToleranceLabels (const TDF_Label &theShapeL, NCollection_Sequence< TDF_Label > &theDimTols) const
     Returns all GeomTolerance labels defined for theShapeL.
    TDF_Label AddGeomTolerance ()
     Adds a GeomTolerance definition to the GD&T table and returns its label.
    bool IsDimTol (const TDF_Label &theLab) const
     Returns True if theLab belongs to the GD&T table and is a dmension tolerance.
    void GetDimTolLabels (NCollection_Sequence< TDF_Label > &Labels) const
     Returns a sequence of D&GTs currently stored in the GD&T table.
    bool FindDimTol (const int theKind, const occ::handle< NCollection_HArray1< double > > &theVal, const occ::handle< TCollection_HAsciiString > &theName, const occ::handle< TCollection_HAsciiString > &theDescription, TDF_Label &lab) const
     Finds a dimension tolerance definition in the GD&T table satisfying the specified kind, values, name and description and returns its label if found. Returns False if dimension tolerance is not found in DGTtable.
    TDF_Label FindDimTol (const int theKind, const occ::handle< NCollection_HArray1< double > > &theVal, const occ::handle< TCollection_HAsciiString > &theName, const occ::handle< TCollection_HAsciiString > &theDescription) const
     Finds a dimension tolerance in the GD&T table satisfying the specified kind, values, name and description and returns its label if found (or Null label else).
    TDF_Label AddDimTol (const int theKind, const occ::handle< NCollection_HArray1< double > > &theVal, const occ::handle< TCollection_HAsciiString > &theName, const occ::handle< TCollection_HAsciiString > &theDescription) const
     Adds a dimension tolerance definition with the specified kind, value, name and description to the GD&T table and returns its label.
    void SetDimTol (const TDF_Label &theL, const TDF_Label &theDimTolL) const
     Sets existing dimension tolerance to theL label.
    TDF_Label SetDimTol (const TDF_Label &theL, const int theKind, const occ::handle< NCollection_HArray1< double > > &theVal, const occ::handle< TCollection_HAsciiString > &theName, const occ::handle< TCollection_HAsciiString > &theDescription) const
     Creates a dimension tolerance and sets it to theL label.
    bool GetDimTol (const TDF_Label &theDimTolL, int &theKind, occ::handle< NCollection_HArray1< double > > &theVal, occ::handle< TCollection_HAsciiString > &theName, occ::handle< TCollection_HAsciiString > &theDescription) const
     Returns dimension tolerance assigned to theDimTolL label. Returns False if no such dimension tolerance is assigned.
    bool IsDatum (const TDF_Label &lab) const
     Returns True if label belongs to the GD&T table and is a Datum definition.
    void GetDatumLabels (NCollection_Sequence< TDF_Label > &Labels) const
     Returns a sequence of Datums currently stored in the GD&T table.
    bool FindDatum (const occ::handle< TCollection_HAsciiString > &theName, const occ::handle< TCollection_HAsciiString > &theDescription, const occ::handle< TCollection_HAsciiString > &theIdentification, TDF_Label &lab) const
     Finds a datum satisfying the specified name, description and identification and returns its label if found.
    TDF_Label AddDatum (const occ::handle< TCollection_HAsciiString > &theName, const occ::handle< TCollection_HAsciiString > &theDescription, const occ::handle< TCollection_HAsciiString > &theIdentification) const
     Adds a datum definition to the GD&T table and returns its label.
    TDF_Label AddDatum ()
     Adds a datum definition to the GD&T table and returns its label.
    void SetDatum (const NCollection_Sequence< TDF_Label > &theShapeLabels, const TDF_Label &theDatumL) const
     Sets a datum to the sequence of shape labels.
    void SetDatum (const TDF_Label &theL, const TDF_Label &theTolerL, const occ::handle< TCollection_HAsciiString > &theName, const occ::handle< TCollection_HAsciiString > &theDescription, const occ::handle< TCollection_HAsciiString > &theIdentification) const
     Sets a datum to theL label and binds it with theTolerL label. A datum with the specified name, description and identification is created if it isn't found in the GD&T table.
    void SetDatumToGeomTol (const TDF_Label &theDatumL, const TDF_Label &theTolerL) const
     Sets a datum from theDatumL label to theToletL label.
    bool GetDatum (const TDF_Label &theDatumL, occ::handle< TCollection_HAsciiString > &theName, occ::handle< TCollection_HAsciiString > &theDescription, occ::handle< TCollection_HAsciiString > &theIdentification) const
     Returns datum assigned to theDatumL label. Returns False if no such datum is assigned.
    bool GetTolerOfDatumLabels (const TDF_Label &theDatumL, NCollection_Sequence< TDF_Label > &theTols) const
     Returns all GeomToleranses labels defined for theDatumL label.
    bool GetRefDatumLabel (const TDF_Label &theShapeL, NCollection_Sequence< TDF_Label > &theDatum) const
     Returns Datum label defined for theShapeL label.
    bool IsLocked (const TDF_Label &theViewL) const
     Returns true if the given GDT is marked as locked.
    void Lock (const TDF_Label &theViewL) const
     Mark the given GDT as locked.
    void GetGDTPresentations (NCollection_IndexedDataMap< TDF_Label, TopoDS_Shape > &theGDTLabelToShape) const
     fill the map GDT label -> shape presentation
    void SetGDTPresentations (NCollection_IndexedDataMap< TDF_Label, TopoDS_Shape > &theGDTLabelToPrs)
     Set shape presentation for GDT labels according to given map (theGDTLabelToPrs) theGDTLabelToPrsName map is an additional argument, can be used to set presentation names. If label is not in the theGDTLabelToPrsName map, the presentation name will be empty.
    void Unlock (const TDF_Label &theViewL) const
     Unlock the given GDT.
    const Standard_GUIDID () const override
     Returns the ID of the attribute.
    void DumpJson (Standard_OStream &theOStream, int theDepth=-1) const override
     Dumps the content of me into the stream.
    Public Member Functions inherited from TDataStd_GenericEmpty
    void Restore (const occ::handle< TDF_Attribute > &) override
     Restores the backuped contents from <anAttribute> into this one. It is used when aborting a transaction.
    void Paste (const occ::handle< TDF_Attribute > &, const occ::handle< TDF_RelocationTable > &) const override
     This method is different from the "Copy" one, because it is used when copying an attribute from a source structure into a target structure. This method may paste the contents of <me> into <intoAttribute>.
    Public Member Functions inherited from TDF_Attribute
    virtual void SetID (const Standard_GUID &)
     Sets specific ID of the attribute (supports several attributes of one type at the same label feature).
    virtual void SetID ()
     Sets default ID defined in nested class (to be used for attributes having User ID feature).
    const TDF_Label Label () const
     Returns the label to which the attribute is attached. If the label is not included in a DF, the label is null. See Label. Warning: If the label is not included in a data framework, it is null. This function should not be redefined inline.
    int Transaction () const
     Returns the transaction index in which the attribute has been created or modified.
    int UntilTransaction () const
     Returns the upper transaction index until which the attribute is/was valid. This number may vary. A removed attribute validity range is reduced to its transaction index.
    bool IsValid () const
     Returns true if the attribute is valid; i.e. not a backuped or removed one.
    bool IsNew () const
     Returns true if the attribute has no backup.
    bool IsForgotten () const
     Returns true if the attribute forgotten status is set.
    bool IsAttribute (const Standard_GUID &anID) const
     Returns true if it exists an associated attribute of <me> with <anID> as ID.
    bool FindAttribute (const Standard_GUID &anID, occ::handle< TDF_Attribute > &anAttribute) const
     Finds an associated attribute of <me>, according to <anID>. the returned <anAttribute> is a valid one. The method returns True if found, False otherwise. A removed attribute cannot be found using this method.
    template<class T>
    bool FindAttribute (const Standard_GUID &theID, occ::handle< T > &theAttr) const
     Safe variant for arbitrary type of argument.
    void AddAttribute (const occ::handle< TDF_Attribute > &other) const
     Adds an Attribute <other> to the label of <me>. Raises if there is already one of the same GUID than <other>.
    bool ForgetAttribute (const Standard_GUID &aguid) const
     Forgets the Attribute of GUID <aguid> associated to the label of <me>. Be careful that if <me> is the attribute of <guid>, <me> will have a null label after this call. If the attribute doesn't exist returns False. Otherwise returns True.
    void ForgetAllAttributes (const bool clearChildren=true) const
     Forgets all the attributes attached to the label of <me>. Does it on the sub-labels if <clearChildren> is set to true. Of course, this method is compatible with Transaction & Delta mechanisms. Be careful that if <me> will have a null label after this call.
    virtual void AfterAddition ()
     Something to do after adding an Attribute to a label.
    virtual void BeforeRemoval ()
     Something to do before removing an Attribute from a label.
    virtual void BeforeForget ()
     Something to do before forgetting an Attribute to a label.
    virtual void AfterResume ()
     Something to do after resuming an Attribute from a label.
    virtual bool AfterRetrieval (const bool forceIt=false)
     Something to do AFTER creation of an attribute by persistent-transient translation. The returned status says if AfterUndo has been performed (true) or if this callback must be called once again further (false). If <forceIt> is set to true, the method MUST perform and return true. Does nothing by default and returns true.
    virtual bool BeforeUndo (const occ::handle< TDF_AttributeDelta > &anAttDelta, const bool forceIt=false)
     Something to do before applying <anAttDelta>. The returned status says if AfterUndo has been performed (true) or if this callback must be called once again further (false). If <forceIt> is set to true, the method MUST perform and return true. Does nothing by default and returns true.
    virtual bool AfterUndo (const occ::handle< TDF_AttributeDelta > &anAttDelta, const bool forceIt=false)
     Something to do after applying <anAttDelta>. The returned status says if AfterUndo has been performed (true) or if this callback must be called once again further (false). If <forceIt> is set to true, the method MUST perform and return true. Does nothing by default and returns true.
    virtual void BeforeCommitTransaction ()
     A callback. By default does nothing. It is called by TDF_Data::CommitTransaction() method.
    void Backup ()
     Backups the attribute. The backuped attribute is flagged "Backuped" and not "Valid".
    bool IsBackuped () const
     Returns true if the attribute backup status is set. This status is set/unset by the Backup() method.
    virtual occ::handle< TDF_AttributeBackupCopy () const
     Copies the attribute contents into a new other attribute. It is used by Backup().
    virtual occ::handle< TDF_DeltaOnAdditionDeltaOnAddition () const
     Makes an AttributeDelta because <me> appeared. The only known use of a redefinition of this method is to return a null handle (no delta).
    virtual occ::handle< TDF_DeltaOnForgetDeltaOnForget () const
     Makes an AttributeDelta because <me> has been forgotten.
    virtual occ::handle< TDF_DeltaOnResumeDeltaOnResume () const
     Makes an AttributeDelta because <me> has been resumed.
    virtual occ::handle< TDF_DeltaOnModificationDeltaOnModification (const occ::handle< TDF_Attribute > &anOldAttribute) const
     Makes a DeltaOnModification between <me> and.
    virtual void DeltaOnModification (const occ::handle< TDF_DeltaOnModification > &aDelta)
     Applies a DeltaOnModification to <me>.
    virtual occ::handle< TDF_DeltaOnRemovalDeltaOnRemoval () const
     Makes a DeltaOnRemoval on <me> because <me> has disappeared from the DS.
    virtual occ::handle< TDF_AttributeNewEmpty () const =0
     Returns an new empty attribute from the good end type. It is used by the copy algorithm.
    virtual void References (const occ::handle< TDF_DataSet > &aDataSet) const
     Adds the first level referenced attributes and labels to <aDataSet>.
    virtual Standard_OStreamDump (Standard_OStream &anOS) const
     Dumps the minimum information about <me> on <aStream>.
    Standard_OStreamoperator<< (Standard_OStream &anOS) const
    virtual void ExtendedDump (Standard_OStream &anOS, const TDF_IDFilter &aFilter, NCollection_IndexedMap< occ::handle< TDF_Attribute > > &aMap) const
     Dumps the attribute content on <aStream>, using <aMap> like this: if an attribute is not in the map, first put add it to the map and then dump it. Use the map rank instead of dumping each attribute field.
    void Forget (const int aTransaction)
     Forgets the attribute. <aTransaction> is the current transaction in which the forget is done. A forgotten attribute is also flagged not "Valid".
    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.

    Static Public Member Functions

    static occ::handle< XCAFDoc_DimTolToolSet (const TDF_Label &L)
     Creates (if not exist) DimTolTool attribute.
    static const Standard_GUIDGetID ()
     Returns the standard GD&T tool GUID.
    static bool GetRefShapeLabel (const TDF_Label &theL, NCollection_Sequence< TDF_Label > &theShapeLFirst, NCollection_Sequence< TDF_Label > &theShapeLSecond)
     Gets all shape labels referred by theL label of the GD&T table. Returns False if there are no shape labels added to the sequences.
    static bool GetDatumOfTolerLabels (const TDF_Label &theDimTolL, NCollection_Sequence< TDF_Label > &theDatums)
     Returns all Datum labels defined for theDimTolL label.
    static bool GetDatumWithObjectOfTolerLabels (const TDF_Label &theDimTolL, NCollection_Sequence< TDF_Label > &theDatums)
     Returns all Datum labels with XCAFDimTolObjects_DatumObject defined for label theDimTolL.
    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.

    Additional Inherited Members

    typedef void base_type
     Returns a type descriptor about this object.
    Protected Member Functions inherited from TDF_Attribute
     TDF_Attribute ()
     Initializes fields.

    Detailed Description

    Attribute containing GD&T section of XCAF document. Provide tools for GD&T section management.

    Constructor & Destructor Documentation

    ◆ XCAFDoc_DimTolTool()

    XCAFDoc_DimTolTool::XCAFDoc_DimTolTool ( )

    Member Function Documentation

    ◆ AddDatum() [1/2]

    TDF_Label XCAFDoc_DimTolTool::AddDatum ( )

    Adds a datum definition to the GD&T table and returns its label.

    ◆ AddDatum() [2/2]

    TDF_Label XCAFDoc_DimTolTool::AddDatum ( const occ::handle< TCollection_HAsciiString > & theName,
    const occ::handle< TCollection_HAsciiString > & theDescription,
    const occ::handle< TCollection_HAsciiString > & theIdentification ) const

    Adds a datum definition to the GD&T table and returns its label.

    ◆ AddDimension()

    TDF_Label XCAFDoc_DimTolTool::AddDimension ( )

    Adds a dimension definition to the GD&T table and returns its label.

    ◆ AddDimTol()

    TDF_Label XCAFDoc_DimTolTool::AddDimTol ( const int theKind,
    const occ::handle< NCollection_HArray1< double > > & theVal,
    const occ::handle< TCollection_HAsciiString > & theName,
    const occ::handle< TCollection_HAsciiString > & theDescription ) const

    Adds a dimension tolerance definition with the specified kind, value, name and description to the GD&T table and returns its label.

    ◆ AddGeomTolerance()

    TDF_Label XCAFDoc_DimTolTool::AddGeomTolerance ( )

    Adds a GeomTolerance definition to the GD&T table and returns its label.

    ◆ BaseLabel()

    TDF_Label XCAFDoc_DimTolTool::BaseLabel ( ) const

    Returns the label under which GD&T table is stored.

    ◆ DumpJson()

    void XCAFDoc_DimTolTool::DumpJson ( Standard_OStream & theOStream,
    int theDepth = -1 ) const
    overridevirtual

    Dumps the content of me into the stream.

    Reimplemented from TDataStd_GenericEmpty.

    ◆ FindDatum()

    bool XCAFDoc_DimTolTool::FindDatum ( const occ::handle< TCollection_HAsciiString > & theName,
    const occ::handle< TCollection_HAsciiString > & theDescription,
    const occ::handle< TCollection_HAsciiString > & theIdentification,
    TDF_Label & lab ) const

    Finds a datum satisfying the specified name, description and identification and returns its label if found.

    ◆ FindDimTol() [1/2]

    TDF_Label XCAFDoc_DimTolTool::FindDimTol ( const int theKind,
    const occ::handle< NCollection_HArray1< double > > & theVal,
    const occ::handle< TCollection_HAsciiString > & theName,
    const occ::handle< TCollection_HAsciiString > & theDescription ) const

    Finds a dimension tolerance in the GD&T table satisfying the specified kind, values, name and description and returns its label if found (or Null label else).

    ◆ FindDimTol() [2/2]

    bool XCAFDoc_DimTolTool::FindDimTol ( const int theKind,
    const occ::handle< NCollection_HArray1< double > > & theVal,
    const occ::handle< TCollection_HAsciiString > & theName,
    const occ::handle< TCollection_HAsciiString > & theDescription,
    TDF_Label & lab ) const

    Finds a dimension tolerance definition in the GD&T table satisfying the specified kind, values, name and description and returns its label if found. Returns False if dimension tolerance is not found in DGTtable.

    ◆ GetDatum()

    bool XCAFDoc_DimTolTool::GetDatum ( const TDF_Label & theDatumL,
    occ::handle< TCollection_HAsciiString > & theName,
    occ::handle< TCollection_HAsciiString > & theDescription,
    occ::handle< TCollection_HAsciiString > & theIdentification ) const

    Returns datum assigned to theDatumL label. Returns False if no such datum is assigned.

    ◆ GetDatumLabels()

    void XCAFDoc_DimTolTool::GetDatumLabels ( NCollection_Sequence< TDF_Label > & Labels) const

    Returns a sequence of Datums currently stored in the GD&T table.

    ◆ GetDatumOfTolerLabels()

    bool XCAFDoc_DimTolTool::GetDatumOfTolerLabels ( const TDF_Label & theDimTolL,
    NCollection_Sequence< TDF_Label > & theDatums )
    static

    Returns all Datum labels defined for theDimTolL label.

    ◆ GetDatumWithObjectOfTolerLabels()

    bool XCAFDoc_DimTolTool::GetDatumWithObjectOfTolerLabels ( const TDF_Label & theDimTolL,
    NCollection_Sequence< TDF_Label > & theDatums )
    static

    Returns all Datum labels with XCAFDimTolObjects_DatumObject defined for label theDimTolL.

    ◆ GetDimensionLabels()

    void XCAFDoc_DimTolTool::GetDimensionLabels ( NCollection_Sequence< TDF_Label > & theLabels) const

    Returns a sequence of Dimension labels currently stored in the GD&T table.

    ◆ GetDimTol()

    bool XCAFDoc_DimTolTool::GetDimTol ( const TDF_Label & theDimTolL,
    int & theKind,
    occ::handle< NCollection_HArray1< double > > & theVal,
    occ::handle< TCollection_HAsciiString > & theName,
    occ::handle< TCollection_HAsciiString > & theDescription ) const

    Returns dimension tolerance assigned to theDimTolL label. Returns False if no such dimension tolerance is assigned.

    ◆ GetDimTolLabels()

    void XCAFDoc_DimTolTool::GetDimTolLabels ( NCollection_Sequence< TDF_Label > & Labels) const

    Returns a sequence of D&GTs currently stored in the GD&T table.

    ◆ GetGDTPresentations()

    void XCAFDoc_DimTolTool::GetGDTPresentations ( NCollection_IndexedDataMap< TDF_Label, TopoDS_Shape > & theGDTLabelToShape) const

    fill the map GDT label -> shape presentation

    ◆ GetGeomToleranceLabels()

    void XCAFDoc_DimTolTool::GetGeomToleranceLabels ( NCollection_Sequence< TDF_Label > & theLabels) const

    Returns a sequence of Tolerance labels currently stored in the GD&T table.

    ◆ GetID()

    const Standard_GUID & XCAFDoc_DimTolTool::GetID ( )
    static

    Returns the standard GD&T tool GUID.

    ◆ GetRefDatumLabel()

    bool XCAFDoc_DimTolTool::GetRefDatumLabel ( const TDF_Label & theShapeL,
    NCollection_Sequence< TDF_Label > & theDatum ) const

    Returns Datum label defined for theShapeL label.

    ◆ GetRefDimensionLabels()

    bool XCAFDoc_DimTolTool::GetRefDimensionLabels ( const TDF_Label & theShapeL,
    NCollection_Sequence< TDF_Label > & theDimensions ) const

    Returns all Dimension labels defined for theShapeL.

    ◆ GetRefGeomToleranceLabels()

    bool XCAFDoc_DimTolTool::GetRefGeomToleranceLabels ( const TDF_Label & theShapeL,
    NCollection_Sequence< TDF_Label > & theDimTols ) const

    Returns all GeomTolerance labels defined for theShapeL.

    ◆ GetRefShapeLabel()

    bool XCAFDoc_DimTolTool::GetRefShapeLabel ( const TDF_Label & theL,
    NCollection_Sequence< TDF_Label > & theShapeLFirst,
    NCollection_Sequence< TDF_Label > & theShapeLSecond )
    static

    Gets all shape labels referred by theL label of the GD&T table. Returns False if there are no shape labels added to the sequences.

    ◆ GetTolerOfDatumLabels()

    bool XCAFDoc_DimTolTool::GetTolerOfDatumLabels ( const TDF_Label & theDatumL,
    NCollection_Sequence< TDF_Label > & theTols ) const

    Returns all GeomToleranses labels defined for theDatumL label.

    ◆ ID()

    const Standard_GUID & XCAFDoc_DimTolTool::ID ( ) const
    overridevirtual

    Returns the ID of the attribute.

    Implements TDF_Attribute.

    ◆ IsDatum()

    bool XCAFDoc_DimTolTool::IsDatum ( const TDF_Label & lab) const

    Returns True if label belongs to the GD&T table and is a Datum definition.

    ◆ IsDimension()

    bool XCAFDoc_DimTolTool::IsDimension ( const TDF_Label & theLab) const

    Returns True if the label belongs to a GD&T table and is a Dimension definition.

    ◆ IsDimTol()

    bool XCAFDoc_DimTolTool::IsDimTol ( const TDF_Label & theLab) const

    Returns True if theLab belongs to the GD&T table and is a dmension tolerance.

    ◆ IsGeomTolerance()

    bool XCAFDoc_DimTolTool::IsGeomTolerance ( const TDF_Label & theLab) const

    Returns True if the label belongs to the GD&T table and is a dimension tolerance.

    ◆ IsLocked()

    bool XCAFDoc_DimTolTool::IsLocked ( const TDF_Label & theViewL) const

    Returns true if the given GDT is marked as locked.

    ◆ Lock()

    void XCAFDoc_DimTolTool::Lock ( const TDF_Label & theViewL) const

    Mark the given GDT as locked.

    ◆ Set()

    occ::handle< XCAFDoc_DimTolTool > XCAFDoc_DimTolTool::Set ( const TDF_Label & L)
    static

    Creates (if not exist) DimTolTool attribute.

    ◆ SetDatum() [1/2]

    void XCAFDoc_DimTolTool::SetDatum ( const NCollection_Sequence< TDF_Label > & theShapeLabels,
    const TDF_Label & theDatumL ) const

    Sets a datum to the sequence of shape labels.

    ◆ SetDatum() [2/2]

    void XCAFDoc_DimTolTool::SetDatum ( const TDF_Label & theL,
    const TDF_Label & theTolerL,
    const occ::handle< TCollection_HAsciiString > & theName,
    const occ::handle< TCollection_HAsciiString > & theDescription,
    const occ::handle< TCollection_HAsciiString > & theIdentification ) const

    Sets a datum to theL label and binds it with theTolerL label. A datum with the specified name, description and identification is created if it isn't found in the GD&T table.

    ◆ SetDatumToGeomTol()

    void XCAFDoc_DimTolTool::SetDatumToGeomTol ( const TDF_Label & theDatumL,
    const TDF_Label & theTolerL ) const

    Sets a datum from theDatumL label to theToletL label.

    ◆ SetDimension() [1/3]

    void XCAFDoc_DimTolTool::SetDimension ( const NCollection_Sequence< TDF_Label > & theFirstLS,
    const NCollection_Sequence< TDF_Label > & theSecondLS,
    const TDF_Label & theDimL ) const

    Sets a dimension to sequences target labels.

    ◆ SetDimension() [2/3]

    void XCAFDoc_DimTolTool::SetDimension ( const TDF_Label & theFirstL,
    const TDF_Label & theSecondL,
    const TDF_Label & theDimL ) const

    Sets a dimension to target labels.

    ◆ SetDimension() [3/3]

    void XCAFDoc_DimTolTool::SetDimension ( const TDF_Label & theL,
    const TDF_Label & theDimL ) const

    Sets a dimension to the target label.

    ◆ SetDimTol() [1/2]

    TDF_Label XCAFDoc_DimTolTool::SetDimTol ( const TDF_Label & theL,
    const int theKind,
    const occ::handle< NCollection_HArray1< double > > & theVal,
    const occ::handle< TCollection_HAsciiString > & theName,
    const occ::handle< TCollection_HAsciiString > & theDescription ) const

    Creates a dimension tolerance and sets it to theL label.

    ◆ SetDimTol() [2/2]

    void XCAFDoc_DimTolTool::SetDimTol ( const TDF_Label & theL,
    const TDF_Label & theDimTolL ) const

    Sets existing dimension tolerance to theL label.

    ◆ SetGDTPresentations()

    void XCAFDoc_DimTolTool::SetGDTPresentations ( NCollection_IndexedDataMap< TDF_Label, TopoDS_Shape > & theGDTLabelToPrs)

    Set shape presentation for GDT labels according to given map (theGDTLabelToPrs) theGDTLabelToPrsName map is an additional argument, can be used to set presentation names. If label is not in the theGDTLabelToPrsName map, the presentation name will be empty.

    ◆ SetGeomTolerance() [1/2]

    void XCAFDoc_DimTolTool::SetGeomTolerance ( const NCollection_Sequence< TDF_Label > & theL,
    const TDF_Label & theGeomTolL ) const

    Sets a geometry tolerance from theGeomTolL to sequence of labels theL. Checks if theGeomTolL is a geometry tolerance definition first.

    ◆ SetGeomTolerance() [2/2]

    void XCAFDoc_DimTolTool::SetGeomTolerance ( const TDF_Label & theL,
    const TDF_Label & theGeomTolL ) const

    Sets a geometry tolerance from theGeomTolL to theL label. Checks if theGeomTolL is a geometry tolerance definition first.

    ◆ ShapeTool()

    const occ::handle< XCAFDoc_ShapeTool > & XCAFDoc_DimTolTool::ShapeTool ( )

    Returns internal XCAFDoc_ShapeTool tool.

    ◆ Unlock()

    void XCAFDoc_DimTolTool::Unlock ( const TDF_Label & theViewL) const

    Unlock the given GDT.


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