# DataExchange
TKXSBase
TransferBRep

# TransferBRep_Reader Class Reference

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 :
- defining how to read a file (specific method with protocol)
- definig transfer, by providing an Actor
.

`#include <TransferBRep_Reader.hxx>`

## Public Member Functions

void * | operator new (size_t, void *anAddress)
void * | operator new (size_t size)
void | operator delete (void *anAddress)
Standard_EXPORT | 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 .
Standard_EXPORT void | SetProtocol (const Handle(Interface_Protocol)&protocol)
| Records the protocol to be used for read and transfer roots .
virtual Standard_EXPORT Handle_Interface_Protocol | Protocol () const
| Returns the recorded Protocol .
Standard_EXPORT void | SetActor (const Handle(Transfer_ActorOfTransientProcess)&actor)
| Records the actor to be used for transfers .
virtual Standard_EXPORT Handle_Transfer_ActorOfTransientProcess | Actor () const
| Returns the recorded Actor .
Standard_EXPORT void | 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 .
Standard_EXPORT Standard_Integer | FileStatus () const
| Returns the File Status .
Standard_EXPORT Standard_Boolean | FileNotFound () const
| Returns True if FileStatus is for FileNotFound .
Standard_EXPORT Standard_Boolean | SyntaxError () const
| Returns True if FileStatus is for Error during read (major error; for local error, see CheckModel) .
Standard_EXPORT void | SetModel (const Handle(Interface_InterfaceModel)&model)
| Specifies a Model to work on Also clears the result and Done status .
Standard_EXPORT Handle_Interface_InterfaceModel | Model () const
| Returns the Model to be worked on .
Standard_EXPORT void | Clear ()
| clears the result and Done status. But not the Model.
Standard_EXPORT 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 .
Standard_EXPORT Interface_CheckIterator | CheckListModel () const
| Checks the Model (complete : syntax + semantic) and returns the produced Check List .
Standard_EXPORT 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_EXPORT 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 .
Standard_EXPORT void | EndTransfer ()
| Ebds a Transfer (one, roots or list) by recording its result .
virtual Standard_EXPORT 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 Standard_EXPORT void | TransferRoots ()
| 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_EXPORT Standard_Boolean | Transfer (const Standard_Integer num)
| 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 Standard_EXPORT void | TransferList (const Handle(TColStd_HSequenceOfTransient)&list)
| Transfers a list of Entities (only the ones also in the Model) Remark : former result is cleared .
Standard_EXPORT Standard_Boolean | IsDone () const
| Returns True if the LAST Transfer/TransferRoots was a success .
Standard_EXPORT Standard_Integer | NbShapes () const
| Returns the count of produced Shapes (roots) .
Standard_EXPORT Handle_TopTools_HSequenceOfShape | Shapes () const
| Returns the complete list of produced Shapes .
Standard_EXPORT const TopoDS_Shape & | Shape (const Standard_Integer num=1) const
| Returns a Shape given its rank, by default the first one .
Standard_EXPORT 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 .
Standard_EXPORT TopoDS_Shape | OneShape () const
| Returns a unique Shape for the result : - a void Shape (type = SHAPE) if result is empty - a simple Shape if result has only one : returns this one - a Compound if result has more than one Shape .
Standard_EXPORT Standard_Integer | NbTransients () const
| Returns the count of produced Transient Results (roots) .
Standard_EXPORT Handle_TColStd_HSequenceOfTransient | Transients () const
| Returns the complete list of produced Transient Results .
Standard_EXPORT Handle_Standard_Transient | Transient (const Standard_Integer num=1) const
| Returns a Transient Root Result, given its rank (by default the first one) .
Standard_EXPORT 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 occured during Transfer (queries the TransientProcess) .
Standard_EXPORT Interface_CheckIterator | CheckListResult () const
| Checks the Result of last Transfer (individual or roots, no cumulation on several transfers) and returns the produced list .
Standard_EXPORT Handle_Transfer_TransientProcess | TransientProcess () const
| Returns the TransientProcess. It records informations about the very last transfer done. Null if no transfer yet done. Can be used for queries more accurate than the default ones. .
virtual Standard_EXPORT void | Destroy ()
virtual Standard_EXPORT | ~TransferBRep_Reader ()

## Protected Attributes

Standard_Boolean | theDone
Handle_Transfer_TransientProcess | theProc

## Private Attributes

Handle_Interface_Protocol | theProto
Handle_Transfer_ActorOfTransientProcess | theActor
Handle_Interface_InterfaceModel | theModel
Standard_Integer | theFilest
Standard_Boolean | theNewpr
Handle_TopTools_HSequenceOfShape | theShapes
Handle_TColStd_HSequenceOfTransient | theTransi

## Constructor & Destructor Documentation

Standard_EXPORT TransferBRep_Reader::TransferBRep_Reader | ( |  | ) |

virtual Standard_EXPORT TransferBRep_Reader::~TransferBRep_Reader | ( |  | ) | `[inline, virtual]`

## Member Function Documentation

virtual Standard_EXPORT Handle_Transfer_ActorOfTransientProcess TransferBRep_Reader::Actor | ( |  | ) | const`[virtual]`

