void ApplicationWindow::createTranslatePopups()
{
if ( !myImportPopup )
- myImportPopup = new QMenu( QObject::tr( "MNU_FILE_IMPORT" ), this );
+ myImportPopup = new QMenu( QObject::tr("MNU_FILE_IMPORT"), this );
if ( !myExportPopup )
- myExportPopup = new QMenu( QObject::tr( "MNU_FILE_EXPORT" ), this );
+ myExportPopup = new QMenu( QObject::tr("MNU_FILE_EXPORT"), this );
QAction* a;
a = new QAction( QObject::tr("MNU_IMPORT_BREP"), this );
const Handle(CDM_Document)& /*theDoc*/,
Standard_OStream& /*theOS*/);
- //! defines the procedure of writing a shape section to file
+ //! defines the procedure of writing a shape section to file
Standard_EXPORT virtual void WriteShapeSection(
BinLDrivers_DocumentSection& theDocSection,
Standard_OStream& theOS,
class AppStd_Application : public TDocStd_Application
{
public:
- //! returns the file name which contains application
- //! resources
+ //! returns the file name which contains application resources
Standard_EXPORT Standard_CString ResourcesName() Standard_OVERRIDE;
//! Dumps the content of me into the stream
#include <TDataXtd_GeometryEnum.hxx>
#include <TDataXtd_ConstraintEnum.hxx>
-//! This package defines extension of standard attributes for
-//! modelling (mainly for work with geometry).
+//! This package defines extension of standard attributes for
+//! modelling (mainly for work with geometry).
class TDataXtd
{
public:
//! The basis to define an axis attribute.
//!
-//! Warning: Use TDataXtd_Geometry attribute to retrieve the
+//! Warning: Use TDataXtd_Geometry attribute to retrieve the
//! gp_Lin of the Axis attribute
class TDataXtd_Axis : public TDataStd_GenericEmpty
{
//! Returns the GUID for an axis.
Standard_EXPORT static const Standard_GUID& GetID();
- //! Finds or creates an axis attribute defined by the label.
+ //! Finds or creates an axis attribute defined by the label.
//! In the case of a creation of an axis, a compatible
//! named shape should already be associated with label.
//! Exceptions
- //! Standard_NullObject if no compatible named
- //! shape is associated with the label.
+ //! Standard_NullObject if no compatible named shape is
+ //! associated with the label.
Standard_EXPORT static Handle(TDataXtd_Axis) Set(const TDF_Label& label);
- //! Find, or create, an Axis attribute and set <P> as
+ //! Find, or create, an Axis attribute and set <P> as
//! generated in the associated NamedShape.
+
//! Axis methods
//! ============
Standard_EXPORT static Handle(TDataXtd_Axis) Set(const TDF_Label& label, const gp_Lin& L);
#define _TDataXtd_ConstraintEnum_HeaderFile
//! The terms of this enumeration define the types
-//! of available constraint.
+//! of available constraint.
//! ==================
enum TDataXtd_ConstraintEnum
{
//! The specific geometric construction of the
//! attribute is defined by an element of the
//! enumeration TDataXtd_GeometryEnum.
-//! This attribute may also be used to qualify underlying
-//! geometry of the associated NamedShape. for
+//! This attribute may also be used to qualify underlying
+//! geometry of the associated NamedShape. for
//! Constructuion element by example.
class TDataXtd_Geometry : public TDF_Attribute
{
public:
//! API class methods
//! =================
- //! Finds, or creates, a Geometry attribute defined by the label label.
+ //! Finds, or creates, a Geometry attribute defined by the label label.
//! The default type of geometry is the value
//! ANY_GEOM of the enumeration TDataXtd_GeometryEnum.
//! To specify another value of this enumeration, use
public:
Standard_EXPORT static const Standard_GUID& GetPatternID();
- //! Find, or create, a PatternStd attribute
+ //! Find, or create, a PatternStd attribute
Standard_EXPORT static Handle(TDataXtd_PatternStd) Set(const TDF_Label& label);
Standard_EXPORT TDataXtd_PatternStd();
//! =============
Standard_EXPORT static const Standard_GUID& GetID();
- //! Find, or create, an Placement attribute. the
+ //! Find, or create, a Placement attribute.
//! Placement attribute is returned.
//! Placement methods
//! =================
DEFINE_STANDARD_HANDLE(TDataXtd_Plane, TDataStd_GenericEmpty)
//! The basis to define a plane attribute.
-//! Warning: Use TDataXtd_Geometry attribute to retrieve the
+//! Warning: Use TDataXtd_Geometry attribute to retrieve the
//! gp_Pln of the Plane attribute
class TDataXtd_Plane : public TDataStd_GenericEmpty
{
//! planar face should already be associated with label.
Standard_EXPORT static Handle(TDataXtd_Plane) Set(const TDF_Label& label);
- //! Finds, or creates, a Plane attribute and sets <P> as
+ //! Finds, or creates, a Plane attribute and sets <P> as
//! generated the associated NamedShape.
//! Plane methods
//! =============
//! The topological attribute must contain a vertex.
//! You use this class to create reference points in a design.
//!
-//! Warning: Use TDataXtd_Geometry attribute to retrieve the
+//! Warning: Use TDataXtd_Geometry attribute to retrieve the
//! gp_Pnt of the Point attribute
class TDataXtd_Point : public TDataStd_GenericEmpty
{
//! class methods
//! =============
//! try to retrieve a Shape attribute at <current> label
- //! or in fathers label of <current>. Returns True if
+ //! or in fathers label of <current>. Returns True if
//! found and set <S>.
Standard_EXPORT static Standard_Boolean Find(const TDF_Label& current, Handle(TDataXtd_Shape)& S);
- //! Find, or create, a Shape attribute. the Shape attribute
+ //! Find, or create, a Shape attribute. the Shape attribute
//! is returned. Raises if <label> has attribute.
Standard_EXPORT static Handle(TDataXtd_Shape) New(const TDF_Label& label);
- //! Create or update associated NamedShape attribute. the
+ //! Create or update associated NamedShape attribute. the
//! Shape attribute is returned.
Standard_EXPORT static Handle(TDataXtd_Shape) Set(const TDF_Label& label,
const TopoDS_Shape& shape);
- //! the Shape from associated NamedShape attribute
+ //! the Shape from associated NamedShape attribute
//! is returned.
Standard_EXPORT static TopoDS_Shape Get(const TDF_Label& label);
//! Shape methods
- //! ============
+ //! =============
Standard_EXPORT static const Standard_GUID& GetID();
Standard_EXPORT TDataXtd_Shape();
public:
DEFINE_STANDARD_ALLOC
- //! Subtituter les shapes sur les structures de source
+ //! Subtituter les shapes sur les structures de source
//! vers cible
Standard_EXPORT static void Substitute(const TDF_Label& labelsource,
const TDF_Label& labelcible,
TopTools_DataMapOfShapeShape& mapOldNew);
- //! Mise a jour des shapes du label et de ses fils en
- //! tenant compte des substitutions decrite par
+ //! Mise a jour des shapes du label et de ses fils en
+ //! tenant compte des substitutions decrite par
//! mapOldNew.
//!
- //! Warning: le remplacement du shape est fait dans tous
- //! les attributs qui le contiennent meme si ceux
+ //! Warning: le remplacement du shape est fait dans tous
+ //! les attributs qui le contiennent meme si ceux
//! ci ne sont pas associees a des sous-labels de <Label>.
Standard_EXPORT static void Update(const TDF_Label& label,
TopTools_DataMapOfShapeShape& mapOldNew);
//! Application de la Location sur les shapes du label
- //! et de ses sous labels.
+ //! et de ses sous labels.
Standard_EXPORT static void Displace(const TDF_Label& label,
const TopLoc_Location& aLocation,
const Standard_Boolean WithOld = Standard_True);
- //! Remplace les shapes du label et des sous-labels
+ //! Remplace les shapes du label et des sous-labels
//! par des copies.
Standard_EXPORT static void ChangeShapes(const TDF_Label& label, TopTools_DataMapOfShapeShape& M);
//! Application de la transformation sur les shapes du
//! label et de ses sous labels.
- //! Warning: le remplacement du shape est fait dans tous
- //! les attributs qui le contiennent meme si ceux
+ //! Warning: le remplacement du shape est fait dans tous
+ //! les attributs qui le contiennent meme si ceux
//! ci ne sont pas associees a des sous-labels de <Label>.
Standard_EXPORT static void Transform(const TDF_Label& label, const gp_Trsf& aTransformation);
TopoDS_Shell& theShell);
//! Appends to <anIDList> the list of the attributes
- //! IDs of this package. CAUTION: <anIDList> is NOT
- //! cleared before use.
+ //! IDs of this package.
+ //! CAUTION: <anIDList> is NOT cleared before use.
Standard_EXPORT static void IDList(TDF_IDList& anIDList);
- //! Prints the evolution <EVOL> as a String on the
+ //! Prints the evolution <EVOL> as a String on the
//! Stream <S> and returns <S>.
Standard_EXPORT static Standard_OStream& Print(const TNaming_Evolution EVOL, Standard_OStream& S);
//! the Stream <S> and returns <S>.
Standard_EXPORT static Standard_OStream& Print(const TNaming_NameType NAME, Standard_OStream& S);
- //! Prints the content of UsedShapes private attribute as a String Table on
+ //! Prints the content of UsedShapes private attribute as a String Table on
//! the Stream <S> and returns <S>.
Standard_EXPORT static Standard_OStream& Print(const TDF_Label& ACCESS, Standard_OStream& S);
};
public:
DEFINE_STANDARD_ALLOC
- //! Create an Builder.
- //! Warning: Before Addition copies the current Value, and clear
+ //! Create a Builder.
+ //! Warning: Before Addition copies the current Value, and clear
Standard_EXPORT TNaming_Builder(const TDF_Label& aLabel);
//! Records the shape newShape which was
//! or merged in a Boolean operation.
Standard_EXPORT void Modify(const TopoDS_Shape& oldShape, const TopoDS_Shape& newShape);
- //! Add a Shape to the current label , This Shape is
- //! unmodified. Used for example to define a set
+ //! Add a Shape to the current label, This Shape is
+ //! unmodified. Used for example to define a set
//! of shapes under a label.
Standard_EXPORT void Select(const TopoDS_Shape& aShape, const TopoDS_Shape& inShape);
public:
DEFINE_STANDARD_ALLOC
- //! Makes copy a set of shape(s), using the aMap
+ //! Makes copy a set of shape(s), using the aMap
Standard_EXPORT static void CopyTool(const TopoDS_Shape& aShape,
TColStd_IndexedDataMapOfTransientTransient& aMap,
TopoDS_Shape& aResult);
- //! Translates a Transient shape(s) to Transient
+ //! Translates a Transient shape(s) to Transient
Standard_EXPORT static void Translate(const TopoDS_Shape& aShape,
TColStd_IndexedDataMapOfTransientTransient& aMap,
TopoDS_Shape& aResult,
const Handle(TNaming_TranslateTool)& TrTool);
- //! Translates a Topological Location to an other Top.
+ //! Translates a Topological Location to an other Top.
//! Location
Standard_EXPORT static TopLoc_Location Translate(
const TopLoc_Location& L,
public:
DEFINE_STANDARD_ALLOC
- //! Iterates on all the history records in
+ //! Iterates on all the history records in
//! <anAtt>.
Standard_EXPORT TNaming_Iterator(const Handle(TNaming_NamedShape)& anAtt);
- //! Iterates on all the history records in
+ //! Iterates on all the history records in
//! the current transaction
Standard_EXPORT TNaming_Iterator(const TDF_Label& aLabel);
- //! Iterates on all the history records in
+ //! Iterates on all the history records in
//! the transaction <aTrans>
Standard_EXPORT TNaming_Iterator(const TDF_Label& aLabel, const Standard_Integer aTrans);
//! Returns the new shape in this iterator object.
Standard_EXPORT const TopoDS_Shape& NewShape() const;
- //! Returns true if the new shape is a modification (split,
- //! fuse,etc...) of the old shape.
+ //! Returns true if the new shape is a modification
+ //! (split, fuse, etc...) of the old shape.
Standard_EXPORT Standard_Boolean IsModification() const;
Standard_EXPORT TNaming_Evolution Evolution() const;
//! Returns the ID of the attribute.
const Standard_GUID& ID() const Standard_OVERRIDE;
- //! Copies the attribute contents into a new other
+ //! Copies the attribute contents into a new other
//! attribute. It is used by Backup().
Standard_EXPORT virtual Handle(TDF_Attribute) BackupCopy() const Standard_OVERRIDE;
class TNaming_Naming;
DEFINE_STANDARD_HANDLE(TNaming_Naming, TDF_Attribute)
-//! This attribute store the topological naming of any
-//! selected shape, when this shape is not already
+//! This attribute store the topological naming of any
+//! selected shape, when this shape is not already
//! attached to a specific label. This class is also used
-//! to solve it when the argumentsof the toipological
+//! to solve it when the arguments of the topological
//! naming are modified.
class TNaming_Naming : public TDF_Attribute
{
Standard_EXPORT static Handle(TNaming_Naming) Insert(const TDF_Label& under);
- //! Creates a Namimg attribute at label <where> to
- //! identify the shape <Selection>. Geometry is
- //! Standard_True if we are only interested by the
- //! underlying geometry (e.g. setting a
- //! constraint). <Context> is used to find neighbours of
- //! <S> when required by the naming.
- //! If KeepOrientation is True the Selection orientation is taken
- //! into account. BNproblem == True points out that Context sub-shapes
- //! in DF have orientation differences with Context shape itself.
+ //! Creates a Naming attribute at label <where> to identify
+ //! the shape <Selection>. Geometry is Standard_True if we
+ //! are only interested by the underlying geometry (e.g.
+ //! setting a constraint).
+ //! <Context> is used to find neighbours of <S> when required
+ //! by the naming. If KeepOrientation is True the Selection
+ //! orientation is taken into account.
+ //! BNproblem == True points out that Context sub-shapes in
+ //! DF have orientation differences with Context shape itself.
+
//! instance method
//! ===============
Standard_EXPORT static Handle(TNaming_NamedShape) Name(
//! regenerate only the Name associated to me
Standard_EXPORT Standard_Boolean Regenerate(TDF_LabelMap& scope);
- //! Regenerate recursively the whole name with scope. If
- //! scope is empty it means that all the labels of the
+ //! Regenerate recursively the whole name with scope. If
+ //! scope is empty it means that all the labels of the
//! framework are valid.
Standard_EXPORT Standard_Boolean Solve(TDF_LabelMap& scope);
//! Warning! Can be a Null Shape if a descendant is deleted.
Standard_EXPORT const TopoDS_Shape& Shape() const;
- //! True if the new shape is a modification (split,
+ //! True if the new shape is a modification (split,
//! fuse,etc...) of the old shape.
Standard_EXPORT Standard_Boolean IsModification() const;
Standard_EXPORT const TopoDS_Shape& Shape() const;
- //! True if the new shape is a modification (split,
+ //! True if the new shape is a modification (split,
//! fuse,etc...) of the old shape.
Standard_EXPORT Standard_Boolean IsModification() const;
class TNaming_UsedShapes;
class TDF_Label;
-//! To iterate on all the label which contained a
+//! To iterate on all the label which contained a
//! given shape.
class TNaming_SameShapeIterator
{
Standard_EXPORT TDF_LabelMap& ChangeValid();
- //! Returns the current value of <NS> according to the
+ //! Returns the current value of <NS> according to the
//! Valid Scope.
Standard_EXPORT TopoDS_Shape CurrentShape(const Handle(TNaming_NamedShape)& NS) const;
//! solve its identifications.
//! This class is the user interface for topological
//! naming resources.
-//! * The <IsIdentified> method returns (if exists)
-//! the NamedShape which contains a given shape. The
-//! definition of an identified shape is : a Shape
-//! handled by a NamedShape (this shape is the only
-//! one stored) , which has the TNaming_PRImITIVE evolution
+//! * The <IsIdentified> method returns (if exists)
+//! the NamedShape which contains a given shape. The
+//! definition of an identified shape is: a Shape
+//! handled by a NamedShape (this shape is the only
+//! one stored), which has the TNaming_PRImITIVE evolution
//!
-//! * The <Select> method returns ALWAYS a new
-//! NamedShape at the given label, which contains the
-//! argument selected shape. When calling this
+//! * The <Select> method returns ALWAYS a new
+//! NamedShape at the given label, which contains the
+//! argument selected shape. When calling this
//! method, the sub-hierarchy of <label> is first cleared,
-//! then a TNaming_NamedShape is ALWAYS created at
+//! then a TNaming_NamedShape is ALWAYS created at
//! this <label>, with the TNaming_SELECTED evolution.
//! The <Naming attribute> is associated to the selected
-//! shape which store the arguments of the selection .
+//! shape which store the arguments of the selection.
//! If the given selected shape was already identified
-//! (method IsIdentified) , this Naming attribute
-//! contains the reference (Identity code) to the
+//! (method IsIdentified), this Naming attribute
+//! contains the reference (Identity code) to the
//! argument shape.
//!
-//! * The <Solve> method update the current value of
+//! * The <Solve> method update the current value of
//! the NamedShape, according to the <Naming> attribute.
-//! A boolean status is returned to say if the
-//! algorithm succeed or not. To read the current
-//! value of the selected Named Shape use the
-//! TNaming_Tool::GetShape method, as for any
+//! A boolean status is returned to say if the
+//! algorithm succeed or not. To read the current
+//! value of the selected Named Shape use the
+//! TNaming_Tool::GetShape method, as for any
//! NamedShape attribute.
class TNaming_Selector
{
//! Adds the Shape <S>
Standard_Boolean Add(const TopoDS_Shape& S);
- //! Returns True if <S> is in <me>
+ //! Returns True if <S> is in <me>
Standard_Boolean Contains(const TopoDS_Shape& S) const;
//! Removes <S> in <me>.
Standard_EXPORT static Standard_Boolean HasLabel(const TDF_Label& access,
const TopoDS_Shape& aShape);
- //! Returns the label of the first apparition of
- //! <aShape>. Transdef is a value of the transaction
+ //! Returns the label of the first apparition of
+ //! <aShape>. Transdef is a value of the transaction
//! of the first apparition of <aShape>.
Standard_EXPORT static TDF_Label Label(const TDF_Label& access,
const TopoDS_Shape& aShape,
Standard_EXPORT static Standard_Integer ValidUntil(const TopoDS_Shape& S,
const Handle(TNaming_UsedShapes)& US);
- //! Returns the label of the first apparition of
- //! <aShape>. Transdef is a value of the transaction
+ //! Returns the label of the first apparition of
+ //! <aShape>. Transdef is a value of the transaction
//! of the first apparition of <aShape>.
Standard_EXPORT static TDF_Label Label(const Handle(TNaming_UsedShapes)& Shapes,
const TopoDS_Shape& aShape,
//! tool to copy underlying TShape of a Shape.
//! The TranslateTool class is provided to support the
-//! translation of topological data structures Transient
-//! to Transient.
+//! translation of topological data structures Transient
+//! to Transient.
class TNaming_TranslateTool : public Standard_Transient
{
#include <TopTools_DataMapOfShapeShape.hxx>
class TopoDS_Shape;
-//! only for Shape Copy test - to move in DNaming
+//! only for Shape Copy test - to move in DNaming
class TNaming_Translator
{
public:
Standard_EXPORT Standard_Boolean IsDone() const;
- //! returns copied shape
+ //! returns copied shape
Standard_EXPORT const TopoDS_Shape Copied(const TopoDS_Shape& aShape) const;
- //! returns DataMap of results; (shape <-> copied shape)
+ //! returns DataMap of results; (shape <-> copied shape)
Standard_EXPORT const TopTools_DataMapOfShapeShape& Copied() const;
Standard_EXPORT void DumpMap(const Standard_Boolean isWrite = Standard_False) const;
//! Returns the ID: 2a96b614-ec8b-11d0-bee7-080009dc3333.
Standard_EXPORT static const Standard_GUID& GetID();
- //! Copies the attribute contents into a new other
+ //! Copies the attribute contents into a new other
//! attribute. It is used by Backup().
Standard_EXPORT virtual Handle(TDF_Attribute) BackupCopy() const Standard_OVERRIDE;
//!
//! Handle(CDM_Document) theDocument=myApplication->Retrieve("|user|cascade","box");
//!
- //! Since the version is not specified in this syntax, the latest will be used.
+ //! Since the version is not specified in this syntax, the latest will be used.
//! A link is kept with the database through an instance of CDM_MetaData
Standard_EXPORT Handle(CDM_Document) Retrieve(
const TCollection_ExtendedString& aFolder,
const Handle(PCDM_ReaderFilter)& theFilter = Handle(PCDM_ReaderFilter)(),
const Message_ProgressRange& theRange = Message_ProgressRange());
- //! This method retrieves a document from the database.
- //! If the Document references other documents which have
- //! been updated, the latest version of these documents
- //! will be used if {UseStorageConfiguration} is
- //! Standard_True. -- If the DBMS is only based on the
- //! OS, this syntax should not be used.
+ //! This method retrieves a document from the database.
+ //! If the Document references other documents which have
+ //! been updated, the latest version of these documents
+ //! will be used if {UseStorageConfiguration} is
+ //! Standard_True. If the DBMS is only based on the OS,
+ //! this syntax should not be used.
//!
//! If the DBMS is EUCLID/Design Manager, {aFolder}, {aName}
- //! and {aVersion} have the form they have in
+ //! and {aVersion} have the form they have in
//! EUCLID/Design Manager. For example:
//!
//! Handle(CDM_Document) theDocument=myApplication->Retrieve("|user|cascade","box","2");
const TCollection_ExtendedString& theVersion,
const bool theAppendMode);
- //! Checks status after Retrieve
+ //! Checks status after Retrieve
PCDM_ReaderStatus GetRetrieveStatus() const { return myRetrievableStatus; }
//! Reads theDocument from standard SEEKABLE stream theIStream,
Standard_EXPORT virtual Handle(PCDM_StorageDriver) WriterFromFormat(
const TCollection_ExtendedString& aFormat);
- //! try to retrieve a Format directly in the file or in
- //! application resource by using extension. returns
- //! True if found;
+ //! try to retrieve a Format directly in the file or in
+ //! application resource by using extension.
+ //! returns True if found
Standard_EXPORT Standard_Boolean Format(const TCollection_ExtendedString& aFileName,
TCollection_ExtendedString& theFormat);
Handle(CDF_Directory) myDirectory;
private:
- //! Informs the application that aDocument has been
+ //! Informs the application that aDocument has been
//! activated. A document is activated when it is created or
//! retrieved.
//! aTypeOfActivation will be:
//! By default, returns Standard_False.
Standard_EXPORT virtual Standard_Boolean HasVersionCapability();
- //! Creates a "Depends On" relation between two Datas.
+ //! Creates a "Depends On" relation between two Datas.
//! By default does nothing
Standard_EXPORT virtual void CreateDependsOn(const Handle(CDM_MetaData)& aFirstData,
const Handle(CDM_MetaData)& aSecondData);
Standard_EXPORT virtual TCollection_ExtendedString BuildFileName(
const Handle(CDM_Document)& aDocument) = 0;
- //! this method is useful if the name of an object --
- //! depends on the metadatadriver. For example a Driver
- //! -- based on the operating system can choose to add
+ //! this method is useful if the name of an object
+ //! depends on the metadatadriver. For example a Driver
+ //! based on the operating system can choose to add
//! the extension of file to create to the object.
Standard_EXPORT virtual TCollection_ExtendedString SetName(
const Handle(CDM_Document)& aDocument,
//! the version has to be set in the returned MetaData.
//! aVersion may be NULL
//! MetaData is called by GetMetaData
- //! If the version is set to NULL, MetaData should return
+ //! If the version is set to NULL, MetaData should return
//! the last version of the metadata
Standard_EXPORT virtual Handle(CDM_MetaData) MetaData(
const TCollection_ExtendedString& aFolder,
//! corresponding to the path. If the MetaDataDriver has version management capabilities
//! the version has to be set in the returned MetaData.
//! MetaData is called by GetMetaData
- //! If the version is not included in the path , MetaData should return
+ //! If the version is not included in the path, MetaData should return
//! the last version of the metadata
//! is deferred;
Standard_EXPORT virtual Handle(CDM_MetaData) LastVersion(const Handle(CDM_MetaData)& aMetaData);
public:
DEFINE_STANDARD_ALLOC
- //! creates a store list from the document of the current selection.
+ //! creates a store list from the document of the current selection.
Standard_EXPORT CDF_Store(const Handle(CDM_Document)& aDocument);
//! returns the folder in which the current document will be stored.
//! of the current selection.
Standard_EXPORT Standard_Boolean IsMainDocument() const;
- //! defines the folder in which the document should be
- //! stored. returns Standard_True if the Folder exists,
+ //! defines the folder in which the document should be
+ //! stored. returns Standard_True if the Folder exists,
//! Standard_False otherwise.
Standard_EXPORT Standard_Boolean SetFolder(const TCollection_ExtendedString& aFolder);
//! returns the complete path of the created meta-data.
Standard_EXPORT Standard_ExtString Path() const;
- //! returns the path of the previous store is the object
+ //! returns the path of the previous store is the object
//! is already stored, otherwise an empty string;
Standard_EXPORT Handle(TCollection_HExtendedString) MetaDataPath() const;
Standard_EXPORT void SetCurrent(const Standard_ExtString aPresentation);
- //! the two following methods can
- //! be used just after Realize or Import -- method to know if
- //! thes methods worked correctly, and if not why.
+ //! the two following methods can be used just after
+ //! Realize or Import -- method to know if
+ //! these methods worked correctly, and if not why.
Standard_EXPORT void SetMain();
Standard_EXPORT PCDM_StoreStatus StoreStatus() const;
//! defines the name under which the document should be stored.
Standard_EXPORT CDF_StoreSetNameStatus SetName(const TCollection_ExtendedString& aName);
- //! defines the folder in which the document should be
- //! stored. returns Standard_True if the Folder exists,
+ //! defines the folder in which the document should be
+ //! stored. returns Standard_True if the Folder exists,
//! Standard_False otherwise.
Standard_EXPORT Standard_Boolean SetFolder(const Standard_ExtString aFolder);
{
public:
- //! The manager returned by this virtual method will be
- //! used to search for Format.Retrieval resource items.
+ //! The manager returned by this virtual method will be
+ //! used to search for Format.Retrieval resource items.
Standard_EXPORT virtual Handle(Resource_Manager) Resources() = 0;
//! Returns default messenger;
//! - they can have references to other documents.
//! - the modifications of a document are propagated to the referencing
//! documents.
-//! - a document can be stored in different formats, with or
+//! - a document can be stored in different formats, with or
//! without a persistent model.
-//! - the drivers for storing and retrieving documents are
+//! - the drivers for storing and retrieving documents are
//! plugged in when necessary.
-//! - a document has a modification counter. This counter is
-//! incremented when the document is modified. When a document
-//! is stored, the current counter value is memorized as the
-//! last storage version of the document. A document is
-//! considered to be modified when the counter value is
-//! different from the storage version. Once the document is
-//! saved the storage version and the counter value are
-//! identical. The document is now not considered to be
+//! - a document has a modification counter. This counter is
+//! incremented when the document is modified. When a document
+//! is stored, the current counter value is memorized as the
+//! last storage version of the document. A document is
+//! considered to be modified when the counter value is
+//! different from the storage version. Once the document is
+//! saved the storage version and the counter value are
+//! identical. The document is now not considered to be
//! modified.
//! - a reference is a link between two documents. A reference has two
//! components: the "From Document" and the "To Document". When
//! the reference is created. The From Document is considered to
//! be up to date relative to the To Document when the
//! reference counter value is equal to the To Document counter value.
-//! - retrieval of a document having references does not imply
+//! - retrieval of a document having references does not imply
//! the retrieving of the referenced documents.
class CDM_Document : public Standard_Transient
{
public:
- //! The Update method will be called once for each
- //! reference, but it should not perform any computation,
+ //! The Update method will be called once for each
+ //! reference, but it should not perform any computation,
//! to avoid multiple computation of a same document.
Standard_EXPORT virtual void Update(const Handle(CDM_Document)& aToDocument,
const Standard_Integer aReferenceIdentifier,
const Standard_Address aModifContext);
- //! 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.
Standard_EXPORT virtual Standard_Boolean Update(TCollection_ExtendedString& ErrorString);
//! Removes all references having this document for From Document.
Standard_EXPORT void RemoveAllReferences();
- //! Returns the To Document of the reference identified by
+ //! Returns the To Document of the reference identified by
//! aReferenceIdentifier. If the ToDocument is stored and
//! has not yet been retrieved, this method will retrieve it.
Standard_EXPORT Handle(CDM_Document) Document(const Standard_Integer aReferenceIdentifier) const;
- //! returns True if the To Document of the reference
- //! identified by aReferenceIdentifier is in session, False
+ //! returns True if the To Document of the reference
+ //! identified by aReferenceIdentifier is in session, False
//! if it corresponds to a not yet retrieved document.
Standard_EXPORT Standard_Boolean IsInSession(const Standard_Integer aReferenceIdentifier) const;
- //! returns True if the To Document of the reference
+ //! returns True if the To Document of the reference
//! identified by aReferenceIdentifier has already been stored,
- //! False otherwise.
+ //! False otherwise.
Standard_EXPORT Standard_Boolean IsStored(const Standard_Integer aReferenceIdentifier) const;
//! returns the name of the metadata of the To Document of
Standard_EXPORT TCollection_ExtendedString
Name(const Standard_Integer aReferenceIdentifier) const;
- //! call virtual method Update on all referencing
- //! documents. This method keeps the list of the --
- //! documents to process.It may be the starting of an
- //! update -- cycle. If not, the reentrant calls made by
- //! Update method (without argument) will append the
+ //! call virtual method Update on all referencing
+ //! documents. This method keeps the list of the
+ //! documents to process. It may be the starting of an
+ //! update cycle. If not, the reentrant calls made by
+ //! Update method (without argument) will append the
//! referencing documents to the list and call the Update method
//! (with arguments). Only the first call to UpdateFromDocuments
//! generate call to Update().
//! returns True is this document references aDocument;
Standard_EXPORT Standard_Boolean DeepReferences(const Handle(CDM_Document)& aDocument) const;
- //! Copies a reference to this document. This method
- //! avoid retrieval of referenced document. The arguments
- //! are the original document and a valid reference
+ //! Copies a reference to this document. This method
+ //! avoid retrieval of referenced document. The arguments
+ //! are the original document and a valid reference
//! identifier Returns the local identifier.
Standard_EXPORT Standard_Integer CopyReference(const Handle(CDM_Document)& aFromDocument,
const Standard_Integer aReferenceIdentifier);
- //! indicates that this document cannot be modified.
+ //! indicates that this document cannot be modified.
Standard_EXPORT Standard_Boolean IsReadOnly() const;
//! indicates that the referenced document cannot be modified,
Standard_EXPORT Standard_Boolean IsStored() const;
- //! returns the value of the modification counter at the
+ //! returns the value of the modification counter at the
//! time of storage. By default returns 0.
Standard_EXPORT Standard_Integer StorageVersion() const;
- //! associates database information to a document which
- //! has been stored. The name of the document is now the
+ //! associates database information to a document which
+ //! has been stored. The name of the document is now the
//! name which has beenused to store the data.
Standard_EXPORT void SetMetaData(const Handle(CDM_MetaData)& aMetaData);
Standard_EXPORT TCollection_ExtendedString RequestedPreviousVersion() const;
- //! defines the Comment with which the object should be stored.
+ //! defines the Comment with which the object should be stored.
Standard_EXPORT void SetRequestedComment(const TCollection_ExtendedString& aComment);
Standard_EXPORT TCollection_ExtendedString RequestedComment() const;
//! gets the `FileFormat`.Description resource.
Standard_EXPORT TCollection_ExtendedString Description();
- //! returns true if the version is greater than the
+ //! returns true if the version is greater than the
//! storage version
Standard_EXPORT Standard_Boolean IsModified() const;
Standard_EXPORT const Handle(CDM_Application)& Application() const;
- //! A referenced document may indicate through this
- //! virtual method that it does not allow the closing of
- //! aDocument which it references through the reference
+ //! A referenced document may indicate through this
+ //! virtual method that it does not allow the closing of
+ //! aDocument which it references through the reference
//! aReferenceIdentifier. By default returns Standard_True.
Standard_EXPORT virtual Standard_Boolean CanCloseReference(
const Handle(CDM_Document)& aDocument,
Standard_EXPORT virtual void CloseReference(const Handle(CDM_Document)& aDocument,
const Standard_Integer aReferenceIdentifier);
- //! returns true if the document corresponding to the
- //! given reference has been retrieved and opened.
+ //! returns true if the document corresponding to the
+ //! given reference has been retrieved and opened.
//! Otherwise returns false. This method does not retrieve
//! the referenced document
Standard_EXPORT Standard_Boolean IsOpened(const Standard_Integer aReferenceIdentifier) const;
Standard_Boolean myResourcesAreLoaded;
private:
- //! the manager returned by this method will be
+ //! the manager returned by this method will be
//! used to search for the following resource items.
Standard_EXPORT Handle(Resource_Manager) StorageResource();
friend class CDM_Reference;
friend
- //! associates database information to a document which
- //! has been stored. The name of the document is now the
+ //! associates database information to a document which
+ //! has been stored. The name of the document is now the
//! name which has beenused to store the data.
Standard_EXPORT void
CDM_Document::SetMetaData(const Handle(CDM_MetaData)& aMetaData);
Standard_EXPORT void UnsetToDocument(const Handle(CDM_MetaData)& aMetaData,
const Handle(CDM_Application)& anApplication);
- //! returns true if the ToDocument has been retrieved
+ //! returns true if the ToDocument has been retrieved
//! and opened.
Standard_EXPORT Standard_Boolean IsOpened() const;
Standard_EXPORT static void WriteFileFormat(const Handle(Storage_Data)& aData,
const Handle(CDM_Document)& aDocument);
- //! tries to get a format in the file. returns an empty
+ //! tries to get a format in the file. returns an empty
//! string if the file could not be read or does not have
//! a FileFormat information.
Standard_EXPORT static TCollection_ExtendedString FileFormat(
const TCollection_ExtendedString& aFileName);
- //! tries to get a format from the stream. returns an empty
+ //! tries to get a format from the stream. returns an empty
//! string if the file could not be read or does not have
//! a FileFormat information.
Standard_EXPORT static TCollection_ExtendedString FileFormat(Standard_IStream& theIStream,
//! persistent implementation of storage.
//!
-//! The application must redefine one the two Make()
-//! methods. The first one, if the application wants to
+//! The application must redefine one the two Make()
+//! methods. The first one, if the application wants to
//! put only one document in the storage file.
//!
-//! The second method should be redefined to put
-//! additional document that could be used by the
+//! The second method should be redefined to put
+//! additional document that could be used by the
//! retrieval instead of the principal document, depending
-//! on the schema used during the retrieval. For example,
-//! a second document could be a standard
-//! CDMShape_Document. This means that a client
+//! on the schema used during the retrieval. For example,
+//! a second document could be a standard
+//! CDMShape_Document. This means that a client
//! application will already be able to extract a CDMShape_Document
//! of the file, if the Shape Schema remains unchanged.
class PCDM_StorageDriver : public PCDM_Writer
//! raises NotImplemented.
Standard_EXPORT virtual Handle(PCDM_Document) Make(const Handle(CDM_Document)& aDocument);
- //! By default, puts in the Sequence the document returns
+ //! By default, puts in the Sequence the document returns
//! by the previous Make method.
Standard_EXPORT virtual void Make(const Handle(CDM_Document)& aDocument,
PCDM_SequenceOfDocument& Documents);
//! Make method.
//! stores the content of the Document into a new file.
//!
- //! by default Write will use Make method to build a persistent
+ //! by default Write will use Make method to build a persistent
//! document and the Schema method to write the persistent document.
Standard_EXPORT virtual void Write(
const Handle(CDM_Document)& aDocument,
class AppStdL_Application : public TDocStd_Application
{
public:
- //! returns the file name which contains application
+ //! returns the file name which contains application
//! resources
Standard_EXPORT Standard_CString ResourcesName() Standard_OVERRIDE;
//! Returns true if <me> owns an attribute with <anID> as ID.
Standard_EXPORT Standard_Boolean IsAttribute(const Standard_GUID& anID) const;
- //! Adds an Attribute to the current label. Raises if
+ //! Adds an Attribute to the current label. Raises if
//! there is already one.
Standard_EXPORT void AddAttribute(const Handle(TDF_Attribute)& anAttribute,
const Standard_Boolean append = Standard_True) const;
- //! Forgets an Attribute from the current label,
- //! setting its forgotten status true and its valid
- //! status false. Raises if the attribute is not in
+ //! Forgets an Attribute from the current label,
+ //! setting its forgotten status true and its valid
+ //! status false. Raises if the attribute is not in
//! the structure.
Standard_EXPORT void ForgetAttribute(const Handle(TDF_Attribute)& anAttribute) const;
- //! Forgets the Attribute of GUID <aguid> from the
- //! current label . If the attribute doesn't exist
+ //! Forgets the Attribute of GUID <aguid> from the
+ //! current label. If the attribute doesn't exist
//! returns False. Otherwise returns True.
Standard_EXPORT Standard_Boolean ForgetAttribute(const Standard_GUID& aguid) const;
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 autoamtic
//! delivery tags provided by TagSource.
TDF_Label NewChild() const;
const Handle(TDF_Attribute)& anAttribute,
const Standard_Boolean append) const;
- //! Forgets an Attribute from <fromNode>. Raises if
+ //! Forgets an Attribute from <fromNode>. Raises if
//! the attribute is not in the structure.
Standard_EXPORT void ForgetFromNode(const TDF_LabelNodePtr& fromNode,
const Handle(TDF_Attribute)& anAttribute) const;
- //! Resumes a forgotten Attribute to <toNode>. Raises
+ //! Resumes a forgotten Attribute to <toNode>. Raises
//! if the attribute is not in the structure.
Standard_EXPORT void ResumeToNode(const TDF_LabelNodePtr& fromNode,
const Handle(TDF_Attribute)& anAttribute) const;
const TCollection_AsciiString& string);
//! Finds, or creates, an AsciiString attribute with explicit user defined <guid> and sets
- //! <string>. The Name attribute is returned.
+ //! <string>. The Name attribute is returned.
Standard_EXPORT static Handle(TDataStd_AsciiString) Set(const TDF_Label& label,
const Standard_GUID& guid,
const TCollection_AsciiString& string);
Standard_EXPORT void Set(const TCollection_AsciiString& S);
- //! Sets the explicit user defined GUID to the attribute.
+ //! Sets the explicit user defined GUID to the attribute.
Standard_EXPORT void SetID(const Standard_GUID& guid) Standard_OVERRIDE;
//! Sets default GUID for the attribute.
//! Sets the <Index>th element of the array to <Value>
//! OutOfRange exception is raised if <Index> doesn't respect Lower and Upper bounds of the
- //! internal array.
+ //! internal array.
Standard_EXPORT void SetValue(const Standard_Integer index, const Standard_Boolean value);
//! Sets the explicit GUID (user defined) for the attribute.
//! Sets the <Index>th element of the array to <Value>
//! OutOfRange exception is raised if <Index> doesn't respect Lower and Upper bounds of the
- //! internal array.
+ //! internal array.
Standard_EXPORT void SetValue(const Standard_Integer index, const Standard_Byte value);
//! Sets the explicit GUID (user defined) for the attribute.
const Handle(TColStd_HArray1OfByte)& InternalArray() const { return myValue; }
- //! Sets the inner array <myValue> of the attribute to
+ //! Sets the inner array <myValue> of the attribute to
//! <newArray>. If value of <newArray> differs from <myValue>, Backup performed
//! and myValue refers to new instance of HArray1OfInteger that holds <newArray>
//! values.
Standard_Boolean GetDelta() const { return myIsDelta; }
- //! for internal use only!
+ //! for internal use only!
void SetDelta(const Standard_Boolean isDelta) { myIsDelta = isDelta; }
Standard_EXPORT TDataStd_ByteArray();
#include <Standard_Boolean.hxx>
class TDataStd_TreeNode;
-//! Iterates on the ChildStepren step of a step, at the
-//! first level only. It is possible to ask the
+//! Iterates on the ChildStepren step of a step, at the
+//! first level only. It is possible to ask the
//! iterator to explore all the sub step levels of the
//! given one, with the option "allLevels".
class TDataStd_ChildNodeIterator
Standard_EXPORT TDataStd_ChildNodeIterator(const Handle(TDataStd_TreeNode)& aTreeNode,
const Standard_Boolean allLevels = Standard_False);
- //! Initializes the iteration on the Children Step of
- //! the given Step. If <allLevels> option is set to
- //! true, it explores not only the first, but all the
+ //! Initializes the iteration on the Children Step of
+ //! the given Step. If <allLevels> option is set to
+ //! true, it explores not only the first, but all the
//! sub Step levels.
Standard_EXPORT void Initialize(const Handle(TDataStd_TreeNode)& aTreeNode,
const Standard_Boolean allLevels = Standard_False);
class TDataStd_Comment;
DEFINE_STANDARD_HANDLE(TDataStd_Comment, TDataStd_GenericExtString)
-//! Comment attribute. may be associated to any label
+//! Comment attribute. may be associated to any label
//! to store user comment.
class TDataStd_Comment : public TDataStd_GenericExtString
{
//! Returns the GUID for comments.
Standard_EXPORT static const Standard_GUID& GetID();
- //! Find, or create a Comment attribute. the Comment
+ //! Find, or create a Comment attribute. the Comment
//! attribute is returned.
Standard_EXPORT static Handle(TDataStd_Comment) Set(const TDF_Label& label);
Standard_EXPORT void Set(const TCollection_ExtendedString& S) Standard_OVERRIDE;
- //! Sets the explicit user defined GUID to the attribute.
+ //! Sets the explicit user defined GUID to the attribute.
Standard_EXPORT void SetID(const Standard_GUID& guid) Standard_OVERRIDE;
//! Sets default GUID for the attribute.
class TDataStd_Current;
DEFINE_STANDARD_HANDLE(TDataStd_Current, TDF_Attribute)
-//! this attribute, located at root label, manage an
+//! this attribute, located at root label, manage an
//! access to a current label.
class TDataStd_Current : public TDF_Attribute
{
//! returns current of <acces> Framework. raise if (!Has)
Standard_EXPORT static TDF_Label Get(const TDF_Label& acces);
- //! returns True if a
current label is managed in <acces>
+ //! returns True if a current label is managed in <acces>
//! Framework.
//! class methods
//! =============
Standard_EXPORT static Standard_Boolean Find(const TDF_Label& current,
Handle(TDataStd_Directory)& D);
- //! Creates an empty Directory attribute, located at
+ //! Creates an empty Directory attribute, located at
//! <label>. Raises if <label> has attribute
Standard_EXPORT static Handle(TDataStd_Directory) New(const TDF_Label& label);
//! Expression 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
//! expression must have its equivalent in the string
class TDataStd_Expression : public TDF_Attribute
{
const Standard_Boolean isDelta = Standard_False);
//! Finds, or creates, an ExtStringArray attribute with explicit user defined <guid>.
- //! The ExtStringArray attribute is returned.
+ //! The ExtStringArray attribute is returned.
Standard_EXPORT static Handle(TDataStd_ExtStringArray) Set(
const TDF_Label& label,
const Standard_GUID& theGuid,
//! Initializes the inner array with bounds from <lower> to <upper>
Standard_EXPORT void Init(const Standard_Integer lower, const Standard_Integer upper);
- //! Sets the <Index>th element of the array to <Value>
+ //! Sets the <Index>th element of the array to <Value>
//! OutOfRange exception is raised if <Index> doesn't respect Lower and Upper bounds of the
- //! internal array.
+ //! internal array.
Standard_EXPORT void SetValue(const Standard_Integer Index,
const TCollection_ExtendedString& Value);
//! Sets default GUID for the attribute.
Standard_EXPORT void SetID() Standard_OVERRIDE;
- //! Returns the value of the <Index>th element of the array
+ //! Returns the value of the <Index>th element of the array
Standard_EXPORT const TCollection_ExtendedString& Value(const Standard_Integer Index) const;
const TCollection_ExtendedString& operator()(const Standard_Integer Index) const
Standard_Boolean GetDelta() const { return myIsDelta; }
- //! for internal use only!
+ //! for internal use only!
void SetDelta(const Standard_Boolean isDelta) { myIsDelta = isDelta; }
Standard_EXPORT TDataStd_ExtStringArray();
//! Sets <S> as name. Raises if <S> is not a valid name.
Standard_EXPORT virtual void Set(const TCollection_ExtendedString& S);
- //! Sets the explicit user defined GUID to the attribute.
+ //! Sets the explicit user defined GUID to the attribute.
Standard_EXPORT void SetID(const Standard_GUID& guid) Standard_OVERRIDE;
//! Returns the name contained in this name attribute.
Standard_Boolean GetDelta() const { return myIsDelta; }
- //! for internal use only!
+ //! for internal use only!
void SetDelta(const Standard_Boolean isDelta) { myIsDelta = isDelta; }
Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
Standard_EXPORT static const Standard_GUID& GetID();
//! Finds, or creates, an Integer attribute and sets <value>
- //! the Integer attribute is returned.
+ //! the Integer attribute is returned.
Standard_EXPORT static Handle(TDataStd_Integer) Set(const TDF_Label& label,
const Standard_Integer value);
//! Finds, or creates, an Integer attribute with explicit user defined <guid> and sets <value>.
- //! The Integer attribute is returned.
+ //! The Integer attribute is returned.
Standard_EXPORT static Handle(TDataStd_Integer) Set(const TDF_Label& label,
const Standard_GUID& guid,
const Standard_Integer value);
const Standard_Boolean isDelta = Standard_False);
//! Finds, or creates, an IntegerArray attribute with explicit user defined <guid>.
- //! The IntegerArray attribute is returned.
+ //! The IntegerArray attribute is returned.
Standard_EXPORT static Handle(TDataStd_IntegerArray) Set(
const TDF_Label& label,
const Standard_GUID& theGuid,
//! Initialize the inner array with bounds from <lower> to <upper>
Standard_EXPORT void Init(const Standard_Integer lower, const Standard_Integer upper);
- //! Sets the <Index>th element of the array to <Value>
+ //! Sets the <Index>th element of the array to <Value>
//! OutOfRange exception is raised if <Index> doesn't respect Lower and Upper bounds of the
//! internal array.
Standard_EXPORT void SetValue(const Standard_Integer Index, const Standard_Integer Value);
//! Sets default GUID for the attribute.
Standard_EXPORT void SetID() Standard_OVERRIDE;
- //! Return the value of the <Index>th element of the array
+ //! Return the value of the <Index>th element of the array
Standard_EXPORT Standard_Integer Value(const Standard_Integer Index) const;
Standard_Integer operator()(const Standard_Integer Index) const { return Value(Index); }
//! terms of the number of elements it contains.
Standard_EXPORT Standard_Integer Length() const;
- //! Sets the inner array <myValue> of the IntegerArray attribute to
+ //! Sets the inner array <myValue> of the IntegerArray attribute to
//! <newArray>. If value of <newArray> differs from <myValue>, Backup performed
//! and myValue refers to new instance of HArray1OfInteger that holds <newArray>
//! values
Standard_Boolean GetDelta() const { return myIsDelta; }
- //! for internal use only!
+ //! for internal use only!
void SetDelta(const Standard_Boolean isDelta) { myIsDelta = isDelta; }
Standard_EXPORT TDataStd_IntegerArray();
Standard_EXPORT static const Standard_GUID& GetID();
//! Creates (if does not exist) and sets the name in the name attribute.
- //! from any label <L> search in father labels (L is not
- //! concerned) the first name attribute.if found set it in
+ //! from any label <L> search in father labels (L is not
+ //! concerned) the first name attribute. if found set it in
//! <father>.
//! class methods working on the name tree
//! ======================================
- //! Search in the whole TDF_Data the Name attribute which
+ //! Search in the whole TDF_Data the Name attribute which
//! fit with <fullPath>. Returns True if found.
- //! Search under <currentLabel> a label which fit with
- //! <name>. Returns True if found. Shortcut which avoids
+ //! Search under <currentLabel> a label which fit with
+ //! <name>. Returns True if found. Shortcut which avoids
//! building a ListOfExtendedStrin.
//! Search in the whole TDF_Data the label which fit with name
//! Returns True if found.
const TCollection_ExtendedString& string);
//! Finds, or creates, a Name attribute with explicit user defined <guid> and sets <string>.
- //! The Name attribute is returned.
+ //! The Name attribute is returned.
Standard_EXPORT static Handle(TDataStd_Name) Set(const TDF_Label& label,
const Standard_GUID& guid,
const TCollection_ExtendedString& string);
//! Sets <S> as name. Raises if <S> is not a valid name.
Standard_EXPORT void Set(const TCollection_ExtendedString& S) Standard_OVERRIDE;
- //! Sets the explicit user defined GUID to the attribute.
+ //! Sets the explicit user defined GUID to the attribute.
Standard_EXPORT void SetID(const Standard_GUID& guid) Standard_OVERRIDE;
//! Sets default GUID for the attribute.
//! class methods
//! =============
//! try to retrieve a NoteBook attribute at <current> label
- //! or in fathers label of <current>. Returns True if
+ //! or in fathers label of <current>. Returns True if
//! found and set <N>.
Standard_EXPORT static Standard_Boolean Find(const TDF_Label& current,
Handle(TDataStd_NoteBook)& N);
- //! Create an enpty NoteBook attribute, located at
+ //! Create an enpty NoteBook attribute, located at
//! <label>. Raises if <label> has attribute
Standard_EXPORT static Handle(TDataStd_NoteBook) New(const TDF_Label& label);
Standard_EXPORT TDataStd_NoteBook();
- //! Tool to Create an Integer attribute from <value>,
- //! Insert it in a new son label of <me>. The Real
+ //! Tool to Create an Integer attribute from <value>,
+ //! Insert it in a new son label of <me>. The Real
//! attribute is returned.
Standard_EXPORT Handle(TDataStd_Real) Append(const Standard_Real value,
const Standard_Boolean isExported = Standard_False);
- //! Tool to Create an Real attribute from <value>, Insert
- //! it in a new son label of <me>. The Integer attribute
+ //! Tool to Create an Real attribute from <value>, Insert
+ //! it in a new son label of <me>. The Integer attribute
//! is returned.
Standard_EXPORT Handle(TDataStd_Integer) Append(
const Standard_Integer value,
Standard_EXPORT static const Standard_GUID& GetID();
//! Finds, or creates, a Real attribute with default GUID and sets <value>.
- //! The Real attribute is returned. The Real dimension is Scalar by default.
+ //! The Real attribute is returned. The Real dimension is Scalar by default.
//! Use SetDimension to overwrite.
//! Real methods
//! ============
const Standard_Real value);
//! Finds, or creates, a Real attribute with explicit GUID and sets <value>.
- //! The Real attribute is returned.
+ //! The Real attribute is returned.
//! Real methods
//! ============
Standard_EXPORT static Handle(TDataStd_Real) Set(const TDF_Label& label,
const Standard_Boolean isDelta = Standard_False);
//! Finds, or creates, an RealArray attribute with explicit user defined <guid>.
- //! The RealArray attribute is returned.
+ //! The RealArray attribute is returned.
Standard_EXPORT static Handle(TDataStd_RealArray) Set(
const TDF_Label& label,
const Standard_GUID& theGuid,
//! Sets default GUID for the attribute.
Standard_EXPORT void SetID() Standard_OVERRIDE;
- //! Sets the <Index>th element of the array to <Value>
+ //! Sets the <Index>th element of the array to <Value>
//! OutOfRange exception is raised if <Index> doesn't respect Lower and Upper bounds of the
- //! internal array.
+ //! internal array.
Standard_EXPORT void SetValue(const Standard_Integer Index, const Standard_Real Value);
- //! Return the value of the <Index>th element of the array
+ //! Return the value of the <Index>th element of the array
Standard_EXPORT Standard_Real Value(const Standard_Integer Index) const;
Standard_Real operator()(const Standard_Integer Index) const { return Value(Index); }
Standard_Boolean GetDelta() const { return myIsDelta; }
- //! for internal use only!
+ //! for internal use only!
void SetDelta(const Standard_Boolean isDelta) { myIsDelta = isDelta; }
Standard_EXPORT TDataStd_RealArray();
//! Sets the <Index>th element of the array to <Value>
//! OutOfRange exception is raised if <Index> doesn't respect Lower and Upper bounds of the
- //! internal array.
+ //! internal array.
Standard_EXPORT void SetValue(const Standard_Integer index, const TDF_Label& value);
//! Sets the explicit GUID (user defined) for the attribute.
Save(const Handle(TDocStd_Document)& theDoc,
const Message_ProgressRange& theRange = Message_ProgressRange());
- //! Save the active document in the file <name> in the
- //! path <path> . overwrite the file if it
- //! already exist.
+ //! Save the active document in the file <name> in the
+ //! path <path>. overwrite the file if it already exists.
Standard_EXPORT PCDM_StoreStatus
SaveAs(const Handle(TDocStd_Document)& theDoc,
const TCollection_ExtendedString& path,
projects / occt.git / commitdiff