OpenCascade/occt
1
0
Fork 0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-08-09 13:22:24 +03:00
Code Activity

0026595: Lost some comments in OCCT-code after cdl elimination

Browse Source 
Recovered comments for instance classes from CDL generic classes.
This commit is contained in:
rkv
2015-10-14 17:48:41 +03:00
committed by bugmaster
parent 10dbdf3496
commit 36b9ff756a
251 changed files with 8209 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
src/IGESData/IGESData_FileRecognizer.hxx
View File

@@ -37,10 +37,21 @@ class IGESData_FileRecognizer : public Standard_Transient
public:
//! Evaluates if recognition has a result, returns it if yes
//! In case of success, Returns True and puts result in "res"
//! In case of Failure, simply Returns False
//! Works by calling deferred method Eval, and in case of failure,
//! looks for Added Recognizers to work
Standard_EXPORT Standard_Boolean Evaluate (const IGESData_IGESType& akey, Handle(IGESData_IGESEntity)& res);
//! Returns result of last recognition (call of Evaluate)
Standard_EXPORT Handle(IGESData_IGESEntity) Result() const;
//! Adds a new Recognizer to the Compound, at the end
//! Several calls to Add work by adding in the order of calls :
//! Hence, when Eval has failed to recognize, Evaluate will call
//! Evaluate from the first added Recognizer if there is one,
//! and to the second if there is still no result, and so on
Standard_EXPORT void Add (const Handle(IGESData_FileRecognizer)& reco);
@@ -51,12 +62,21 @@ public:
protected:
//! Assumes that no result has yet been recognized
Standard_EXPORT IGESData_FileRecognizer();
//! Records the result of the recognition. Called by specific
//! method Eval to record a result : after calling it, Eval has
//! finished and can return
Standard_EXPORT void SetOK (const Handle(IGESData_IGESEntity)& aresult);
//! Records that recognition gives no result
Standard_EXPORT void SetKO();
//! THIS METHOD DEFINES THE RECOGNITION PROTOCOL, it is proper to
//! each precise type of Recognizer
//! For a suitable type of akey, it calls SetOK(result) where
//! result is an empty result of appropriate type, then returns
Standard_EXPORT virtual void Eval (const IGESData_IGESType& akey) = 0;

9
src/IGESData/IGESData_GlobalNodeOfSpecificLib.hxx
View File

@@ -38,14 +38,23 @@ class IGESData_GlobalNodeOfSpecificLib : public Standard_Transient
public:
//! Creates an empty GlobalNode, with no Next
Standard_EXPORT IGESData_GlobalNodeOfSpecificLib();
//! Adds a Module bound with a Protocol to the list : does
//! nothing if already in the list, THAT IS, Same Type (exact
//! match) and Same State (that is, IsEqual is not required)
//! Once added, stores its attached Protocol in correspondance
Standard_EXPORT void Add (const Handle(IGESData_SpecificModule)& amodule, const Handle(IGESData_Protocol)& aprotocol);
//! Returns the Module stored in a given GlobalNode
Standard_EXPORT const Handle(IGESData_SpecificModule)& Module() const;
//! Returns the attached Protocol stored in a given GlobalNode
Standard_EXPORT const Handle(IGESData_Protocol)& Protocol() const;
//! Returns the Next GlobalNode. If none is defined, returned
//! value is a Null Handle
Standard_EXPORT const Handle(IGESData_GlobalNodeOfSpecificLib)& Next() const;

9
src/IGESData/IGESData_GlobalNodeOfWriterLib.hxx
View File