Standard_EXPORT Standard_Boolean TransferBRep_Reader::BeginTransfer | ( |  | ) |

Standard_EXPORT Interface_CheckIterator TransferBRep_Reader::CheckListModel | ( |  | ) | const

Standard_EXPORT Interface_CheckIterator TransferBRep_Reader::CheckListResult | ( |  | ) | const

Standard_EXPORT Standard_Boolean TransferBRep_Reader::CheckStatusModel | ( | const Standard_Boolean | withprint | ) | const

Standard_EXPORT Standard_Boolean TransferBRep_Reader::CheckStatusResult | ( | const Standard_Boolean | withprints | ) | const

Standard_EXPORT void TransferBRep_Reader::Clear | ( |  | ) |

virtual Standard_EXPORT void TransferBRep_Reader::Destroy | ( |  | ) | `[virtual]`

Standard_EXPORT void TransferBRep_Reader::EndTransfer | ( |  | ) |

Standard_EXPORT Standard_Boolean TransferBRep_Reader::FileNotFound | ( |  | ) | const

Standard_EXPORT Standard_Integer TransferBRep_Reader::FileStatus | ( |  | ) | const

Standard_EXPORT Standard_Boolean TransferBRep_Reader::IsDone | ( |  | ) | const

Standard_EXPORT Handle_Interface_InterfaceModel TransferBRep_Reader::Model | ( |  | ) | const

Standard_EXPORT Standard_Boolean& TransferBRep_Reader::ModeNewTransfer | ( |  | ) |

Standard_EXPORT Standard_Integer TransferBRep_Reader::NbShapes | ( |  | ) | const

Standard_EXPORT Standard_Integer TransferBRep_Reader::NbTransients | ( |  | ) | const

Standard_EXPORT TopoDS_Shape TransferBRep_Reader::OneShape | ( |  | ) | const

void TransferBRep_Reader::operator delete | ( | void * | anAddress | ) | `[inline]`

void* TransferBRep_Reader::operator new | ( | size_t | size | ) | `[inline]`

void* TransferBRep_Reader::operator new | ( | size_t | ,
|  | void * | anAddress
| ) | `[inline]`

virtual Standard_EXPORT void TransferBRep_Reader::PrepareTransfer | ( |  | ) | `[virtual]`

virtual Standard_EXPORT Handle_Interface_Protocol TransferBRep_Reader::Protocol | ( |  | ) | const`[virtual]`

Standard_EXPORT void TransferBRep_Reader::SetActor | ( | const Handle(Transfer_ActorOfTransientProcess)& | actor | ) |

Standard_EXPORT void TransferBRep_Reader::SetFileStatus | ( | const Standard_Integer | status | ) |

Standard_EXPORT void TransferBRep_Reader::SetModel | ( | const Handle(Interface_InterfaceModel)& | model | ) |

Standard_EXPORT void TransferBRep_Reader::SetProtocol | ( | const Handle(Interface_Protocol)& | protocol | ) |

Standard_EXPORT const TopoDS_Shape& TransferBRep_Reader::Shape | ( | const Standard_Integer | num = `1` | ) | const

Standard_EXPORT TopoDS_Shape TransferBRep_Reader::ShapeResult | ( | const Handle(Standard_Transient)& | ent | ) | const

Standard_EXPORT Handle_TopTools_HSequenceOfShape TransferBRep_Reader::Shapes | ( |  | ) | const

Standard_EXPORT Standard_Boolean TransferBRep_Reader::SyntaxError | ( |  | ) | const

virtual Standard_EXPORT Standard_Boolean TransferBRep_Reader::Transfer | ( | const Standard_Integer | num | ) | `[virtual]`

virtual Standard_EXPORT void TransferBRep_Reader::TransferList | ( | const Handle(TColStd_HSequenceOfTransient)& | list | ) | `[virtual]`

virtual Standard_EXPORT void TransferBRep_Reader::TransferRoots | ( |  | ) | `[virtual]`

Standard_EXPORT Handle_Standard_Transient TransferBRep_Reader::Transient | ( | const Standard_Integer | num = `1` | ) | const

Standard_EXPORT Handle_Transfer_TransientProcess TransferBRep_Reader::TransientProcess | ( |  | ) | const

Standard_EXPORT Handle_TColStd_HSequenceOfTransient TransferBRep_Reader::Transients | ( |  | ) | const

## Field Documentation

Handle_Transfer_ActorOfTransientProcess TransferBRep_Reader::theActor `[private]`

Standard_Boolean TransferBRep_Reader::theDone `[protected]`

Standard_Integer TransferBRep_Reader::theFilest `[private]`

Handle_Interface_InterfaceModel TransferBRep_Reader::theModel `[private]`

Standard_Boolean TransferBRep_Reader::theNewpr `[private]`

Handle_Transfer_TransientProcess TransferBRep_Reader::theProc `[protected]`

Handle_Interface_Protocol TransferBRep_Reader::theProto `[private]`

Handle_TopTools_HSequenceOfShape TransferBRep_Reader::theShapes `[private]`

Handle_TColStd_HSequenceOfTransient TransferBRep_Reader::theTransi `[private]`

The documentation for this class was generated from the following file:

- TransferBRep_Reader.hxx