TransferWriter gives help to control transfer to write a file after having converted data from Cascade/Imagine. More...
#include <XSControl_TransferWriter.hxx>
Public Member Functions | |
| XSControl_TransferWriter () | |
| Creates a TransferWriter, empty, ready to run with an empty FinderProcess (but no controller, etc) More... | |
| Handle< Transfer_FinderProcess > | FinderProcess () const |
| Returns the FinderProcess itself. More... | |
| void | SetFinderProcess (const Handle< Transfer_FinderProcess > &FP) |
| Sets a new FinderProcess and forgets the former one. More... | |
| Handle< XSControl_Controller > | Controller () const |
| Returns the currently used Controller. More... | |
| void | SetController (const Handle< XSControl_Controller > &ctl) |
| Sets a new Controller, also sets a new FinderProcess. More... | |
| void | Clear (const Standard_Integer mode) |
| Clears recorded data according a mode 0 clears FinderProcess (results, checks) -1 create a new FinderProcess. More... | |
| Standard_Integer | TransferMode () const |
| Returns the current Transfer Mode (an Integer) It will be interpreted by the Controller to run Transfers This call form could be later replaced by more specific ones (parameters suited for each norm / transfer case) More... | |
| void | SetTransferMode (const Standard_Integer mode) |
| Changes the Transfer Mode. More... | |
| void | PrintStats (const Standard_Integer what, const Standard_Integer mode=0) const |
| Prints statistics on current Trace File, according what,mode See PrintStatsProcess for details. More... | |
| Standard_Boolean | RecognizeTransient (const Handle< Standard_Transient > &obj) |
| Tells if a transient object (from an application) is a valid candidate for a transfer to a model Asks the Controller (RecognizeWriteTransient) If <obj> is a HShape, calls RecognizeShape. More... | |
| IFSelect_ReturnStatus | TransferWriteTransient (const Handle< Interface_InterfaceModel > &model, const Handle< Standard_Transient > &obj) |
| Transfers a Transient object (from an application) to a model of current norm, according to the last call to SetTransferMode Works by calling the Controller Returns status : =0 if OK, >0 if error during transfer, <0 if transfer badly initialised. More... | |
| Standard_Boolean | RecognizeShape (const TopoDS_Shape &shape) |
| Tells if a Shape is valid for a transfer to a model Asks the Controller (RecognizeWriteShape) More... | |
| IFSelect_ReturnStatus | TransferWriteShape (const Handle< Interface_InterfaceModel > &model, const TopoDS_Shape &shape) |
| Transfers a Shape from CasCade to a model of current norm, according to the last call to SetTransferMode Works by calling the Controller Returns status : =0 if OK, >0 if error during transfer, <0 if transfer badly initialised. More... | |
| Interface_CheckIterator | CheckList () const |
| Returns the check-list of last transfer (write), i.e. the check-list currently recorded in the FinderProcess. More... | |
| Interface_CheckIterator | ResultCheckList (const Handle< Interface_InterfaceModel > &model) const |
| Returns the check-list of last transfer (write), but tries to bind to each check, the resulting entity in the model instead of keeping the original Mapper, whenever known. More... | |
 Public Member Functions inherited from MMgt_TShared | |
