![]() |
Open CASCADE Technology Reference Manual 8.0.0
|
Defines sections structure of an XDE document. attribute marking CAF document as being DECAF document. Creates the sections structure of the document. More...
#include <XCAFDoc_DocumentTool.hxx>

Public Member Functions | |
| XCAFDoc_DocumentTool () | |
| void | Init () const |
| to be called when reading this attribute from file | |
| const Standard_GUID & | ID () const override |
| Returns the ID of the attribute. | |
| bool | AfterRetrieval (const bool forceIt=false) override |
| To init this derived attribute after the attribute restore using the base restore-methods. | |
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>. | |
| void | DumpJson (Standard_OStream &theOStream, int theDepth=-1) const override |
| Dumps the content of me into the stream. | |
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 | 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_Attribute > | BackupCopy () const |
| Copies the attribute contents into a new other attribute. It is used by Backup(). | |
| virtual occ::handle< TDF_DeltaOnAddition > | DeltaOnAddition () 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_DeltaOnForget > | DeltaOnForget () const |
| Makes an AttributeDelta because <me> has been forgotten. | |
| virtual occ::handle< TDF_DeltaOnResume > | DeltaOnResume () const |
| Makes an AttributeDelta because <me> has been resumed. | |
| virtual occ::handle< TDF_DeltaOnModification > | DeltaOnModification (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_DeltaOnRemoval > | DeltaOnRemoval () const |
| Makes a DeltaOnRemoval on <me> because <me> has disappeared from the DS. | |
| virtual occ::handle< TDF_Attribute > | NewEmpty () 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_OStream & | Dump (Standard_OStream &anOS) const |
| Dumps the minimum information about <me> on <aStream>. | |
| Standard_OStream & | operator<< (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_Transient & | operator= (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_Transient * | This () 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 const Standard_GUID & | GetID () |
| static occ::handle< XCAFDoc_DocumentTool > | Set (const TDF_Label &L, const bool IsAcces=true) |
| Create (if not exist) DocumentTool attribute on 0.1 label if <IsAcces> is true, else on <L> label. This label will be returned by DocLabel(); If the attribute is already set it won't be reset on <L> even if <IsAcces> is false. ColorTool and ShapeTool attributes are also set by this method. | |
| static bool | IsXCAFDocument (const occ::handle< TDocStd_Document > &Doc) |
| static TDF_Label | DocLabel (const TDF_Label &acces) |
| Returns label where the DocumentTool attribute is or 0.1 if DocumentTool is not yet set. | |
| static TDF_Label | ShapesLabel (const TDF_Label &acces) |
| Returns sub-label of DocLabel() with tag 1. | |
| static TDF_Label | ColorsLabel (const TDF_Label &acces) |
| Returns sub-label of DocLabel() with tag 2. | |
| static TDF_Label | LayersLabel (const TDF_Label &acces) |
| Returns sub-label of DocLabel() with tag 3. | |
| static TDF_Label | DGTsLabel (const TDF_Label &acces) |
| Returns sub-label of DocLabel() with tag 4. | |
| static TDF_Label | MaterialsLabel (const TDF_Label &acces) |
| Returns sub-label of DocLabel() with tag 5. | |
| static TDF_Label | ViewsLabel (const TDF_Label &acces) |
| Returns sub-label of DocLabel() with tag 7. | |
| static TDF_Label | ClippingPlanesLabel (const TDF_Label &acces) |
| Returns sub-label of DocLabel() with tag 8. | |
| static TDF_Label | NotesLabel (const TDF_Label &acces) |
| Returns sub-label of DocLabel() with tag 9. | |
| static TDF_Label | VisMaterialLabel (const TDF_Label &theLabel) |
| Returns sub-label of DocLabel() with tag 10. | |
| static occ::handle< XCAFDoc_ShapeTool > | ShapeTool (const TDF_Label &acces) |
| Creates (if it does not exist) ShapeTool attribute on ShapesLabel(). | |
| static bool | CheckShapeTool (const TDF_Label &theAcces) |
| Checks for the ShapeTool attribute on the label's document Returns TRUE if Tool exists, ELSE if it has not been created. | |
| static occ::handle< XCAFDoc_ColorTool > | ColorTool (const TDF_Label &acces) |
| Creates (if it does not exist) ColorTool attribute on ColorsLabel(). | |
| static bool | CheckColorTool (const TDF_Label &theAcces) |
| Checks for the ColorTool attribute on the label's document Returns TRUE if Tool exists, ELSE if it has not been created. | |
| static occ::handle< XCAFDoc_VisMaterialTool > | VisMaterialTool (const TDF_Label &theLabel) |
| Creates (if it does not exist) XCAFDoc_VisMaterialTool attribute on VisMaterialLabel(). Should not be confused with MaterialTool() defining physical/manufacturing materials. | |
| static bool | CheckVisMaterialTool (const TDF_Label &theAcces) |
| Checks for the VisMaterialTool attribute on the label's document Returns TRUE if Tool exists, ELSE if it has not been created. | |
| static occ::handle< XCAFDoc_LayerTool > | LayerTool (const TDF_Label &acces) |
| Creates (if it does not exist) LayerTool attribute on LayersLabel(). | |
| static bool | CheckLayerTool (const TDF_Label &theAcces) |
| Checks for the LayerTool attribute on the label's document Returns TRUE if Tool exists, ELSE if it has not been created. | |
| static occ::handle< XCAFDoc_DimTolTool > | DimTolTool (const TDF_Label &acces) |
| Creates (if it does not exist) DimTolTool attribute on DGTsLabel(). | |
| static bool | CheckDimTolTool (const TDF_Label &theAcces) |
| Checks for the DimTolTool attribute on the label's document Returns TRUE if Tool exists, ELSE if it has not been created. | |
| static occ::handle< XCAFDoc_MaterialTool > | MaterialTool (const TDF_Label &acces) |
| Creates (if it does not exist) DimTolTool attribute on DGTsLabel(). | |
| static bool | CheckMaterialTool (const TDF_Label &theAcces) |
| Checks for the MaterialTool attribute on the label's document Returns TRUE if Tool exists, ELSE if it has not been created. | |
| static occ::handle< XCAFDoc_ViewTool > | ViewTool (const TDF_Label &acces) |
| Creates (if it does not exist) ViewTool attribute on ViewsLabel(). | |
| static bool | CheckViewTool (const TDF_Label &theAcces) |
| Checks for the ViewTool attribute on the label's document Returns TRUE if Tool exists, ELSE if it has not been created. | |
| static occ::handle< XCAFDoc_ClippingPlaneTool > | ClippingPlaneTool (const TDF_Label &acces) |
| Creates (if it does not exist) ClippingPlaneTool attribute on ClippingPlanesLabel(). | |
| static bool | CheckClippingPlaneTool (const TDF_Label &theAcces) |
| Checks for the ClippingPlaneTool attribute on the label's document Returns TRUE if Tool exists, ELSE if it has not been created. | |
| static occ::handle< XCAFDoc_NotesTool > | NotesTool (const TDF_Label &acces) |
| Creates (if it does not exist) NotesTool attribute on NotesLabel(). | |
| static bool | CheckNotesTool (const TDF_Label &theAcces) |
| Checks for the NotesTool attribute on the label's document Returns TRUE if Tool exists, ELSE if it has not been created. | |
| static bool | GetLengthUnit (const occ::handle< TDocStd_Document > &theDoc, double &theResut, const UnitsMethods_LengthUnit theBaseUnit) |
| Returns value of current internal unit for the document converted to base unit type. | |
| static bool | GetLengthUnit (const occ::handle< TDocStd_Document > &theDoc, double &theResut) |
| Returns value of current internal unit for the document in meter. | |
| static void | SetLengthUnit (const occ::handle< TDocStd_Document > &theDoc, const double theUnitValue) |
| Sets value of current internal unit to the document in meter. | |
| static void | SetLengthUnit (const occ::handle< TDocStd_Document > &theDoc, const double theUnitValue, const UnitsMethods_LengthUnit theBaseUnit) |
| Sets value of current internal unit to the document. | |
Static Public Member Functions inherited from Standard_Transient | |
| 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 | |
Public Types inherited from Standard_Transient | |
| typedef void | base_type |
| Returns a type descriptor about this object. | |
Protected Member Functions inherited from TDF_Attribute | |
| TDF_Attribute () | |
| Initializes fields. | |
Defines sections structure of an XDE document. attribute marking CAF document as being DECAF document. Creates the sections structure of the document.
| XCAFDoc_DocumentTool::XCAFDoc_DocumentTool | ( | ) |
To init this derived attribute after the attribute restore using the base restore-methods.
Reimplemented from TDF_Attribute.
Checks for the ClippingPlaneTool attribute on the label's document Returns TRUE if Tool exists, ELSE if it has not been created.
Checks for the ColorTool attribute on the label's document Returns TRUE if Tool exists, ELSE if it has not been created.
Checks for the DimTolTool attribute on the label's document Returns TRUE if Tool exists, ELSE if it has not been created.
Checks for the LayerTool attribute on the label's document Returns TRUE if Tool exists, ELSE if it has not been created.
Checks for the MaterialTool attribute on the label's document Returns TRUE if Tool exists, ELSE if it has not been created.
Checks for the NotesTool attribute on the label's document Returns TRUE if Tool exists, ELSE if it has not been created.
Checks for the ShapeTool attribute on the label's document Returns TRUE if Tool exists, ELSE if it has not been created.
Checks for the ViewTool attribute on the label's document Returns TRUE if Tool exists, ELSE if it has not been created.
Checks for the VisMaterialTool attribute on the label's document Returns TRUE if Tool exists, ELSE if it has not been created.
Returns sub-label of DocLabel() with tag 8.
|
static |
Creates (if it does not exist) ClippingPlaneTool attribute on ClippingPlanesLabel().
Returns sub-label of DocLabel() with tag 2.
|
static |
Creates (if it does not exist) ColorTool attribute on ColorsLabel().
Returns sub-label of DocLabel() with tag 4.
|
static |
Creates (if it does not exist) DimTolTool attribute on DGTsLabel().
Returns label where the DocumentTool attribute is or 0.1 if DocumentTool is not yet set.
|
static |
|
static |
Returns value of current internal unit for the document in meter.
|
static |
Returns value of current internal unit for the document converted to base unit type.
|
overridevirtual |
Returns the ID of the attribute.
Implements TDF_Attribute.
| void XCAFDoc_DocumentTool::Init | ( | ) | const |
to be called when reading this attribute from file
|
static |
Returns sub-label of DocLabel() with tag 3.
|
static |
Creates (if it does not exist) LayerTool attribute on LayersLabel().
Returns sub-label of DocLabel() with tag 5.
|
static |
Creates (if it does not exist) DimTolTool attribute on DGTsLabel().
Returns sub-label of DocLabel() with tag 9.
|
static |
Creates (if it does not exist) NotesTool attribute on NotesLabel().
|
static |
Create (if not exist) DocumentTool attribute on 0.1 label if <IsAcces> is true, else on <L> label. This label will be returned by DocLabel(); If the attribute is already set it won't be reset on <L> even if <IsAcces> is false. ColorTool and ShapeTool attributes are also set by this method.
|
static |
Sets value of current internal unit to the document in meter.
|
static |
Sets value of current internal unit to the document.
| theUnitValue | must be represented in the base unit type |
Returns sub-label of DocLabel() with tag 1.
|
static |
Creates (if it does not exist) ShapeTool attribute on ShapesLabel().
Returns sub-label of DocLabel() with tag 7.
|
static |
Creates (if it does not exist) ViewTool attribute on ViewsLabel().
Returns sub-label of DocLabel() with tag 10.
|
static |
Creates (if it does not exist) XCAFDoc_VisMaterialTool attribute on VisMaterialLabel(). Should not be confused with MaterialTool() defining physical/manufacturing materials.