Open CASCADE Technology  6.5.4
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Protected Member Functions
Transfer_Binder Class Reference

A Binder is an auxiliary object to Map the Result of the
Transfer of a given Object : it records the Result of the
Unitary Transfer (Resulting Object), status of progress and
error (if any) of the Process

The class Binder itself makes no definition for the Result :
it is defined by sub-classes : it can be either Simple (and
has to be typed : see generic class SimpleBinder) or Multiple
(see class MultipleBinder).

In principle, for a Transfer in progress, Result cannot be
accessed : this would cause an exception raising.
This is controlled by the value if StatusResult : if it is
"Used", the Result cannot be changed. This status is normally
controlled by TransferProcess but can be directly (see method
SetAlreadyUsed)

Checks can be completed by a record of cases, as string which
can be used as codes, but not to be printed

In addition to the Result, a Binder can bring a list of
Attributes, which are additional data, each of them has a name

#include <Transfer_Binder.hxx>

Inheritance diagram for Transfer_Binder:
Inheritance graph
[legend]

Public Member Functions

void Merge (const Handle< Transfer_Binder > &other)
 Merges basic data (Check, ExecStatus) from another Binder but
keeps its result. Used when a binder is replaced by another
one, this allows to keep messages

virtual Standard_Boolean IsMultiple () const
 Returns True if a Binder has several results, either by itself
or because it has next results
Can be defined by sub-classes.

virtual Handle_Standard_Type ResultType () const =0
 Returns the Type which characterizes the Result (if known)

virtual Standard_CString ResultTypeName () const =0
 Returns the Name of the Type which characterizes the Result
Can be returned even if ResultType itself is unknown

void AddResult (const Handle< Transfer_Binder > &next)
 Adds a next result (at the end of the list)
Remark : this information is not processed by Merge

Handle_Transfer_Binder NextResult () const
 Returns the next result, Null if none

Standard_Boolean HasResult () const
 Returns True if a Result is available (StatusResult = Defined)
A Unique Result will be gotten by Result (which must be
defined in each sub-class according to result type)
For a Multiple Result, see class MultipleBinder
For other case, specific access has to be forecast

void SetAlreadyUsed ()
 Declares that result is now used by another one, it means that
it cannot be modified (by Rebind)

Transfer_StatusResult Status () const
 Returns status, which can be Initial (not yet done), Made (a
result is recorded, not yet shared), Used (it is shared and
cannot be modified)

Transfer_StatusExec StatusExec () const
 Returns execution status

void SetStatusExec (const Transfer_StatusExec stat)
 Modifies execution status; called by TransferProcess only
(for StatusError, rather use SetError, below)

void AddFail (const Standard_CString mess, const Standard_CString orig="")
 Used to declare an individual transfer as beeing erroneous
(Status is set to Void, StatusExec is set to Error, <errmess>
is added to Check's list of Fails)
It is possible to record several messages of error

It has same effect for TransferProcess as raising an exception
during the operation of Transfer, except the Transfer tries to
continue (as if ErrorHandle had been set)

void AddWarning (const Standard_CString mess, const Standard_CString orig="")
 Used to attach a Warning Message to an individual Transfer
It has no effect on the Status

const Handle_Interface_Check Check () const
 Returns Check which stores Fail messages
Note that no Entity is associated in this Check

Handle_Interface_Check CCheck ()
 Returns Check which stores Fail messages, in order to modify
it (adding messages, or replacing it)

Protected Member Functions

 Transfer_Binder ()
 Sets fields at initial values

void SetResultPresent ()
 Used to declare that a result is recorded for an individual
transfer (works by setting StatusResult to Defined)

This Method is to be called once a Result is really recorded
(see sub-classes of Binder, especially SimpleBinder) : it is
senseless if called isolately


Constructor & Destructor Documentation


Member Function Documentation

Handle_Interface_Check Transfer_Binder::CCheck ( )
const Handle_Interface_Check Transfer_Binder::Check ( ) const
virtual Standard_Boolean Transfer_Binder::IsMultiple ( ) const [virtual]
Handle_Transfer_Binder Transfer_Binder::NextResult ( ) const
virtual Handle_Standard_Type Transfer_Binder::ResultType ( ) const [pure virtual]
virtual Standard_CString Transfer_Binder::ResultTypeName ( ) const [pure virtual]

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