Open CASCADE Technology  6.9.1
Public Member Functions
Transfer_TransientProcess Class Reference

Adds specific features to the generic definition : TransientProcess is intended to work from an InterfaceModel to a set of application objects. More...

#include <Transfer_TransientProcess.hxx>

Inheritance diagram for Transfer_TransientProcess:
Inheritance graph
[legend]

Public Member Functions

 Transfer_TransientProcess (const Standard_Integer nb=10000)
 Sets TransientProcess at initial state, with an initial size. More...
 
void SetModel (const Handle< Interface_InterfaceModel > &model)
 Sets an InterfaceModel, used by StartTrace, CheckList, queries on Integrity, to give informations significant for each norm. More...
 
Handle< Interface_InterfaceModelModel () const
 Returns the Model used for StartTrace. More...
 
void SetGraph (const Handle< Interface_HGraph > &HG)
 Sets a Graph : superseedes SetModel if already done. More...
 
Standard_Boolean HasGraph () const
 
Handle< Interface_HGraphHGraph () const
 
const Interface_GraphGraph () const
 
void SetContext (const Standard_CString name, const Handle< Standard_Transient > &ctx)
 Sets a Context : according to receiving appli, to be interpreted by the Actor. More...
 
Standard_Boolean GetContext (const Standard_CString name, const Handle< Standard_Type > &type, Handle< Standard_Transient > &ctx) const
 Returns the Context attached to a name, if set and if it is Kind of the type, else a Null Handle Returns True if OK, False if no Context. More...
 
Handle< Dico_DictionaryOfTransient > & Context ()
 Returns (modifiable) the whole definition of Context Rather for internal use (ex.: preparing and setting in once) More...
 
virtual void PrintTrace (const Handle< Standard_Transient > &start, const Handle< Message_Messenger > &S) const
 Specific printing to trace an entity : prints label and type (if model is set) More...
 
virtual Standard_Integer CheckNum (const Handle< Standard_Transient > &ent) const
 Specific number of a starting object for check-list : Number in model. More...
 
Interface_EntityIterator TypedSharings (const Handle< Standard_Transient > &start, const Handle< Standard_Type > &type) const
 Returns the list of sharings entities, AT ANY LEVEL, which are kind of a given type. Calls TypedSharings from Graph Returns an empty list if the Graph has not been aknowledged. More...
 
Standard_Boolean IsDataLoaded (const Handle< Standard_Transient > &ent) const
 Tells if an entity is well loaded from file (even if its data fail on checking, they are present). Mostly often, answers True. Else, there was a syntactic error in the file. A non-loaded entity MAY NOT BE transferred, unless its Report (in the model) is interpreted. More...
 
Standard_Boolean IsDataFail (const Handle< Standard_Transient > &ent) const
 Tells if an entity fails on data checking (load time, syntactic, or semantic check). Normally, should answer False. It is not prudent to try transferring an entity which fails on data checking. More...
 
void PrintStats (const Standard_Integer mode, const Handle< Message_Messenger > &S) const
 Prints statistics on a given output, according mode. More...
 
Handle< TColStd_HSequenceOfTransientRootsForTransfer ()
 
- Public Member Functions inherited from Transfer_ProcessForTransient
 Transfer_ProcessForTransient (const Standard_Integer nb=10000)
 
 Transfer_ProcessForTransient (const Handle< Message_Messenger > &printer, const Standard_Integer nb=10000)
 
void Clear ()
 
void Clean ()
 
void Resize (const Standard_Integer nb)
 
void SetActor (const Handle< Transfer_ActorOfProcessForTransient > &actor)
 
Handle< Transfer_ActorOfProcessForTransientActor () const
 
Handle< Transfer_BinderFind (const Handle< Standard_Transient > &start) const
 
Standard_Boolean IsBound (const Handle< Standard_Transient > &start) const
 
Standard_Boolean IsAlreadyUsed (const Handle< Standard_Transient > &start) const
 
void Bind (const Handle< Standard_Transient > &start, const Handle< Transfer_Binder > &binder)
 
void Rebind (const Handle< Standard_Transient > &start, const Handle< Transfer_Binder > &binder)
 
Standard_Boolean Unbind (const Handle< Standard_Transient > &start)
 
Handle< Transfer_BinderFindElseBind (const Handle< Standard_Transient > &start)
 
void SetMessenger (const Handle< Message_Messenger > &messenger)
 
Handle< Message_MessengerMessenger () const
 
void SetTraceLevel (const Standard_Integer tracelev)
 
Standard_Integer TraceLevel () const
 
void SendFail (const Handle< Standard_Transient > &start, const Message_Msg &amsg)
 
void SendWarning (const Handle< Standard_Transient > &start, const Message_Msg &amsg)
 
void SendMsg (const Handle< Standard_Transient > &start, const Message_Msg &amsg)
 
void AddFail (const Handle< Standard_Transient > &start, const Standard_CString mess, const Standard_CString orig="")
 
void AddError (const Handle< Standard_Transient > &start, const Standard_CString mess, const Standard_CString orig="")
 
void AddFail (const Handle< Standard_Transient > &start, const Message_Msg &amsg)
 
void AddWarning (const Handle< Standard_Transient > &start, const Standard_CString mess, const Standard_CString orig="")
 
void AddWarning (const Handle< Standard_Transient > &start, const Message_Msg &amsg)
 
void Mend (const Handle< Standard_Transient > &start, const Standard_CString pref="")
 
Handle< Interface_CheckCheck (const Handle< Standard_Transient > &start) const
 
void BindTransient (const Handle< Standard_Transient > &start, const Handle< Standard_Transient > &res)
 
const Handle< Standard_Transient > & FindTransient (const Handle< Standard_Transient > &start) const
 
void BindMultiple (const Handle< Standard_Transient > &start)
 
void AddMultiple (const Handle< Standard_Transient > &start, const Handle< Standard_Transient > &res)
 
Standard_Boolean FindTypedTransient (const Handle< Standard_Transient > &start, const Handle< Standard_Type > &atype, Handle< Standard_Transient > &val) const
 
Standard_Boolean GetTypedTransient (const Handle< Transfer_Binder > &binder, const Handle< Standard_Type > &atype, Handle< Standard_Transient > &val) const
 
Standard_Integer NbMapped () const
 
const Handle< Standard_Transient > & Mapped (const Standard_Integer num) const
 
Standard_Integer MapIndex (const Handle< Standard_Transient > &start) const
 
Handle< Transfer_BinderMapItem (const Standard_Integer num) const
 
void SetRoot (const Handle< Standard_Transient > &start)
 
void SetRootManagement (const Standard_Boolean stat)
 
Standard_Integer NbRoots () const
 
const Handle< Standard_Transient > & Root (const Standard_Integer num) const
 
Handle< Transfer_BinderRootItem (const Standard_Integer num) const
 
Standard_Integer RootIndex (const Handle< Standard_Transient > &start) const
 
Standard_Integer NestingLevel () const
 
void ResetNestingLevel ()
 
Standard_Boolean Recognize (const Handle< Standard_Transient > &start) const
 
Handle< Transfer_BinderTransferring (const Handle< Standard_Transient > &start)
 
Standard_Boolean Transfer (const Handle< Standard_Transient > &start)
 
void SetErrorHandle (const Standard_Boolean err)
 
Standard_Boolean ErrorHandle () const
 
void StartTrace (const Handle< Transfer_Binder > &binder, const Handle< Standard_Transient > &start, const Standard_Integer level, const Standard_Integer mode) const
 
Standard_Boolean IsLooping (const Standard_Integer alevel) const
 
Transfer_IteratorOfProcessForTransient RootResult (const Standard_Boolean withstart=Standard_False) const
 
Transfer_IteratorOfProcessForTransient CompleteResult (const Standard_Boolean withstart=Standard_False) const
 
Transfer_IteratorOfProcessForTransient AbnormalResult () const
 
Interface_CheckIterator CheckList (const Standard_Boolean erronly) const
 
Transfer_IteratorOfProcessForTransient ResultOne (const Handle< Standard_Transient > &start, const Standard_Integer level, const Standard_Boolean withstart=Standard_False) const
 
Interface_CheckIterator CheckListOne (const Handle< Standard_Transient > &start, const Standard_Integer level, const Standard_Boolean erronly) const
 
Standard_Boolean IsCheckListEmpty (const Handle< Standard_Transient > &start, const Standard_Integer level, const Standard_Boolean erronly) const
 
void RemoveResult (const Handle< Standard_Transient > &start, const Standard_Integer level, const Standard_Boolean compute=Standard_True)
 
void SetProgress (const Handle< Message_ProgressIndicator > &theProgress)
 
Handle< Message_ProgressIndicatorGetProgress () const
 
- Public Member Functions inherited from MMgt_TShared
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual const Handle_Standard_Type & DynamicType () const
 Returns a type information object about this object. More...
 
Standard_Boolean IsInstance (const Handle_Standard_Type &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean IsKind (const 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. More...
 
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. More...
 
virtual Handle_Standard_Transient This () const
 Returns a Handle which references this object. Must never be called to objects created in stack. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 

Detailed Description

Adds specific features to the generic definition : TransientProcess is intended to work from an InterfaceModel to a set of application objects.

Hence, some informations about starting entities can be gotten from the model : for Trace, CheckList, Integrity Status

Constructor & Destructor Documentation

Transfer_TransientProcess::Transfer_TransientProcess ( const Standard_Integer  nb = 10000)

Sets TransientProcess at initial state, with an initial size.

Member Function Documentation

virtual Standard_Integer Transfer_TransientProcess::CheckNum ( const Handle< Standard_Transient > &  ent) const
virtual

Specific number of a starting object for check-list : Number in model.

Reimplemented from Transfer_ProcessForTransient.

Handle< Dico_DictionaryOfTransient >& Transfer_TransientProcess::Context ( )

Returns (modifiable) the whole definition of Context Rather for internal use (ex.: preparing and setting in once)

Standard_Boolean Transfer_TransientProcess::GetContext ( const Standard_CString  name,
const Handle< Standard_Type > &  type,
Handle< Standard_Transient > &  ctx 
) const

Returns the Context attached to a name, if set and if it is Kind of the type, else a Null Handle Returns True if OK, False if no Context.

const Interface_Graph& Transfer_TransientProcess::Graph ( ) const
Standard_Boolean Transfer_TransientProcess::HasGraph ( ) const
Handle< Interface_HGraph > Transfer_TransientProcess::HGraph ( ) const
Standard_Boolean Transfer_TransientProcess::IsDataFail ( const Handle< Standard_Transient > &  ent) const

Tells if an entity fails on data checking (load time, syntactic, or semantic check). Normally, should answer False. It is not prudent to try transferring an entity which fails on data checking.

Standard_Boolean Transfer_TransientProcess::IsDataLoaded ( const Handle< Standard_Transient > &  ent) const

Tells if an entity is well loaded from file (even if its data fail on checking, they are present). Mostly often, answers True. Else, there was a syntactic error in the file. A non-loaded entity MAY NOT BE transferred, unless its Report (in the model) is interpreted.

Handle< Interface_InterfaceModel > Transfer_TransientProcess::Model ( ) const

Returns the Model used for StartTrace.

void Transfer_TransientProcess::PrintStats ( const Standard_Integer  mode,
const Handle< Message_Messenger > &  S 
) const

Prints statistics on a given output, according mode.

virtual void Transfer_TransientProcess::PrintTrace ( const Handle< Standard_Transient > &  start,
const Handle< Message_Messenger > &  S 
) const
virtual

Specific printing to trace an entity : prints label and type (if model is set)

Reimplemented from Transfer_ProcessForTransient.

Handle< TColStd_HSequenceOfTransient > Transfer_TransientProcess::RootsForTransfer ( )
void Transfer_TransientProcess::SetContext ( const Standard_CString  name,
const Handle< Standard_Transient > &  ctx 
)

Sets a Context : according to receiving appli, to be interpreted by the Actor.

void Transfer_TransientProcess::SetGraph ( const Handle< Interface_HGraph > &  HG)

Sets a Graph : superseedes SetModel if already done.

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

Sets an InterfaceModel, used by StartTrace, CheckList, queries on Integrity, to give informations significant for each norm.

Interface_EntityIterator Transfer_TransientProcess::TypedSharings ( const Handle< Standard_Transient > &  start,
const Handle< Standard_Type > &  type 
) const

Returns the list of sharings entities, AT ANY LEVEL, which are kind of a given type. Calls TypedSharings from Graph Returns an empty list if the Graph has not been aknowledged.


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