Open CASCADE Technology 7.8.0
|
This class offers a simple, easy to call, way of transferring data from interface files to Shapes from CasCade It must be specialized according to each norm/protocol, by : More...
#include <TransferBRep_Reader.hxx>
Public Member Functions | |
TransferBRep_Reader () | |
Initializes a non-specialised Reader. Typically, for each norm or protocol, is will be required to define a specific Create to load a file and transfer it. | |
void | SetProtocol (const Handle< Interface_Protocol > &protocol) |
Records the protocol to be used for read and transfer roots. | |
virtual Handle< Interface_Protocol > | Protocol () const |
Returns the recorded Protocol. | |
void | SetActor (const Handle< Transfer_ActorOfTransientProcess > &actor) |
Records the actor to be used for transfers. | |
virtual Handle< Transfer_ActorOfTransientProcess > | Actor () const |
Returns the recorded Actor. | |
void | SetFileStatus (const Standard_Integer status) |
Sets File Status to be interpreted as follows : = 0 OK < 0 file not found
| |
Standard_Integer | FileStatus () const |
Returns the File Status. | |
Standard_Boolean | FileNotFound () const |
Returns True if FileStatus is for FileNotFound. | |
Standard_Boolean | SyntaxError () const |
Returns True if FileStatus is for Error during read (major error; for local error, see CheckModel) | |
void | SetModel (const Handle< Interface_InterfaceModel > &model) |
Specifies a Model to work on Also clears the result and Done status. | |
Handle< Interface_InterfaceModel > | Model () const |
Returns the Model to be worked on. | |
void | Clear () |
clears the result and Done status. But not the Model. | |
Standard_Boolean | CheckStatusModel (const Standard_Boolean withprint) const |
Checks the Model. Returns True if there is NO FAIL at all (regardless Warnings) If <withprint> is True, also sends Checks on standard output. | |
Interface_CheckIterator | CheckListModel () const |
Checks the Model (complete : syntax + semantic) and returns the produced Check List. | |
Standard_Boolean & | ModeNewTransfer () |
Returns (by Reference, hence can be changed) the Mode for new Transfer : True (D) means that each new Transfer produces a new TransferProcess. Else keeps the original one but each Transfer clears its (former results are not kept) | |
Standard_Boolean | BeginTransfer () |
Initializes the Reader for a Transfer (one,roots, or list) Also calls PrepareTransfer Returns True when done, False if could not be done. | |
void | EndTransfer () |
Ebds a Transfer (one, roots or list) by recording its result. | |
virtual void | PrepareTransfer () |
Prepares the Transfer. Also can act on the Actor or change the TransientProcess if required. Should not set the Actor into the TransientProcess, it is done by caller. The provided default does nothing. | |
virtual void | TransferRoots (const Message_ProgressRange &theProgress=Message_ProgressRange()) |
Transfers all Root Entities which are recognized as Geom-Topol The result will be a list of Shapes. This method calls user redefinable PrepareTransfer Remark : former result is cleared. | |
virtual Standard_Boolean | Transfer (const Standard_Integer num, const Message_ProgressRange &theProgress=Message_ProgressRange()) |
Transfers an Entity given its rank in the Model (Root or not) Returns True if it is recognized as Geom-Topol. (But it can have failed : see IsDone) | |
virtual void | TransferList (const Handle< TColStd_HSequenceOfTransient > &list, const Message_ProgressRange &theProgress=Message_ProgressRange()) |
Transfers a list of Entities (only the ones also in the Model) Remark : former result is cleared. | |
Standard_Boolean | IsDone () const |
Returns True if the LAST Transfer/TransferRoots was a success. | |
Standard_Integer | NbShapes () const |
Returns the count of produced Shapes (roots) | |
Handle< TopTools_HSequenceOfShape > | Shapes () const |
Returns the complete list of produced Shapes. | |
const TopoDS_Shape & | Shape (const Standard_Integer num=1) const |
Returns a Shape given its rank, by default the first one. | |
TopoDS_Shape | ShapeResult (const Handle< Standard_Transient > &ent) const |
Returns a Shape produced from a given entity (if it was individually transferred or if an intermediate result is known). If no Shape is bound with <ent>, returns a Null Shape Warning : Runs on the last call to Transfer,TransferRoots,TransferList. | |
TopoDS_Shape | OneShape () const |
Returns a unique Shape for the result : | |
Standard_Integer | NbTransients () const |
Returns the count of produced Transient Results (roots) | |
Handle< TColStd_HSequenceOfTransient > | Transients () const |
Returns the complete list of produced Transient Results. | |
Handle< Standard_Transient > | Transient (const Standard_Integer num=1) const |
Returns a Transient Root Result, given its rank (by default the first one) | |
Standard_Boolean | CheckStatusResult (const Standard_Boolean withprints) const |
Checks the Result of last Transfer (individual or roots, no cumulation on several transfers). Returns True if NO fail occurred during Transfer (queries the TransientProcess) | |
Interface_CheckIterator | CheckListResult () const |
Checks the Result of last Transfer (individual or roots, no cumulation on several transfers) and returns the produced list. | |
Handle< Transfer_TransientProcess > | TransientProcess () const |
Returns the TransientProcess. It records information about the very last transfer done. Null if no transfer yet done. Can be used for queries more accurate than the default ones. | |
virtual | ~TransferBRep_Reader () |
Protected Attributes | |
Standard_Boolean | theDone |
Handle< Transfer_TransientProcess > | theProc |
This class offers a simple, easy to call, way of transferring data from interface files to Shapes from CasCade It must be specialized according to each norm/protocol, by :
TransferBRep_Reader::TransferBRep_Reader | ( | ) |
Initializes a non-specialised Reader. Typically, for each norm or protocol, is will be required to define a specific Create to load a file and transfer it.
|
virtual |
|
virtual |
Returns the recorded Actor.
Standard_Boolean TransferBRep_Reader::BeginTransfer | ( | ) |
Initializes the Reader for a Transfer (one,roots, or list) Also calls PrepareTransfer Returns True when done, False if could not be done.
Interface_CheckIterator TransferBRep_Reader::CheckListModel | ( | ) | const |
Checks the Model (complete : syntax + semantic) and returns the produced Check List.
Interface_CheckIterator TransferBRep_Reader::CheckListResult | ( | ) | const |
Checks the Result of last Transfer (individual or roots, no cumulation on several transfers) and returns the produced list.
Standard_Boolean TransferBRep_Reader::CheckStatusModel | ( | const Standard_Boolean | withprint | ) | const |
Checks the Model. Returns True if there is NO FAIL at all (regardless Warnings) If <withprint> is True, also sends Checks on standard output.
Standard_Boolean TransferBRep_Reader::CheckStatusResult | ( | const Standard_Boolean | withprints | ) | const |
Checks the Result of last Transfer (individual or roots, no cumulation on several transfers). Returns True if NO fail occurred during Transfer (queries the TransientProcess)
void TransferBRep_Reader::Clear | ( | ) |
clears the result and Done status. But not the Model.
void TransferBRep_Reader::EndTransfer | ( | ) |
Ebds a Transfer (one, roots or list) by recording its result.
Standard_Boolean TransferBRep_Reader::FileNotFound | ( | ) | const |
Returns True if FileStatus is for FileNotFound.
Standard_Integer TransferBRep_Reader::FileStatus | ( | ) | const |
Returns the File Status.
Standard_Boolean TransferBRep_Reader::IsDone | ( | ) | const |
Returns True if the LAST Transfer/TransferRoots was a success.
Handle< Interface_InterfaceModel > TransferBRep_Reader::Model | ( | ) | const |
Returns the Model to be worked on.
Standard_Boolean & TransferBRep_Reader::ModeNewTransfer | ( | ) |
Returns (by Reference, hence can be changed) the Mode for new Transfer : True (D) means that each new Transfer produces a new TransferProcess. Else keeps the original one but each Transfer clears its (former results are not kept)
Standard_Integer TransferBRep_Reader::NbShapes | ( | ) | const |
Returns the count of produced Shapes (roots)
Standard_Integer TransferBRep_Reader::NbTransients | ( | ) | const |
Returns the count of produced Transient Results (roots)
TopoDS_Shape TransferBRep_Reader::OneShape | ( | ) | const |
Returns a unique Shape for the result :
|
virtual |
Prepares the Transfer. Also can act on the Actor or change the TransientProcess if required. Should not set the Actor into the TransientProcess, it is done by caller. The provided default does nothing.
|
virtual |
Returns the recorded Protocol.
void TransferBRep_Reader::SetActor | ( | const Handle< Transfer_ActorOfTransientProcess > & | actor | ) |
Records the actor to be used for transfers.
void TransferBRep_Reader::SetFileStatus | ( | const Standard_Integer | status | ) |
Sets File Status to be interpreted as follows : = 0 OK < 0 file not found
0 read error, no Model could be created
void TransferBRep_Reader::SetModel | ( | const Handle< Interface_InterfaceModel > & | model | ) |
Specifies a Model to work on Also clears the result and Done status.
void TransferBRep_Reader::SetProtocol | ( | const Handle< Interface_Protocol > & | protocol | ) |
Records the protocol to be used for read and transfer roots.
const TopoDS_Shape & TransferBRep_Reader::Shape | ( | const Standard_Integer | num = 1 | ) | const |
Returns a Shape given its rank, by default the first one.
TopoDS_Shape TransferBRep_Reader::ShapeResult | ( | const Handle< Standard_Transient > & | ent | ) | const |
Returns a Shape produced from a given entity (if it was individually transferred or if an intermediate result is known). If no Shape is bound with <ent>, returns a Null Shape Warning : Runs on the last call to Transfer,TransferRoots,TransferList.
Handle< TopTools_HSequenceOfShape > TransferBRep_Reader::Shapes | ( | ) | const |
Returns the complete list of produced Shapes.
Standard_Boolean TransferBRep_Reader::SyntaxError | ( | ) | const |
Returns True if FileStatus is for Error during read (major error; for local error, see CheckModel)
|
virtual |
Transfers an Entity given its rank in the Model (Root or not) Returns True if it is recognized as Geom-Topol. (But it can have failed : see IsDone)
|
virtual |
Transfers a list of Entities (only the ones also in the Model) Remark : former result is cleared.
|
virtual |
Transfers all Root Entities which are recognized as Geom-Topol The result will be a list of Shapes. This method calls user redefinable PrepareTransfer Remark : former result is cleared.
Handle< Standard_Transient > TransferBRep_Reader::Transient | ( | const Standard_Integer | num = 1 | ) | const |
Returns a Transient Root Result, given its rank (by default the first one)
Handle< Transfer_TransientProcess > TransferBRep_Reader::TransientProcess | ( | ) | const |
Returns the TransientProcess. It records information about the very last transfer done. Null if no transfer yet done. Can be used for queries more accurate than the default ones.
Handle< TColStd_HSequenceOfTransient > TransferBRep_Reader::Transients | ( | ) | const |
Returns the complete list of produced Transient Results.
|
protected |
|
protected |