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

ResultFromModel is used to store a final result stored in a
TransientProcess, respectfully to its structuration in scopes
by using a set of ResultFromTransient
Hence, it can be regarded as a passive equivalent of the
stored data in the TransientProcess, while an Iterator gives
a flat view of it.

A ResultFromModel is intended to be attached to the transfer
of one entity (typically root entity but it is not mandatory)

It is then possible to :
More...

#include <Transfer_ResultFromModel.hxx>

Inheritance diagram for Transfer_ResultFromModel:
Inheritance graph
[legend]

Public Member Functions

 Transfer_ResultFromModel ()
 Creates a ResultFromModel, empty

void SetModel (const Handle< Interface_InterfaceModel > &model)
 Sets starting Model

void SetFileName (const Standard_CString filename)
 Sets starting File Name

Handle_Interface_InterfaceModel Model () const
 Returns starting Model (null if not set)

Standard_CString FileName () const
 Returns starting File Name (empty if not set)

Standard_Boolean Fill (const Handle< Transfer_TransientProcess > &TP, const Handle< Standard_Transient > &ent)
 Fills from a TransientProcess, with the result attached to
a starting entity. Considers its Model if it is set.
This action produces a structured set of ResultFromTransient,
considering scopes, starting by that of <ent>.
If <ent> has no recorded result, it remains empty
Returns True if a result is recorded, False else

void Strip (const Standard_Integer mode)
 Clears some data attached to binders used by TransientProcess,
which become useless once the transfer has been done,
by calling Strip on its ResultFromTransient

mode = 0 : minimum, clears data remaining from TransferProcess
mode = 10 : just keeps file name, label, check status ...,
and MainResult but only the result (Binder)
mode = 11 : also clears MainResult (status and names remain)

void FillBack (const Handle< Transfer_TransientProcess > &TP) const
 Fills back a TransientProcess from the structured set of
binders. Also sets the Model.

Standard_Boolean HasResult () const
 Returns True if a Result is recorded

Handle_Transfer_ResultFromTransient MainResult () const
 Returns the main recorded ResultFromTransient, or a null

void SetMainResult (const Handle< Transfer_ResultFromTransient > &amain)
 Sets a new value for the main recorded ResultFromTransient

Standard_CString MainLabel () const
 Returns the label in starting model attached to main entity
(updated by Fill or SetMainResult, if Model is known)

Standard_Integer MainNumber () const
 Returns the label in starting model attached to main entity

Handle_Transfer_ResultFromTransient ResultFromKey (const Handle< Standard_Transient > &start) const
 Searches for a key (starting entity) and returns its result
Returns a null handle if not found

Handle_TColStd_HSequenceOfTransient Results (const Standard_Integer level) const
 Internal method which returns the list of ResultFromTransient,
according level (2:complete; 1:sub-level 1; 0:main only)

Handle_TColStd_HSequenceOfTransient TransferredList (const Standard_Integer level=2) const
 Returns the list of recorded starting entities, ending by the
root. Entities with check but no transfer result are ignored
<level> = 2 (D), considers the complete list
<level> = 1 considers the main result plus immediate subs
<level> = 0 just the main result

Handle_TColStd_HSequenceOfTransient CheckedList (const Interface_CheckStatus check, const Standard_Boolean result) const
 Returns the list of starting entities to which a check status
is attached.
<check> = -2 , all entities whatever the check (see result)
<check> = -1 , entities with no fail (warning allowed)
<check> = 0 , entities with no check at all
<check> = 1 , entities with warning but no fail
<check> = 2 , entities with fail
<result> : if True, only entities with an attached result
Remark : result True and check=0 will give an empty list

Interface_CheckIterator CheckList (const Standard_Boolean erronly, const Standard_Integer level=2) const
 Returns the check-list of this set of results
<erronly> true : only fails are considered
<level> = 0 : considers only main binder
<level> = 1 : considers main binder plus immediate subs
<level> = 2 (D) : considers all checks

Interface_CheckStatus CheckStatus () const
 Returns the check status with corresponds to the content
of this ResultFromModel; considers all levels of transfer
(worst status). Returns CheckAny if not yet computed
Reads it from recorded status if already computed, else
recomputes one

Interface_CheckStatus ComputeCheckStatus (const Standard_Boolean enforce)
 Computes and records check status (see CheckStatus)
Does not computes it if already done and <enforce> False


Detailed Description


Constructor & Destructor Documentation


Member Function Documentation

Handle_TColStd_HSequenceOfTransient Transfer_ResultFromModel::CheckedList ( const Interface_CheckStatus  check,
const Standard_Boolean  result 
) const
Handle_Transfer_ResultFromTransient Transfer_ResultFromModel::MainResult ( ) const
Handle_Interface_InterfaceModel Transfer_ResultFromModel::Model ( ) const
Handle_Transfer_ResultFromTransient Transfer_ResultFromModel::ResultFromKey ( const Handle< Standard_Transient > &  start) const
Handle_TColStd_HSequenceOfTransient Transfer_ResultFromModel::Results ( const Standard_Integer  level) const
Handle_TColStd_HSequenceOfTransient Transfer_ResultFromModel::TransferredList ( const Standard_Integer  level = 2) const

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