Defines sections structure of an XDE document. attribute marking CAF document as being DECAF document. Creates the sections structure of the document.  
 More...
 | 
|   | 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.  
  | 
|   | 
| Standard_Boolean  | AfterRetrieval (const Standard_Boolean forceIt=Standard_False) override | 
|   | To init this derived attribute after the attribute restore using the base restore-methods.  
  | 
|   | 
| void  | Restore (const Handle< TDF_Attribute > &) override | 
|   | Restores the backuped contents from <anAttribute> into this one. It is used when aborting a transaction.  
  | 
|   | 
| void  | Paste (const Handle< TDF_Attribute > &, const 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>.  
  | 
|   | 
| virtual void  | DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const override | 
|   | Dumps the content of me into the stream.  
  | 
|   | 
| 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.  
  | 
|   | 
| Standard_Integer  | Transaction () const | 
|   | Returns the transaction index in which the attribute has been created or modified.  
  | 
|   | 
| Standard_Integer  | 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.  
  | 
|   | 
| Standard_Boolean  | IsValid () const | 
|   | Returns true if the attribute is valid; i.e. not a backuped or removed one.  
  | 
|   | 
| Standard_Boolean  | IsNew () const | 
|   | Returns true if the attribute has no backup.  
  | 
|   | 
| Standard_Boolean  | IsForgotten () const | 
|   | Returns true if the attribute forgotten status is set.  
  | 
|   | 
| Standard_Boolean  | IsAttribute (const Standard_GUID &anID) const | 
|   | Returns true if it exists an associated attribute of <me> with <anID> as ID.  
  | 
|   | 
| Standard_Boolean  | FindAttribute (const Standard_GUID &anID, 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 >  | 
| Standard_Boolean  | FindAttribute (const Standard_GUID &theID, Handle< T > &theAttr) const | 
|   | Safe variant for arbitrary type of argument.  
  | 
|   | 
| void  | AddAttribute (const Handle< TDF_Attribute > &other) const | 
|   | Adds an Attribute <other> to the label of <me>.Raises if there is already one of the same GUID fhan <other>.  
  | 
|   | 
| Standard_Boolean  | 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 Standard_Boolean clearChildren=Standard_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 Standard_Boolean  | BeforeUndo (const Handle< TDF_AttributeDelta > &anAttDelta, const Standard_Boolean forceIt=Standard_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 Standard_Boolean  | AfterUndo (const Handle< TDF_AttributeDelta > &anAttDelta, const Standard_Boolean forceIt=Standard_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".  
  | 
|   | 
| Standard_Boolean  | IsBackuped () const | 
|   | Returns true if the attribute backup status is set. This status is set/unset by the Backup() method.  
  | 
|   | 
| virtual Handle< TDF_Attribute >  | BackupCopy () const | 
|   | Copies the attribute contents into a new other attribute. It is used by Backup().  
  | 
|   | 
| virtual 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 Handle< TDF_DeltaOnForget >  | DeltaOnForget () const | 
|   | Makes an AttributeDelta because <me> has been forgotten.  
  | 
|   | 
| virtual Handle< TDF_DeltaOnResume >  | DeltaOnResume () const | 
|   | Makes an AttributeDelta because <me> has been resumed.  
  | 
|   | 
| virtual Handle< TDF_DeltaOnModification >  | DeltaOnModification (const Handle< TDF_Attribute > &anOldAttribute) const | 
|   | Makes a DeltaOnModification between <me> and.  
  | 
|   | 
| virtual void  | DeltaOnModification (const Handle< TDF_DeltaOnModification > &aDelta) | 
|   | Applies a DeltaOnModification to <me>.  
  | 
|   | 
| virtual Handle< TDF_DeltaOnRemoval >  | DeltaOnRemoval () const | 
|   | Makes a DeltaOnRemoval on <me> because <me> has disappeared from the DS.  
  | 
|   | 
| virtual 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 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, TDF_AttributeIndexedMap &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 Standard_Integer 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 () | 
|   | Destructor must be virtual.  
  | 
|   | 
| virtual const opencascade::handle< Standard_Type > &  | DynamicType () const | 
|   | Returns a type descriptor about this object.  
  | 
|   | 
| Standard_Boolean  | IsInstance (const opencascade::handle< Standard_Type > &theType) const | 
|   | Returns a true value if this is an instance of Type.  
  | 
|   | 
| Standard_Boolean  | IsInstance (const Standard_CString theTypeName) const | 
|   | Returns a true value if this is an instance of TypeName.  
  | 
|   | 
| Standard_Boolean  | 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.  
  | 
|   | 
| Standard_Boolean  | IsKind (const Standard_CString 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.  
  | 
|   | 
| Standard_Integer  | GetRefCount () const noexcept | 
|   | Get the reference counter of this object.  
  | 
|   | 
| void  | IncrementRefCounter () noexcept | 
|   | Increments the reference counter of this object.  
  | 
|   | 
| Standard_Integer  | DecrementRefCounter () noexcept | 
|   | Decrements the reference counter of this object; returns the decremented value.  
  | 
|   | 
| virtual void  | Delete () const | 
|   | Memory deallocator for transient classes.  
  | 
|   | 
 | 
| static const Standard_GUID &  | GetID () | 
|   | 
| static Handle< XCAFDoc_DocumentTool >  | Set (const TDF_Label &L, const Standard_Boolean IsAcces=Standard_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 Standard_Boolean  | IsXCAFDocument (const 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 Handle< XCAFDoc_ShapeTool >  | ShapeTool (const TDF_Label &acces) | 
|   | Creates (if it does not exist) ShapeTool attribute on ShapesLabel().  
  | 
|   | 
| static Standard_Boolean  | 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 Handle< XCAFDoc_ColorTool >  | ColorTool (const TDF_Label &acces) | 
|   | Creates (if it does not exist) ColorTool attribute on ColorsLabel().  
  | 
|   | 
| static Standard_Boolean  | 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 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 Standard_Boolean  | 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 Handle< XCAFDoc_LayerTool >  | LayerTool (const TDF_Label &acces) | 
|   | Creates (if it does not exist) LayerTool attribute on LayersLabel().  
  | 
|   | 
| static Standard_Boolean  | 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 Handle< XCAFDoc_DimTolTool >  | DimTolTool (const TDF_Label &acces) | 
|   | Creates (if it does not exist) DimTolTool attribute on DGTsLabel().  
  | 
|   | 
| static Standard_Boolean  | 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 Handle< XCAFDoc_MaterialTool >  | MaterialTool (const TDF_Label &acces) | 
|   | Creates (if it does not exist) DimTolTool attribute on DGTsLabel().  
  | 
|   | 
| static Standard_Boolean  | 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 Handle< XCAFDoc_ViewTool >  | ViewTool (const TDF_Label &acces) | 
|   | Creates (if it does not exist) ViewTool attribute on ViewsLabel().  
  | 
|   | 
| static Standard_Boolean  | 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 Handle< XCAFDoc_ClippingPlaneTool >  | ClippingPlaneTool (const TDF_Label &acces) | 
|   | Creates (if it does not exist) ClippingPlaneTool attribute on ClippingPlanesLabel().  
  | 
|   | 
| static Standard_Boolean  | 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 Handle< XCAFDoc_NotesTool >  | NotesTool (const TDF_Label &acces) | 
|   | Creates (if it does not exist) NotesTool attribute on NotesLabel().  
  | 
|   | 
| static Standard_Boolean  | 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 Standard_Boolean  | GetLengthUnit (const Handle< TDocStd_Document > &theDoc, Standard_Real &theResut, const UnitsMethods_LengthUnit theBaseUnit) | 
|   | Returns value of current internal unit for the document converted to base unit type.  
  | 
|   | 
| static Standard_Boolean  | GetLengthUnit (const Handle< TDocStd_Document > &theDoc, Standard_Real &theResut) | 
|   | Returns value of current internal unit for the document in meter.  
  | 
|   | 
| static void  | SetLengthUnit (const Handle< TDocStd_Document > &theDoc, const Standard_Real theUnitValue) | 
|   | Sets value of current internal unit to the document in meter.  
  | 
|   | 
| static void  | SetLengthUnit (const Handle< TDocStd_Document > &theDoc, const Standard_Real 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.  
  | 
|   | 
Defines sections structure of an XDE document. attribute marking CAF document as being DECAF document. Creates the sections structure of the document.