| virtual void | Delete () const |
| Memory deallocator for transient classes. More... | |
| Public Member Functions inherited from Standard_Transient | |
| Standard_Transient () | |
| Empty constructor. More... | |
| Standard_Transient (const Standard_Transient &) | |
| Copy constructor – does nothing. More... | |
| Standard_Transient & | operator= (const Standard_Transient &) |
| Assignment operator, needed to avoid copying reference counter. More... | |
| virtual | ~Standard_Transient () |
| Destructor must be virtual. More... | |
| virtual const Handle_Standard_Type & | DynamicType () const |
| Returns a type information object about this object. More... | |
| Standard_Boolean | IsInstance (const Handle_Standard_Type &theType) const |
| Returns a true value if this is an instance of Type. More... | |
| Standard_Boolean | IsInstance (const Standard_CString theTypeName) const |
| Returns a true value if this is an instance of TypeName. More... | |
| Standard_Boolean | IsKind (const Handle_Standard_Type &theType) const |
| Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More... | |
| Standard_Boolean | IsKind (const Standard_CString theTypeName) const |
| Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More... | |
| virtual Handle_Standard_Transient | This () const |
| Returns a Handle which references this object. Must never be called to objects created in stack. More... | |
| Standard_Integer | GetRefCount () const |
| Get the reference counter of this object. More... | |
Static Public Member Functions | |
| static void | PrintStatsProcess (const Handle< Transfer_FinderProcess > &TP, const Standard_Integer what, const Standard_Integer mode=0) |
| Forecast to print statitics about a FinderProcess. More... | |
Detailed Description
TransferWriter gives help to control transfer to write a file after having converted data from Cascade/Imagine.
It works with a Controller (which itself can work with an Actor to Write) and a FinderProcess. It records results and checks
Constructor & Destructor Documentation
| XSControl_TransferWriter::XSControl_TransferWriter | ( | ) |
Creates a TransferWriter, empty, ready to run with an empty FinderProcess (but no controller, etc)
Member Function Documentation
| Interface_CheckIterator XSControl_TransferWriter::CheckList | ( | ) | const |
Returns the check-list of last transfer (write), i.e. the check-list currently recorded in the FinderProcess.
| void XSControl_TransferWriter::Clear | ( | const Standard_Integer | mode | ) |
Clears recorded data according a mode 0 clears FinderProcess (results, checks) -1 create a new FinderProcess.
| Handle< XSControl_Controller > XSControl_TransferWriter::Controller | ( | ) | const |
Returns the currently used Controller.
| Handle< Transfer_FinderProcess > XSControl_TransferWriter::FinderProcess | ( | ) | const |
Returns the FinderProcess itself.
| void XSControl_TransferWriter::PrintStats | ( | const Standard_Integer | what, |
| const Standard_Integer | mode = 0 |
||
| ) | const |
Prints statistics on current Trace File, according what,mode See PrintStatsProcess for details.
|
static |
Forecast to print statitics about a FinderProcess.
| Standard_Boolean XSControl_TransferWriter::RecognizeShape | ( | const TopoDS_Shape & | shape | ) |
Tells if a Shape is valid for a transfer to a model Asks the Controller (RecognizeWriteShape)
| Standard_Boolean XSControl_TransferWriter::RecognizeTransient | ( | const Handle< Standard_Transient > & | obj | ) |
Tells if a transient object (from an application) is a valid candidate for a transfer to a model Asks the Controller (RecognizeWriteTransient) If <obj> is a HShape, calls RecognizeShape.
| Interface_CheckIterator XSControl_TransferWriter::ResultCheckList | ( | const Handle< Interface_InterfaceModel > & | model | ) | const |
Returns the check-list of last transfer (write), but tries to bind to each check, the resulting entity in the model instead of keeping the original Mapper, whenever known.
| void XSControl_TransferWriter::SetController | ( | const Handle< XSControl_Controller > & | ctl | ) |
Sets a new Controller, also sets a new FinderProcess.
| void XSControl_TransferWriter::SetFinderProcess | ( | const Handle< Transfer_FinderProcess > & | FP | ) |
Sets a new FinderProcess and forgets the former one.
| void XSControl_TransferWriter::SetTransferMode | ( | const Standard_Integer | mode | ) |
Changes the Transfer Mode.
| Standard_Integer XSControl_TransferWriter::TransferMode | ( | ) | const |
Returns the current Transfer Mode (an Integer) It will be interpreted by the Controller to run Transfers This call form could be later replaced by more specific ones (parameters suited for each norm / transfer case)
| IFSelect_ReturnStatus XSControl_TransferWriter::TransferWriteShape | ( | const Handle< Interface_InterfaceModel > & | model, |
| const TopoDS_Shape & | shape | ||
| ) |
Transfers a Shape from CasCade to a model of current norm, according to the last call to SetTransferMode Works by calling the Controller Returns status : =0 if OK, >0 if error during transfer, <0 if transfer badly initialised.
| IFSelect_ReturnStatus XSControl_TransferWriter::TransferWriteTransient | ( | const Handle< Interface_InterfaceModel > & | model, |
| const Handle< Standard_Transient > & | obj | ||
| ) |
Transfers a Transient object (from an application) to a model of current norm, according to the last call to SetTransferMode Works by calling the Controller Returns status : =0 if OK, >0 if error during transfer, <0 if transfer badly initialised.
The documentation for this class was generated from the following file:
