mirror of
https://github.com/Open-Cascade-SAS/OCCT.git
synced 2026-09-07 13:18:19 +08:00
Documentation - Fix whitespace and typos (#805)
- Corrected spelling of "transfert" to "transfer" throughout IGES-related files - Fixed various grammatical and punctuation errors in comments - Improved whitespace and formatting in multi-line comments
This commit is contained in:
luzpaz
@@ -30,9 +30,9 @@ class TCollection_ExtendedString;
|
||||
//! The feature structure is a tree used to bind
|
||||
//! semantic information about each feature together.
|
||||
//!
|
||||
//! The only one concrete attribute defined in this
|
||||
//! The only one concrete attribute defined in this
|
||||
//! package is the TagSource attribute.This attribute
|
||||
//! is used for random creation of child labels under
|
||||
//! is used for random creation of child labels under
|
||||
//! a given label. Tags are randomly delivered.
|
||||
class TDF
|
||||
{
|
||||
|
||||
@@ -123,7 +123,7 @@ DEFINE_STANDARD_HANDLE(TDF_Attribute, Standard_Transient)
|
||||
//! ---------------
|
||||
//!
|
||||
//! An AttributeDelta is the difference between to
|
||||
//! attribute values states. These methods must be
|
||||
//! attribute values states. These methods must be
|
||||
//! implemented by end use inheriting classes, to
|
||||
//! profit from the delta services.
|
||||
class TDF_Attribute : public Standard_Transient
|
||||
@@ -140,10 +140,10 @@ public:
|
||||
//! Sets default ID defined in nested class (to be used for attributes having User ID feature).
|
||||
virtual void SetID() {}
|
||||
|
||||
//! Returns the label to which the attribute is
|
||||
//! attached. If the label is not included in a DF,
|
||||
//! 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
|
||||
//! Warning:
|
||||
//! If the label is not included in a data
|
||||
//! framework, it is null.
|
||||
//! This function should not be redefined inline.
|
||||
@@ -173,15 +173,15 @@ public:
|
||||
//! =================================================
|
||||
Standard_Boolean IsForgotten() const;
|
||||
|
||||
//! Returns true if it exists an associated attribute
|
||||
//! Returns true if it exists an associated attribute
|
||||
//! of <me> with <anID> as ID.
|
||||
Standard_EXPORT Standard_Boolean IsAttribute(const Standard_GUID& anID) 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.
|
||||
//! 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.
|
||||
Standard_EXPORT Standard_Boolean FindAttribute(const Standard_GUID& anID,
|
||||
Handle(TDF_Attribute)& anAttribute) const;
|
||||
|
||||
@@ -193,23 +193,23 @@ public:
|
||||
return FindAttribute(theID, anAttr) && !(theAttr = Handle(T)::DownCast(anAttr)).IsNull();
|
||||
}
|
||||
|
||||
//! Adds an Attribute <other> to the label of
|
||||
//! <me>.Raises if there is already one of the same
|
||||
//! GUID fhan <other>.
|
||||
//! Adds an Attribute <other> to the label of <me>.
|
||||
//! Raises if there is already one of the same GUID
|
||||
//! than <other>.
|
||||
Standard_EXPORT void AddAttribute(const Handle(TDF_Attribute)& other) const;
|
||||
|
||||
//! Forgets the Attribute of GUID <aguid> associated
|
||||
//! to the label of <me>. Be careful that if <me> is
|
||||
//! 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
|
||||
//! after this call. If the attribute doesn't exist
|
||||
//! returns False. Otherwise returns True.
|
||||
Standard_EXPORT Standard_Boolean ForgetAttribute(const Standard_GUID& aguid) 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
|
||||
//! 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
|
||||
Standard_EXPORT void ForgetAllAttributes(
|
||||
const Standard_Boolean clearChildren = Standard_True) const;
|
||||
|
||||
@@ -33,12 +33,12 @@ class TDF_ChildIterator
|
||||
public:
|
||||
DEFINE_STANDARD_ALLOC
|
||||
|
||||
//! Creates an empty iterator object to
|
||||
//! Creates an empty iterator object to
|
||||
//! explore the children of a label.
|
||||
Standard_EXPORT TDF_ChildIterator();
|
||||
|
||||
//! Constructs the iterator object defined by
|
||||
//! the label aLabel. Iterates on the children of the given label. If
|
||||
//! the label aLabel. Iterates on the children of the given label. If
|
||||
//! <allLevels> option is set to true, it explores not
|
||||
//! only the first, but all the sub label levels.
|
||||
Standard_EXPORT TDF_ChildIterator(const TDF_Label& aLabel,
|
||||
@@ -74,7 +74,7 @@ public:
|
||||
//! iteration process.
|
||||
Standard_Boolean More() const;
|
||||
|
||||
//! Move the current iteration to the next Item.
|
||||
//! Move the current iteration to the next Item.
|
||||
Standard_EXPORT void Next();
|
||||
|
||||
//! Moves this iteration to the next brother
|
||||
|
||||
@@ -81,7 +81,7 @@ public:
|
||||
//!
|
||||
//! <anOption> may take the following values:
|
||||
//! 1 : labels treatment only;
|
||||
//! 2 : attributes treatment only(default value);
|
||||
//! 2 : attributes treatment only (default value);
|
||||
//! 3 : both labels & attributes treatment.
|
||||
Standard_EXPORT static Standard_Boolean TargetUnbound(
|
||||
const Handle(TDF_DataSet)& aRefDataSet,
|
||||
|
||||
@@ -27,42 +27,42 @@
|
||||
class TDF_RelocationTable;
|
||||
class TDF_DataSet;
|
||||
|
||||
//! This class gives copy of source label hierarchy
|
||||
//! This class gives copy of source label hierarchy
|
||||
class TDF_CopyLabel
|
||||
{
|
||||
public:
|
||||
DEFINE_STANDARD_ALLOC
|
||||
|
||||
//! Empty constructor
|
||||
//! Empty constructor
|
||||
Standard_EXPORT TDF_CopyLabel();
|
||||
|
||||
//! CopyTool
|
||||
Standard_EXPORT TDF_CopyLabel(const TDF_Label& aSource, const TDF_Label& aTarget);
|
||||
|
||||
//! Loads src and tgt labels
|
||||
//! Loads src and tgt labels
|
||||
Standard_EXPORT void Load(const TDF_Label& aSource, const TDF_Label& aTarget);
|
||||
|
||||
//! Sets filter
|
||||
//! Sets filter
|
||||
Standard_EXPORT void UseFilter(const TDF_IDFilter& aFilter);
|
||||
|
||||
//! Check external references and if exist fills the aExternals Map
|
||||
//! Check external references and if exist fills the aExternals Map
|
||||
Standard_EXPORT static Standard_Boolean ExternalReferences(const TDF_Label& Lab,
|
||||
TDF_AttributeMap& aExternals,
|
||||
const TDF_IDFilter& aFilter);
|
||||
|
||||
//! Check external references and if exist fills the aExternals Map
|
||||
//! Check external references and if exist fills the aExternals Map
|
||||
Standard_EXPORT static void ExternalReferences(const TDF_Label& aRefLab,
|
||||
const TDF_Label& Lab,
|
||||
TDF_AttributeMap& aExternals,
|
||||
const TDF_IDFilter& aFilter,
|
||||
Handle(TDF_DataSet)& aDataSet);
|
||||
|
||||
//! performs algorithm of selfcontained copy
|
||||
//! performs algorithm of selfcontained copy
|
||||
Standard_EXPORT void Perform();
|
||||
|
||||
Standard_Boolean IsDone() const;
|
||||
|
||||
//! returns relocation table
|
||||
//! returns relocation table
|
||||
Standard_EXPORT const Handle(TDF_RelocationTable)& RelocationTable() const;
|
||||
|
||||
protected:
|
||||
|
||||
@@ -69,30 +69,30 @@ class TDF_CopyTool
|
||||
public:
|
||||
DEFINE_STANDARD_ALLOC
|
||||
|
||||
//! Copy <aSourceDataSet> with using and updating
|
||||
//! <aRelocationTable>. This method ignores target
|
||||
//! Copy <aSourceDataSet> with using and updating
|
||||
//! <aRelocationTable>. This method ignores target
|
||||
//! attributes privilege over source ones.
|
||||
Standard_EXPORT static void Copy(const Handle(TDF_DataSet)& aSourceDataSet,
|
||||
const Handle(TDF_RelocationTable)& aRelocationTable);
|
||||
|
||||
//! Copy <aSourceDataSet> using and updating
|
||||
//! Copy <aSourceDataSet> using and updating
|
||||
//! <aRelocationTable>. Use <aPrivilegeFilter> to give
|
||||
//! a list of IDs for which the target attribute
|
||||
//! a list of IDs for which the target attribute
|
||||
//! prevails over the source one.
|
||||
Standard_EXPORT static void Copy(const Handle(TDF_DataSet)& aSourceDataSet,
|
||||
const Handle(TDF_RelocationTable)& aRelocationTable,
|
||||
const TDF_IDFilter& aPrivilegeFilter);
|
||||
|
||||
//! Copy <aSourceDataSet> using and updating
|
||||
//! Copy <aSourceDataSet> using and updating
|
||||
//! <aRelocationTable>. Use <aPrivilegeFilter> to give
|
||||
//! a list of IDs for which the target attribute
|
||||
//! prevails over the source one. If
|
||||
//! <setSelfContained> is set to true, every
|
||||
//! TDF_Reference will be replaced by the referenced
|
||||
//! structure according to <aRefFilter>.
|
||||
//! a list of IDs for which the target attribute
|
||||
//! prevails over the source one. If <setSelfContained>
|
||||
//! is set to true, every TDF_Reference will be
|
||||
//! replaced by the referenced structure
|
||||
//! according to <aRefFilter>.
|
||||
//!
|
||||
//! NB: <aRefFilter> is used only if
|
||||
//! <setSelfContained> is true.
|
||||
//! NB: <aRefFilter> is used only if <setSelfContained>
|
||||
//! is true.
|
||||
//! Internal root label copy recursive method.
|
||||
Standard_EXPORT static void Copy(const Handle(TDF_DataSet)& aSourceDataSet,
|
||||
const Handle(TDF_RelocationTable)& aRelocationTable,
|
||||
|
||||
@@ -35,7 +35,7 @@ class TDF_DataSet : public Standard_Transient
|
||||
{
|
||||
|
||||
public:
|
||||
//! Creates an empty DataSet object.
|
||||
//! Creates an empty DataSet object.
|
||||
Standard_EXPORT TDF_DataSet();
|
||||
|
||||
//! Clears all information.
|
||||
@@ -45,23 +45,23 @@ public:
|
||||
//! attribute.
|
||||
Standard_Boolean IsEmpty() const;
|
||||
|
||||
//! Adds <aLabel> in the current data set.
|
||||
//! Adds <aLabel> in the current data set.
|
||||
void AddLabel(const TDF_Label& aLabel);
|
||||
|
||||
//! Returns true if the label <alabel> is in the data set.
|
||||
//! Returns true if the label <alabel> is in the data set.
|
||||
Standard_Boolean ContainsLabel(const TDF_Label& aLabel) const;
|
||||
|
||||
//! Returns the map of labels in this data set.
|
||||
//! This map can be used directly, or updated.
|
||||
TDF_LabelMap& Labels();
|
||||
|
||||
//! Adds <anAttribute> into the current data set.
|
||||
//! Adds <anAttribute> into the current data set.
|
||||
void AddAttribute(const Handle(TDF_Attribute)& anAttribute);
|
||||
|
||||
//! Returns true if <anAttribute> is in the data set.
|
||||
Standard_Boolean ContainsAttribute(const Handle(TDF_Attribute)& anAttribute) const;
|
||||
|
||||
//! Returns the map of attributes in the current data set.
|
||||
//! Returns the map of attributes in the current data set.
|
||||
//! This map can be used directly, or updated.
|
||||
TDF_AttributeMap& Attributes();
|
||||
|
||||
|
||||
@@ -30,7 +30,7 @@ class TDF_Data;
|
||||
class Standard_GUID;
|
||||
class TDF_IDFilter;
|
||||
|
||||
//! This class provides basic operations to define
|
||||
//! This class provides basic operations to define
|
||||
//! a label in a data structure.
|
||||
//! A label is a feature in the feature hierarchy. A
|
||||
//! label is always connected to a Data from TDF.
|
||||
@@ -217,7 +217,7 @@ public:
|
||||
Standard_EXPORT TDF_Label FindChild(const Standard_Integer aTag,
|
||||
const Standard_Boolean create = Standard_True) const;
|
||||
|
||||
//! Create a new child label of me using autoamtic
|
||||
//! Create a new child label of me using automatic
|
||||
//! delivery tags provided by TagSource.
|
||||
TDF_Label NewChild() const;
|
||||
|
||||
|
||||
@@ -28,7 +28,7 @@ class TDF_DataSet;
|
||||
class TDF_Reference;
|
||||
DEFINE_STANDARD_HANDLE(TDF_Reference, TDF_Attribute)
|
||||
|
||||
//! This attribute is used to store in the framework a
|
||||
//! This attribute is used to store in the framework a
|
||||
//! reference to an other label.
|
||||
class TDF_Reference : public TDF_Attribute
|
||||
{
|
||||
|
||||
@@ -29,7 +29,7 @@ class TDF_RelocationTable;
|
||||
class TDF_TagSource;
|
||||
DEFINE_STANDARD_HANDLE(TDF_TagSource, TDF_Attribute)
|
||||
|
||||
//! This attribute manage a tag provider to create
|
||||
//! This attribute manage a tag provider to create
|
||||
//! child labels of a given one.
|
||||
class TDF_TagSource : public TDF_Attribute
|
||||
{
|
||||
@@ -39,11 +39,11 @@ public:
|
||||
//! =============
|
||||
Standard_EXPORT static const Standard_GUID& GetID();
|
||||
|
||||
//! Find, or create, a TagSource attribute. the TagSource
|
||||
//! Find, or create, a TagSource attribute. the TagSource
|
||||
//! attribute is returned.
|
||||
Standard_EXPORT static Handle(TDF_TagSource) Set(const TDF_Label& label);
|
||||
|
||||
//! Find (or create) a tagSource attribute located at <L>
|
||||
//! Find (or create) a tagSource attribute located at <L>
|
||||
//! and make a new child label.
|
||||
//! TagSource methods
|
||||
//! =================
|
||||
|
||||
@@ -25,7 +25,7 @@
|
||||
#include <Standard_OStream.hxx>
|
||||
#include <TDataStd_RealEnum.hxx>
|
||||
|
||||
//! This package defines standard attributes for
|
||||
//! This package defines standard attributes for
|
||||
//! modelling.
|
||||
//! These allow you to create and modify labels
|
||||
//! and attributes for many basic data types.
|
||||
|
||||
@@ -25,10 +25,10 @@ DEFINE_STANDARD_HANDLE(TDataStd_Relation, TDataStd_Expression)
|
||||
//! Relation attribute.
|
||||
//! ==================
|
||||
//!
|
||||
//! * Data Structure of the Expression is stored in a
|
||||
//! * Data Structure of the Expression is stored in a
|
||||
//! string and references to variables used by the string
|
||||
//!
|
||||
//! Warning: To be consistent, each Variable referenced by the
|
||||
//! Warning: To be consistent, each Variable referenced by the
|
||||
//! relation must have its equivalent in the string
|
||||
class TDataStd_Relation : public TDataStd_Expression
|
||||
{
|
||||
|
||||
@@ -50,19 +50,19 @@ public:
|
||||
Standard_EXPORT static Standard_Boolean Find(const TDF_Label& L, Handle(TDataStd_TreeNode)& T);
|
||||
|
||||
//! Finds or Creates a TreeNode attribute on the label <L>
|
||||
//! with the default tree ID, returned by the method
|
||||
//! <GetDefaultTreeID>. Returns the created/found TreeNode
|
||||
//! with the default tree ID, returned by the method
|
||||
//! <GetDefaultTreeID>. Returns the created/found TreeNode
|
||||
//! attribute.
|
||||
Standard_EXPORT static Handle(TDataStd_TreeNode) Set(const TDF_Label& L);
|
||||
|
||||
//! Finds or Creates a TreeNode attribute on the label
|
||||
//! <L>, with an explicit tree ID. <ExplicitTreeID> is
|
||||
//! the ID returned by <TDF_Attribute::ID> method.
|
||||
//! Finds or Creates a TreeNode attribute on the label
|
||||
//! <L>, with an explicit tree ID. <ExplicitTreeID> is
|
||||
//! the ID returned by <TDF_Attribute::ID> method.
|
||||
//! Returns the found/created TreeNode attribute.
|
||||
Standard_EXPORT static Handle(TDataStd_TreeNode) Set(const TDF_Label& L,
|
||||
const Standard_GUID& ExplicitTreeID);
|
||||
|
||||
//! returns a default tree ID. this ID is used by the
|
||||
//! returns a default tree ID. this ID is used by the
|
||||
//! <Set> method without explicit tree ID.
|
||||
//! Instance methods:
|
||||
//! ================
|
||||
@@ -70,19 +70,19 @@ public:
|
||||
|
||||
Standard_EXPORT TDataStd_TreeNode();
|
||||
|
||||
//! Insert the TreeNode <Child> as last child of <me>. If
|
||||
//! Insert the TreeNode <Child> as last child of <me>. If
|
||||
//! the insertion is successful <me> becomes the Father of <Child>.
|
||||
Standard_EXPORT Standard_Boolean Append(const Handle(TDataStd_TreeNode)& Child);
|
||||
|
||||
//! Insert the the TreeNode <Child> as first child of
|
||||
//! Insert the the TreeNode <Child> as first child of
|
||||
//! <me>. If the insertion is successful <me> becomes the Father of <Child>
|
||||
Standard_EXPORT Standard_Boolean Prepend(const Handle(TDataStd_TreeNode)& Child);
|
||||
|
||||
//! Inserts the TreeNode <Node> before <me>. If insertion is successful <me>
|
||||
//! Inserts the TreeNode <Node> before <me>. If insertion is successful <me>
|
||||
//! and <Node> belongs to the same Father.
|
||||
Standard_EXPORT Standard_Boolean InsertBefore(const Handle(TDataStd_TreeNode)& Node);
|
||||
|
||||
//! Inserts the TreeNode <Node> after <me>. If insertion is successful <me>
|
||||
//! Inserts the TreeNode <Node> after <me>. If insertion is successful <me>
|
||||
//! and <Node> belongs to the same Father.
|
||||
Standard_EXPORT Standard_Boolean InsertAfter(const Handle(TDataStd_TreeNode)& Node);
|
||||
|
||||
|
||||
@@ -38,14 +38,14 @@ DEFINE_STANDARD_HANDLE(TDataStd_Variable, TDF_Attribute)
|
||||
//! Variable attribute.
|
||||
//! ==================
|
||||
//!
|
||||
//! * A variable is associated to a TDataStd_Real (which
|
||||
//! contains its current value) and a TDataStd_Name
|
||||
//! attribute (which contains its name). It contains a
|
||||
//! * A variable is associated to a TDataStd_Real (which
|
||||
//! contains its current value) and a TDataStd_Name
|
||||
//! attribute (which contains its name). It contains a
|
||||
//! constant flag, and a Unit
|
||||
//!
|
||||
//! * An expression may be assigned to a variable. In
|
||||
//! thatcase the expression is handled by the associated
|
||||
//! Expression Attribute and the Variable returns True to
|
||||
//! * An expression may be assigned to a variable. In
|
||||
//! thatcase the expression is handled by the associated
|
||||
//! Expression Attribute and the Variable returns True to
|
||||
//! the method <IsAssigned>.
|
||||
class TDataStd_Variable : public TDF_Attribute
|
||||
{
|
||||
@@ -55,23 +55,23 @@ public:
|
||||
//! =============
|
||||
Standard_EXPORT static const Standard_GUID& GetID();
|
||||
|
||||
//! Find, or create, a Variable attribute.
|
||||
//! Find, or create, a Variable attribute.
|
||||
//! Real methods
|
||||
//! ============
|
||||
Standard_EXPORT static Handle(TDataStd_Variable) Set(const TDF_Label& label);
|
||||
|
||||
Standard_EXPORT TDataStd_Variable();
|
||||
|
||||
//! set or change the name of the variable, in myUnknown
|
||||
//! set or change the name of the variable, in myUnknown
|
||||
//! and my associated Name attribute.
|
||||
Standard_EXPORT void Name(const TCollection_ExtendedString& string);
|
||||
|
||||
//! returns string stored in the associated Name
|
||||
//! returns string stored in the associated Name
|
||||
//! attribute.
|
||||
Standard_EXPORT const TCollection_ExtendedString& Name() const;
|
||||
|
||||
//! retrieve or create the associated real attribute and
|
||||
//! set the value <value>.
|
||||
//! retrieve or create the associated real attribute and
|
||||
//! set the value <value>.
|
||||
Standard_EXPORT void Set(const Standard_Real value) const;
|
||||
|
||||
//! Obsolete method that will be removed in next versions.
|
||||
@@ -94,15 +94,15 @@ public:
|
||||
//! expression attribute.
|
||||
Standard_EXPORT Standard_Boolean IsAssigned() const;
|
||||
|
||||
//! create(if doesn't exist) and returns the assigned
|
||||
//! create(if doesn't exist) and returns the assigned
|
||||
//! expression attribute. fill it after.
|
||||
Standard_EXPORT Handle(TDataStd_Expression) Assign() const;
|
||||
|
||||
//! if <me> is assigned delete the associated expression
|
||||
//! if <me> is assigned delete the associated expression
|
||||
//! attribute.
|
||||
Standard_EXPORT void Desassign() const;
|
||||
|
||||
//! if <me> is assigned, returns associated Expression
|
||||
//! if <me> is assigned, returns associated Expression
|
||||
//! attribute.
|
||||
Standard_EXPORT Handle(TDataStd_Expression) Expression() const;
|
||||
|
||||
@@ -118,7 +118,7 @@ public:
|
||||
//! ===================
|
||||
Standard_EXPORT const TCollection_AsciiString& Unit() const;
|
||||
|
||||
//! if <status> is True, this variable will not be
|
||||
//! if <status> is True, this variable will not be
|
||||
//! modified by the solver.
|
||||
Standard_EXPORT void Constant(const Standard_Boolean status);
|
||||
|
||||
|
||||
@@ -23,7 +23,7 @@
|
||||
|
||||
#include <TDF_IDList.hxx>
|
||||
|
||||
//! This package define CAF main classes.
|
||||
//! This package define CAF main classes.
|
||||
//!
|
||||
//! * The standard application root class
|
||||
//!
|
||||
@@ -46,9 +46,9 @@
|
||||
//! sum up, standard documents alone provide
|
||||
//! access to the data framework. They also allow
|
||||
//! you to:
|
||||
//! - Update external links
|
||||
//! - Manage the saving and opening of data
|
||||
//! - Manage undo/redo functionality.
|
||||
//! - Update external links
|
||||
//! - Manage the saving and opening of data
|
||||
//! - Manage undo/redo functionality.
|
||||
//! Note
|
||||
//! For information on the relations between this
|
||||
//! component of OCAF and the others, refer to the
|
||||
|
||||
@@ -272,8 +272,8 @@ public:
|
||||
return Open(theIStream, theDoc, Handle(PCDM_ReaderFilter)(), theRange);
|
||||
}
|
||||
|
||||
//! Save the active document in the file <name> in the
|
||||
//! path <path> ; o verwrites the file if it already exists.
|
||||
//! Save the active document in the file <name> in the
|
||||
//! path <path>. overwrites the file if it already exists.
|
||||
Standard_EXPORT PCDM_StoreStatus
|
||||
SaveAs(const Handle(TDocStd_Document)& theDoc,
|
||||
const TCollection_ExtendedString& path,
|
||||
|
||||
@@ -49,7 +49,7 @@ class TDocStd_Document : public CDM_Document
|
||||
|
||||
public:
|
||||
//! Will Abort any execution, clear fields
|
||||
//! returns the document which contains <L>. raises an
|
||||
//! returns the document which contains <L>. raises an
|
||||
//! exception if the document is not found.
|
||||
Standard_EXPORT static Handle(TDocStd_Document) Get(const TDF_Label& L);
|
||||
|
||||
@@ -81,7 +81,7 @@ public:
|
||||
//! raise if <me> is not saved.
|
||||
Standard_EXPORT TCollection_ExtendedString GetName() const;
|
||||
|
||||
//! returns the OS path of the file, in which one <me> is
|
||||
//! returns the OS path of the file, in which one <me> is
|
||||
//! saved. Raise an exception if <me> is not saved.
|
||||
Standard_EXPORT TCollection_ExtendedString GetPath() const;
|
||||
|
||||
@@ -131,17 +131,17 @@ public:
|
||||
//! Returns True if a new delta has been added to myUndos.
|
||||
Standard_EXPORT Standard_Boolean CommitCommand();
|
||||
|
||||
//! Abort the Command transaction. Does nothing If there is
|
||||
//! Abort the Command transaction. Does nothing If there is
|
||||
//! no Command transaction open.
|
||||
Standard_EXPORT void AbortCommand();
|
||||
|
||||
//! The current limit on the number of undos
|
||||
Standard_EXPORT Standard_Integer GetUndoLimit() const;
|
||||
|
||||
//! Set the limit on the number of Undo Delta stored 0
|
||||
//! will disable Undo on the document A negative value
|
||||
//! Set the limit on the number of Undo Delta stored 0
|
||||
//! will disable Undo on the document A negative value
|
||||
//! means no limit. Note that by default Undo is disabled.
|
||||
//! Enabling it will take effect with the next call to
|
||||
//! Enabling it will take effect with the next call to
|
||||
//! NewCommand. Of course this limit is the same for Redo
|
||||
Standard_EXPORT void SetUndoLimit(const Standard_Integer L);
|
||||
|
||||
@@ -156,7 +156,7 @@ public:
|
||||
//! can be used.
|
||||
Standard_EXPORT Standard_Integer GetAvailableUndos() const;
|
||||
|
||||
//! Will UNDO one step, returns False if no undo was
|
||||
//! Will UNDO one step, returns False if no undo was
|
||||
//! done (Undos == 0).
|
||||
//! Otherwise, true is returned and one step in the
|
||||
//! list of undoes is undone.
|
||||
@@ -167,7 +167,7 @@ public:
|
||||
//! can be used.
|
||||
Standard_EXPORT Standard_Integer GetAvailableRedos() const;
|
||||
|
||||
//! Will REDO one step, returns False if no redo was
|
||||
//! Will REDO one step, returns False if no redo was
|
||||
//! done (Redos == 0).
|
||||
//! Otherwise, true is returned, and one step in the list of redoes is done again.
|
||||
Standard_EXPORT Standard_Boolean Redo();
|
||||
@@ -190,26 +190,26 @@ public:
|
||||
//! till the last one to be one delta.
|
||||
Standard_EXPORT Standard_Boolean PerformDeltaCompaction();
|
||||
|
||||
//! Set modifications on labels impacted by external
|
||||
//! references to the entry. The document becomes invalid
|
||||
//! Set modifications on labels impacted by external
|
||||
//! references to the entry. The document becomes invalid
|
||||
//! and must be recomputed.
|
||||
Standard_EXPORT void UpdateReferences(const TCollection_AsciiString& aDocEntry);
|
||||
|
||||
//! Recompute if the document was not valid and propagate
|
||||
//! Recompute if the document was not valid and propagate
|
||||
//! the recorded modification.
|
||||
Standard_EXPORT void Recompute();
|
||||
|
||||
//! This method Update will be called
|
||||
//! to signal the end of the modified references list.
|
||||
//! The document should be recomputed and
|
||||
//! UpdateFromDocuments should be called. Update should
|
||||
//! returns True in case of success, false otherwise. In
|
||||
//! This method Update will be called
|
||||
//! to signal the end of the modified references list.
|
||||
//! The document should be recomputed and
|
||||
//! UpdateFromDocuments should be called. Update should
|
||||
//! returns True in case of success, false otherwise. In
|
||||
//! case of Failure, additional information can be given in
|
||||
//! ErrorString.
|
||||
//! Update the document by propagation
|
||||
//! ==================================
|
||||
//! Update the document from internal stored
|
||||
//! modifications. If you want to undoing this
|
||||
//! Update the document from internal stored
|
||||
//! modifications. If you want to undoing this
|
||||
//! operation, please call NewCommand before.
|
||||
//! to change format (advanced programming)
|
||||
//! ================
|
||||
|
||||
@@ -65,7 +65,7 @@ public:
|
||||
//! add <L> as modified
|
||||
Standard_EXPORT Standard_Boolean AddLabel(const TDF_Label& L);
|
||||
|
||||
//! remove <L> as modified
|
||||
//! remove <L> as modified
|
||||
Standard_EXPORT Standard_Boolean RemoveLabel(const TDF_Label& L);
|
||||
|
||||
//! returns modified label map
|
||||
|
||||
@@ -30,10 +30,10 @@ class TDF_RelocationTable;
|
||||
class TDocStd_Owner;
|
||||
DEFINE_STANDARD_HANDLE(TDocStd_Owner, TDF_Attribute)
|
||||
|
||||
//! This attribute located at the root label of the
|
||||
//! framework contains a back reference to the owner
|
||||
//! TDocStd_Document, providing access to the document from
|
||||
//! any label. private class Owner;
|
||||
//! This attribute located at the root label of the
|
||||
//! framework contains a back reference to the owner
|
||||
//! TDocStd_Document, providing access to the document
|
||||
//! from any label. private class Owner;
|
||||
class TDocStd_Owner : public TDF_Attribute
|
||||
{
|
||||
|
||||
|
||||
@@ -26,18 +26,18 @@ class TDF_DataSet;
|
||||
class TDF_RelocationTable;
|
||||
class TDF_Label;
|
||||
|
||||
//! This tool class is used to copy the content of
|
||||
//! source label under target label. Only child
|
||||
//! labels and attributes of source are copied.
|
||||
//! attributes located out of source scope are not
|
||||
//! This tool class is used to copy the content of
|
||||
//! source label under target label. Only child
|
||||
//! labels and attributes of source are copied.
|
||||
//! attributes located out of source scope are not
|
||||
//! copied by this algorithm.
|
||||
//! Depending of the called method an external
|
||||
//! reference is set in the target document to
|
||||
//! Depending of the called method an external
|
||||
//! reference is set in the target document to
|
||||
//! registered the externallink.
|
||||
//! Provide services to set, update and perform
|
||||
//! external references.
|
||||
//! Warning1: Nothing is provided in this class about the
|
||||
//! opportunity to copy, set a link or update it.
|
||||
//! Warning1: Nothing is provided in this class about the
|
||||
//! opportunity to copy, set a link or update it.
|
||||
//! Such decisions must be under application control.
|
||||
//! Warning2: If the document manages shapes, use after copy
|
||||
//! TNaming::ChangeShapes(target,M) to make copy of
|
||||
@@ -51,12 +51,12 @@ public:
|
||||
|
||||
//! Copies the content of the label <fromsource> to the label <intarget>.
|
||||
//! The link is registered with an XLink attribute by <intarget>
|
||||
//! label. if the content of <fromsource> is not
|
||||
//! self-contained, and/or <intarget> has already an XLink
|
||||
//! label. if the content of <fromsource> is not
|
||||
//! self-contained, and/or <intarget> has already an XLink
|
||||
//! attribute, an exception is raised.
|
||||
Standard_EXPORT void CopyWithLink(const TDF_Label& intarget, const TDF_Label& fromsource);
|
||||
|
||||
//! Update the external reference set at <L>.
|
||||
//! Update the external reference set at <L>.
|
||||
//! Example
|
||||
//! Handle(TDocStd_Document) aDoc;
|
||||
//! if
|
||||
@@ -70,7 +70,7 @@ public:
|
||||
//! Standard_DomainError if <L> has no XLink attribute.
|
||||
Standard_EXPORT void UpdateLink(const TDF_Label& L);
|
||||
|
||||
//! Copy the content of <fromsource> under
|
||||
//! Copy the content of <fromsource> under
|
||||
//! <intarget>. No link is registered. No check is done.
|
||||
//! Example
|
||||
//! Handle(TDocStd_Document) DOC, XDOC;
|
||||
|
||||
@@ -28,9 +28,9 @@ class TFunction_Logbook;
|
||||
class TFunction_Driver;
|
||||
DEFINE_STANDARD_HANDLE(TFunction_Driver, Standard_Transient)
|
||||
|
||||
//! This driver class provide services around function
|
||||
//! execution. One instance of this class is built for
|
||||
//! the whole session. The driver is bound to the
|
||||
//! This driver class provide services around function
|
||||
//! execution. One instance of this class is built for
|
||||
//! the whole session. The driver is bound to the
|
||||
//! DriverGUID in the DriverTable class.
|
||||
//! It allows you to create classes which inherit from
|
||||
//! this abstract class.
|
||||
@@ -43,13 +43,13 @@ class TFunction_Driver : public Standard_Transient
|
||||
{
|
||||
|
||||
public:
|
||||
//! Initializes the label L for this function prior to its execution.
|
||||
//! Initializes the label L for this function prior to its execution.
|
||||
Standard_EXPORT void Init(const TDF_Label& L);
|
||||
|
||||
//! Returns the label of the driver for this function.
|
||||
TDF_Label Label() const;
|
||||
|
||||
//! Validates labels of a function in <log>.
|
||||
//! Validates labels of a function in <log>.
|
||||
//! This function is the one initialized in this function driver.
|
||||
//! Warning
|
||||
//! In regeneration mode, the solver must call this
|
||||
|
||||
@@ -73,7 +73,7 @@ public:
|
||||
const Standard_Boolean WithChildren = Standard_False);
|
||||
Standard_EXPORT void SetValid(const TDF_LabelMap& Ls);
|
||||
|
||||
//! Returns True if the label L is touched or impacted. This method
|
||||
//! Returns True if the label L is touched or impacted. This method
|
||||
//! is called by <TFunction_FunctionDriver::MustExecute>.
|
||||
//! If <WithChildren> is set to true, the method checks
|
||||
//! all the sublabels of <L> too.
|
||||
|
||||
@@ -62,7 +62,7 @@ public:
|
||||
//! Writes the data aggregated in theData object into the container defined by
|
||||
//! theDriver. The storage format is compartible with legacy persistent one.
|
||||
//! Note: - theData may aggregate several root objects to be stored together.
|
||||
//! - createion date specified in the srorage header will be overwritten.
|
||||
//! - creation date specified in the storage header will be overwritten.
|
||||
Standard_EXPORT static Storage_Error Write(const Handle(Storage_BaseDriver)& theDriver,
|
||||
const Handle(StdStorage_Data)& theData);
|
||||
};
|
||||
|
||||
@@ -24,7 +24,7 @@
|
||||
|
||||
//!
|
||||
//! This is a base class for OCAF based TObj models
|
||||
//! with declared virtual methods
|
||||
//! with declared virtual methods
|
||||
//!
|
||||
class TObj_Application : public TDocStd_Application
|
||||
{
|
||||
|
||||
@@ -201,7 +201,7 @@ public:
|
||||
//! transaction open.
|
||||
Standard_EXPORT void CommitCommand() const;
|
||||
|
||||
//! Abort the Command transaction. Do nothing If there is no Command
|
||||
//! Abort the Command transaction. Do nothing If there is no Command
|
||||
//! transaction open.
|
||||
Standard_EXPORT void AbortCommand() const;
|
||||
|
||||
|
||||
@@ -416,14 +416,14 @@ protected:
|
||||
* Internal tools for work with OCAF data
|
||||
*/
|
||||
|
||||
//! Returns the theRank2-th sub label of the theRank1-th sublabel of the
|
||||
//! Returns the theRank2-th sub label of the theRank1-th sublabel of the
|
||||
//! Data label of the object.
|
||||
//! If theRank2 is 0 (default), sub label theRank1 of Data label is returned.
|
||||
//! If requested label does not exist, it is created.
|
||||
Standard_EXPORT TDF_Label getDataLabel(const Standard_Integer theRank1,
|
||||
const Standard_Integer theRank2 = 0) const;
|
||||
|
||||
//! Returns the theRank2-th sub label of the theRank1-th sublabel of the
|
||||
//! Returns the theRank2-th sub label of the theRank1-th sublabel of the
|
||||
//! Reference label of the object.
|
||||
//! If theRank2 is 0 (default), sub label theRank1 of Reference label is returned.
|
||||
//! If requested label does not exist, it is created.
|
||||
|
||||
@@ -90,7 +90,7 @@ public:
|
||||
|
||||
//! Generates and returns name for new object in partition.
|
||||
//! if theIsToChangeCount is true partition increase own counter
|
||||
//! to generate new name next time starting from new counter value
|
||||
//! to generate new name next time starting from new counter value
|
||||
Standard_EXPORT Handle(TCollection_HExtendedString) GetNewName(
|
||||
const Standard_Boolean theIsToChangeCount = Standard_True);
|
||||
|
||||
|
||||
@@ -96,7 +96,7 @@ public:
|
||||
//! Returns the material setting for this presentation attribute.
|
||||
Standard_EXPORT Graphic3d_NameOfMaterial Material() const;
|
||||
|
||||
//! Sets the material aName for this presentation attribute.
|
||||
//! Sets the material aName for this presentation attribute.
|
||||
Standard_EXPORT void SetMaterial(const Graphic3d_NameOfMaterial aName);
|
||||
|
||||
//! Returns true if this presentation attribute already has a material setting.
|
||||
|
||||
@@ -41,18 +41,18 @@ public:
|
||||
//! =============
|
||||
Standard_EXPORT static const Standard_GUID& GetID();
|
||||
|
||||
//! returns True if there is an AISViewer attribute in
|
||||
//! returns True if there is an AISViewer attribute in
|
||||
//! <acces> Data Framework.
|
||||
Standard_EXPORT static Standard_Boolean Has(const TDF_Label& acces);
|
||||
|
||||
//! create and set an AISViewer at. Raise an exception if
|
||||
//! create and set an AISViewer at. Raise an exception if
|
||||
//! Has.
|
||||
Standard_EXPORT static Handle(TPrsStd_AISViewer) New(
|
||||
const TDF_Label& access,
|
||||
const Handle(AIS_InteractiveContext)& selector);
|
||||
|
||||
//! create and set an AISAttribute at root label. The
|
||||
//! interactive context is build. Raise an exception if
|
||||
//! create and set an AISAttribute at root label. The
|
||||
//! interactive context is build. Raise an exception if
|
||||
//! Has.
|
||||
Standard_EXPORT static Handle(TPrsStd_AISViewer) New(const TDF_Label& acces,
|
||||
const Handle(V3d_Viewer)& viewer);
|
||||
|
||||
@@ -38,9 +38,9 @@ DEFINE_STANDARD_HANDLE(TPrsStd_Driver, Standard_Transient)
|
||||
//! attributes. These attributes are those found on
|
||||
//! the label given as an argument in the method Update.
|
||||
//! true is returned if the interactive object was modified by the update.
|
||||
//! This class provide an algorithm to Build with its default
|
||||
//! values (if Null) or Update (if !Null) an AIS_InteractiveObject
|
||||
//! . Resources are found in attributes associated to a given
|
||||
//! This class provide an algorithm to Build with its default
|
||||
//! values (if Null) or Update (if !Null) an AIS_InteractiveObject.
|
||||
//! Resources are found in attributes associated to a given
|
||||
//! label.
|
||||
class TPrsStd_Driver : public Standard_Transient
|
||||
{
|
||||
|
||||
@@ -28,10 +28,10 @@ class TPrsStd_Driver;
|
||||
class TPrsStd_DriverTable;
|
||||
DEFINE_STANDARD_HANDLE(TPrsStd_DriverTable, Standard_Transient)
|
||||
|
||||
//! This class is a container to record (AddDriver)
|
||||
//! binding between GUID and TPrsStd_Driver.
|
||||
//! This class is a container to record (AddDriver)
|
||||
//! binding between GUID and TPrsStd_Driver.
|
||||
//! You create a new instance of TPrsStd_Driver
|
||||
//! and use the method AddDriver to load it into the driver table. the method
|
||||
//! and use the method AddDriver to load it into the driver table.
|
||||
class TPrsStd_DriverTable : public Standard_Transient
|
||||
{
|
||||
|
||||
@@ -58,8 +58,8 @@ public:
|
||||
//! Returns true if the driver has been removed successfully.
|
||||
Standard_EXPORT Standard_Boolean RemoveDriver(const Standard_GUID& guid);
|
||||
|
||||
//! Removes all drivers. Returns
|
||||
//! true if the driver has been removed successfully.
|
||||
//! Removes all drivers.
|
||||
//! Returns true if the driver has been removed successfully.
|
||||
//! If this method is used, the InitStandardDrivers method should be
|
||||
//! called to fill the table with standard drivers.
|
||||
Standard_EXPORT void Clear();
|
||||
|
||||
Reference in New Issue
Block a user