Open CASCADE Technology  7.5.0.beta
Public Member Functions | Protected Attributes
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 : 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. More...
 
void SetProtocol (const Handle< Interface_Protocol > &protocol)
 Records the protocol to be used for read and transfer roots. More...
 
virtual Handle< Interface_ProtocolProtocol () const
 Returns the recorded Protocol. More...
 
void SetActor (const Handle< Transfer_ActorOfTransientProcess > &actor)
 Records the actor to be used for transfers. More...
 
virtual Handle< Transfer_ActorOfTransientProcessActor () const
 Returns the recorded Actor. More...
 
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

More...
 
Standard_Integer FileStatus () const
 Returns the File Status. More...
 
Standard_Boolean FileNotFound () const
 Returns True if FileStatus is for FileNotFound. More...
 
Standard_Boolean SyntaxError () const
 Returns True if FileStatus is for Error during read (major error; for local error, see CheckModel) More...
 
void SetModel (const Handle< Interface_InterfaceModel > &model)
 Specifies a Model to work on Also clears the result and Done status. More...
 
Handle< Interface_InterfaceModelModel () const
 Returns the Model to be worked on. More...
 
void Clear ()
 clears the result and Done status. But not the Model. More...
 
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. More...
 
Interface_CheckIterator CheckListModel () const
 Checks the Model (complete : syntax + semantic) and returns the produced Check List. More...
 
Standard_BooleanModeNewTransfer ()
 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) More...
 
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. More...
 
void EndTransfer ()
 Ebds a Transfer (one, roots or list) by recording its result. More...
 
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. More...
 
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. More...
 
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) More...
 
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. More...
 
Standard_Boolean IsDone () const
 Returns True if the LAST Transfer/TransferRoots was a success. More...
 
Standard_Integer NbShapes () const
 Returns the count of produced Shapes (roots) More...
 
Handle< TopTools_HSequenceOfShape > Shapes () const
 Returns the complete list of produced Shapes. More...
 
const TopoDS_ShapeShape (const Standard_Integer num=1) const
 Returns a Shape given its rank, by default the first one. More...
 
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. More...
 
TopoDS_Shape OneShape () const
 Returns a unique Shape for the result : More...
 
Standard_Integer NbTransients () const
 Returns the count of produced Transient Results (roots) More...
 
Handle< TColStd_HSequenceOfTransient > Transients () const
 Returns the complete list of produced Transient Results. More...
 
Handle< Standard_TransientTransient (const Standard_Integer num=1) const
 Returns a Transient Root Result, given its rank (by default the first one) More...
 
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) More...
 
Interface_CheckIterator CheckListResult () const
 Checks the Result of last Transfer (individual or roots, no cumulation on several transfers) and returns the produced list. More...
 
Handle< Transfer_TransientProcessTransientProcess () 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. More...
 
virtual ~TransferBRep_Reader ()
 

Protected Attributes

Standard_Boolean theDone
 
Handle< Transfer_TransientProcesstheProc
 

Detailed Description

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 :

Constructor & Destructor Documentation

◆ TransferBRep_Reader()

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.

◆ ~TransferBRep_Reader()

virtual TransferBRep_Reader::~TransferBRep_Reader ( )
virtual

Member Function Documentation

◆ Actor()

virtual Handle< Transfer_ActorOfTransientProcess > TransferBRep_Reader::Actor ( ) const
virtual

Returns the recorded Actor.

◆ BeginTransfer()

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.

◆ CheckListModel()

Interface_CheckIterator TransferBRep_Reader::CheckListModel ( ) const

Checks the Model (complete : syntax + semantic) and returns the produced Check List.

◆ CheckListResult()

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.

◆ CheckStatusModel()

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.

◆ CheckStatusResult()

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 occured during Transfer (queries the TransientProcess)

◆ Clear()

void TransferBRep_Reader::Clear ( )

clears the result and Done status. But not the Model.

◆ EndTransfer()

void TransferBRep_Reader::EndTransfer ( )

Ebds a Transfer (one, roots or list) by recording its result.

◆ FileNotFound()

Standard_Boolean TransferBRep_Reader::FileNotFound ( ) const

Returns True if FileStatus is for FileNotFound.

◆ FileStatus()

Standard_Integer TransferBRep_Reader::FileStatus ( ) const

Returns the File Status.

◆ IsDone()

Standard_Boolean TransferBRep_Reader::IsDone ( ) const

Returns True if the LAST Transfer/TransferRoots was a success.

◆ Model()

Handle< Interface_InterfaceModel > TransferBRep_Reader::Model ( ) const

Returns the Model to be worked on.

◆ ModeNewTransfer()

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)

◆ NbShapes()

Standard_Integer TransferBRep_Reader::NbShapes ( ) const

Returns the count of produced Shapes (roots)

◆ NbTransients()

Standard_Integer TransferBRep_Reader::NbTransients ( ) const

Returns the count of produced Transient Results (roots)

◆ OneShape()

TopoDS_Shape TransferBRep_Reader::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

◆ PrepareTransfer()

virtual void TransferBRep_Reader::PrepareTransfer ( )
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.

◆ Protocol()

virtual Handle< Interface_Protocol > TransferBRep_Reader::Protocol ( ) const
virtual

Returns the recorded Protocol.

◆ SetActor()

void TransferBRep_Reader::SetActor ( const Handle< Transfer_ActorOfTransientProcess > &  actor)

Records the actor to be used for transfers.

◆ SetFileStatus()

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

◆ SetModel()

void TransferBRep_Reader::SetModel ( const Handle< Interface_InterfaceModel > &  model)

Specifies a Model to work on Also clears the result and Done status.

◆ SetProtocol()

void TransferBRep_Reader::SetProtocol ( const Handle< Interface_Protocol > &  protocol)

Records the protocol to be used for read and transfer roots.

◆ Shape()

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

Returns a Shape given its rank, by default the first one.

◆ ShapeResult()

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.

◆ Shapes()

Handle< TopTools_HSequenceOfShape > TransferBRep_Reader::Shapes ( ) const

Returns the complete list of produced Shapes.

◆ SyntaxError()

Standard_Boolean TransferBRep_Reader::SyntaxError ( ) const

Returns True if FileStatus is for Error during read (major error; for local error, see CheckModel)

◆ Transfer()

virtual Standard_Boolean TransferBRep_Reader::Transfer ( const Standard_Integer  num,
const Message_ProgressRange theProgress = Message_ProgressRange() 
)
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)

◆ TransferList()

virtual void TransferBRep_Reader::TransferList ( const Handle< TColStd_HSequenceOfTransient > &  list,
const Message_ProgressRange theProgress = Message_ProgressRange() 
)
virtual

Transfers a list of Entities (only the ones also in the Model) Remark : former result is cleared.

◆ TransferRoots()

virtual void TransferBRep_Reader::TransferRoots ( const Message_ProgressRange theProgress = Message_ProgressRange())
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.

◆ Transient()

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)

◆ TransientProcess()

Handle< Transfer_TransientProcess > TransferBRep_Reader::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.

◆ Transients()

Handle< TColStd_HSequenceOfTransient > TransferBRep_Reader::Transients ( ) const

Returns the complete list of produced Transient Results.

Field Documentation

◆ theDone

Standard_Boolean TransferBRep_Reader::theDone
protected

◆ theProc

Handle< Transfer_TransientProcess > TransferBRep_Reader::theProc
protected

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