@@ -38,14 +38,23 @@ class IGESData_GlobalNodeOfWriterLib : public Standard_Transient
public:
//! Creates an empty GlobalNode, with no Next
Standard_EXPORT IGESData_GlobalNodeOfWriterLib();
//! Adds a Module bound with a Protocol to the list : does
//! nothing if already in the list, THAT IS, Same Type (exact
//! match) and Same State (that is, IsEqual is not required)
//! Once added, stores its attached Protocol in correspondance
Standard_EXPORT void Add (const Handle(IGESData_ReadWriteModule)& amodule, const Handle(IGESData_Protocol)& aprotocol);
//! Returns the Module stored in a given GlobalNode
Standard_EXPORT const Handle(IGESData_ReadWriteModule)& Module() const;
//! Returns the attached Protocol stored in a given GlobalNode
Standard_EXPORT const Handle(IGESData_Protocol)& Protocol() const;
//! Returns the Next GlobalNode. If none is defined, returned
//! value is a Null Handle
Standard_EXPORT const Handle(IGESData_GlobalNodeOfWriterLib)& Next() const;

7
src/IGESData/IGESData_NodeOfSpecificLib.hxx
View File

@@ -38,14 +38,21 @@ class IGESData_NodeOfSpecificLib : public MMgt_TShared
public:
//! Creates an empty Node, with no Next
Standard_EXPORT IGESData_NodeOfSpecificLib();
//! Adds a couple (Module,Protocol), that is, stores it into
//! itself if not yet done, else creates a Next Node to do it
Standard_EXPORT void AddNode (const Handle(IGESData_GlobalNodeOfSpecificLib)& anode);
//! Returns the Module designated by a precise Node
Standard_EXPORT const Handle(IGESData_SpecificModule)& Module() const;
//! Returns the Protocol designated by a precise Node
Standard_EXPORT const Handle(IGESData_Protocol)& Protocol() const;
//! Returns the Next Node. If none was defined, returned value
//! is a Null Handle
Standard_EXPORT const Handle(IGESData_NodeOfSpecificLib)& Next() const;

7
src/IGESData/IGESData_NodeOfWriterLib.hxx
View File

@@ -38,14 +38,21 @@ class IGESData_NodeOfWriterLib : public MMgt_TShared
public:
//! Creates an empty Node, with no Next
Standard_EXPORT IGESData_NodeOfWriterLib();
//! Adds a couple (Module,Protocol), that is, stores it into
//! itself if not yet done, else creates a Next Node to do it
Standard_EXPORT void AddNode (const Handle(IGESData_GlobalNodeOfWriterLib)& anode);
//! Returns the Module designated by a precise Node
Standard_EXPORT const Handle(IGESData_ReadWriteModule)& Module() const;
//! Returns the Protocol designated by a precise Node
Standard_EXPORT const Handle(IGESData_Protocol)& Protocol() const;
//! Returns the Next Node. If none was defined, returned value
//! is a Null Handle
Standard_EXPORT const Handle(IGESData_NodeOfWriterLib)& Next() const;

28
src/IGESData/IGESData_SpecificLib.hxx
View File

@@ -40,28 +40,56 @@ public:
DEFINE_STANDARD_ALLOC
//! Adds a couple (Module-Protocol) into the global definition set
//! for this class of Library.
Standard_EXPORT static void SetGlobal (const Handle(IGESData_SpecificModule)& amodule, const Handle(IGESData_Protocol)& aprotocol);
//! Creates a Library which complies with a Protocol, that is :
//! Same class (criterium IsInstance)
//! This creation gets the Modules from the global set, those
//! which are bound to the given Protocol and its Resources
Standard_EXPORT IGESData_SpecificLib(const Handle(IGESData_Protocol)& aprotocol);
//! Creates an empty Library : it will later by filled by method
//! AddProtocol
Standard_EXPORT IGESData_SpecificLib();
//! Adds a couple (Module-Protocol) to the Library, given the
//! class of a Protocol. Takes Resources into account.
//! (if <aprotocol> is not of type TheProtocol, it is not added)
Standard_EXPORT void AddProtocol (const Handle(Standard_Transient)& aprotocol);
//! Clears the list of Modules of a library (can be used to
//! redefine the order of Modules before action : Clear then
//! refill the Library by calls to AddProtocol)
Standard_EXPORT void Clear();
//! Sets a library to be defined with the complete Global list
//! (all the couples Protocol/Modules recorded in it)
Standard_EXPORT void SetComplete();
//! Selects a Module from the Library, given an Object.
//! Returns True if Select has succeeded, False else.
//! Also Returns (as arguments) the selected Module and the Case
//! Number determined by the associated Protocol.
//! If Select has failed, <module> is Null Handle and CN is zero.
//! (Select can work on any criterium, such as Object DynamicType)
Standard_EXPORT Standard_Boolean Select (const Handle(IGESData_IGESEntity)& obj, Handle(IGESData_SpecificModule)& module, Standard_Integer& CN) const;
//! Starts Iteration on the Modules (sets it on the first one)
Standard_EXPORT void Start();
//! Returns True if there are more Modules to iterate on
Standard_EXPORT Standard_Boolean More() const;
//! Iterates by getting the next Module in the list
//! If there is none, the exception will be raised by Value
Standard_EXPORT void Next();
//! Returns the current Module in the Iteration
Standard_EXPORT const Handle(IGESData_SpecificModule)& Module() const;
//! Returns the current Protocol in the Iteration
Standard_EXPORT const Handle(IGESData_Protocol)& Protocol() const;

28
src/IGESData/IGESData_WriterLib.hxx
View File

@@ -40,28 +40,56 @@ public:
DEFINE_STANDARD_ALLOC
//! Adds a couple (Module-Protocol) into the global definition set
//! for this class of Library.
Standard_EXPORT static void SetGlobal (const Handle(IGESData_ReadWriteModule)& amodule, const Handle(IGESData_Protocol)& aprotocol);
//! Creates a Library which complies with a Protocol, that is :
//! Same class (criterium IsInstance)
//! This creation gets the Modules from the global set, those
//! which are bound to the given Protocol and its Resources
Standard_EXPORT IGESData_WriterLib(const Handle(IGESData_Protocol)& aprotocol);
//! Creates an empty Library : it will later by filled by method
//! AddProtocol
Standard_EXPORT IGESData_WriterLib();
//! Adds a couple (Module-Protocol) to the Library, given the
//! class of a Protocol. Takes Resources into account.
//! (if <aprotocol> is not of type TheProtocol, it is not added)
Standard_EXPORT void AddProtocol (const Handle(Standard_Transient)& aprotocol);
//! Clears the list of Modules of a library (can be used to
//! redefine the order of Modules before action : Clear then
//! refill the Library by calls to AddProtocol)
Standard_EXPORT void Clear();
//! Sets a library to be defined with the complete Global list
//! (all the couples Protocol/Modules recorded in it)
Standard_EXPORT void SetComplete();
//! Selects a Module from the Library, given an Object.
//! Returns True if Select has succeeded, False else.
//! Also Returns (as arguments) the selected Module and the Case
//! Number determined by the associated Protocol.
//! If Select has failed, <module> is Null Handle and CN is zero.
//! (Select can work on any criterium, such as Object DynamicType)
Standard_EXPORT Standard_Boolean Select (const Handle(IGESData_IGESEntity)& obj, Handle(IGESData_ReadWriteModule)& module, Standard_Integer& CN) const;
//! Starts Iteration on the Modules (sets it on the first one)
Standard_EXPORT void Start();
//! Returns True if there are more Modules to iterate on
Standard_EXPORT Standard_Boolean More() const;
//! Iterates by getting the next Module in the list
//! If there is none, the exception will be raised by Value
Standard_EXPORT void Next();
//! Returns the current Module in the Iteration
Standard_EXPORT const Handle(IGESData_ReadWriteModule)& Module() const;
//! Returns the current Protocol in the Iteration
Standard_EXPORT const Handle(IGESData_Protocol)& Protocol() const;