XSControl_TransferWriter Class Reference

TransferWriter gives help to control transfer to write a file after having converted data from Cascade/Imagine. More...

#include <XSControl_TransferWriter.hxx>

Inheritance diagram for XSControl_TransferWriter:

Public Member Functions
	XSControl_TransferWriter ()
	Creates a TransferWriter, empty, ready to run with an empty FinderProcess (but no controller, etc)
const Handle< Transfer_FinderProcess > &	FinderProcess () const
	Returns the FinderProcess itself.
void	SetFinderProcess (const Handle< Transfer_FinderProcess > &theFP)
	Sets a new FinderProcess and forgets the former one.
const Handle< XSControl_Controller > &	Controller () const
	Returns the currently used Controller.
void	SetController (const Handle< XSControl_Controller > &theCtl)
	Sets a new Controller, also sets a new FinderProcess.
void	Clear (const Standard_Integer theMode)
	Clears recorded data according a mode 0 clears FinderProcess (results, checks) -1 create a new FinderProcess.
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)
void	SetTransferMode (const Standard_Integer theMode)
	Changes the Transfer Mode.
void	PrintStats (const Standard_Integer theWhat, const Standard_Integer theMode=0) const
	Prints statistics on current Trace File, according what,mode See PrintStatsProcess for details.
Standard_Boolean	RecognizeTransient (const Handle< Standard_Transient > &theObj)
	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.
IFSelect_ReturnStatus	TransferWriteTransient (const Handle< Interface_InterfaceModel > &theModel, const Handle< Standard_Transient > &theObj, const Message_ProgressRange &theProgress=Message_ProgressRange())
	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.
Standard_Boolean	RecognizeShape (const TopoDS_Shape &theShape)
	Tells if a Shape is valid for a transfer to a model Asks the Controller (RecognizeWriteShape)
IFSelect_ReturnStatus	TransferWriteShape (const Handle< Interface_InterfaceModel > &theModel, const TopoDS_Shape &theShape, const Message_ProgressRange &theProgress=Message_ProgressRange())
	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.
Interface_CheckIterator	CheckList () const
	Returns the check-list of last transfer (write), i.e. the check-list currently recorded in the FinderProcess.
Interface_CheckIterator	ResultCheckList (const Handle< Interface_InterfaceModel > &theModel) 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.
Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.
	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.
Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.
virtual	~Standard_Transient ()
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.
Standard_Boolean	IsKind (const opencascade::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.
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.
Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.
Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.
virtual void	Delete () const
	Memory deallocator for transient classes.

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.
Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.
static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

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::XSControl_TransferWriter ( )

inline

Creates a TransferWriter, empty, ready to run with an empty FinderProcess (but no controller, etc)

Member Function Documentation

CheckList()

Interface_CheckIterator XSControl_TransferWriter::CheckList

(

)

const

Returns the check-list of last transfer (write), i.e. the check-list currently recorded in the FinderProcess.

Clear()

void XSControl_TransferWriter::Clear

(

const Standard_Integer

theMode

)

Clears recorded data according a mode 0 clears FinderProcess (results, checks) -1 create a new FinderProcess.

Controller()

const Handle< XSControl_Controller > & XSControl_TransferWriter::Controller ( ) const

inline

Returns the currently used Controller.

FinderProcess()

const Handle< Transfer_FinderProcess > & XSControl_TransferWriter::FinderProcess ( ) const

inline

Returns the FinderProcess itself.

PrintStats()

void XSControl_TransferWriter::PrintStats	(	const Standard_Integer	theWhat,
		const Standard_Integer	theMode = 0
	)		const

Prints statistics on current Trace File, according what,mode See PrintStatsProcess for details.

RecognizeShape()

Standard_Boolean XSControl_TransferWriter::RecognizeShape

(

const TopoDS_Shape &

theShape

)

Tells if a Shape is valid for a transfer to a model Asks the Controller (RecognizeWriteShape)

RecognizeTransient()

Standard_Boolean XSControl_TransferWriter::RecognizeTransient

(

const Handle< Standard_Transient > &

theObj

)

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.

ResultCheckList()

Interface_CheckIterator XSControl_TransferWriter::ResultCheckList

(

const Handle< Interface_InterfaceModel > &

theModel

)

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.

SetController()

void XSControl_TransferWriter::SetController ( const Handle< XSControl_Controller > &  theCtl )

inline

Sets a new Controller, also sets a new FinderProcess.

SetFinderProcess()

void XSControl_TransferWriter::SetFinderProcess ( const Handle< Transfer_FinderProcess > &  theFP )

inline

Sets a new FinderProcess and forgets the former one.

SetTransferMode()

void XSControl_TransferWriter::SetTransferMode ( const Standard_Integer  theMode )

inline

Changes the Transfer Mode.

TransferMode()

Standard_Integer XSControl_TransferWriter::TransferMode ( ) const

inline

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)

TransferWriteShape()

IFSelect_ReturnStatus XSControl_TransferWriter::TransferWriteShape	(	const Handle< Interface_InterfaceModel > &	theModel,
		const TopoDS_Shape &	theShape,
		const Message_ProgressRange &	theProgress = Message_ProgressRange()
	)

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.

TransferWriteTransient()

IFSelect_ReturnStatus XSControl_TransferWriter::TransferWriteTransient	(	const Handle< Interface_InterfaceModel > &	theModel,
		const Handle< Standard_Transient > &	theObj,
		const Message_ProgressRange &	theProgress = Message_ProgressRange()
	)

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:

• XSControl_TransferWriter.hxx