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

This WorkSession completes the basic one, by adding :
More...

#include <XSControl_WorkSession.hxx>

Inheritance diagram for XSControl_WorkSession:
Inheritance graph
[legend]

Public Member Functions

 XSControl_WorkSession ()
virtual void ClearData (const Standard_Integer mode)
 In addition to basic ClearData, clears Transfer and Management
for interactive use, for mode = 0,1,2 and over 4
Plus : mode = 5 to clear Transfers (both ways) only
mode = 6 to clear enforced results
mode = 7 to clear transfers, results

Standard_Boolean SelectNorm (const Standard_CString normname, const Standard_CString profile="")
 Selects a Norm defined by its name.
A Norm is described and handled by a Controller
Returns True if done, False if <normname> is unknown

A Profile may be set too. If no Profile is provided, the
current Profile for this Norm is taken
If the asked Profile is not defined for this Norm, it remains
in current Profile, returned value is True

Standard_Boolean SelectProfile (const Standard_CString profile)
 Sets a Profile as current for the current Norm
Returns True if done, False if <profile> is unknown for this norm

For more infos on Profile, query the Profile of the Controller

void SetController (const Handle< XSControl_Controller > &ctl)
 Selects a Norm defined by its Controller itself

virtual void AdaptNorm ()
 This method is called once a new norm has been successfully
selected. It can be redefined, default does nothing

Standard_CString SelectedNorm (const Standard_Boolean rsc=Standard_False) const
 Returns the name of the last Selected Norm. If none is
defined, returns an empty string
By default, returns the complete name of the norm
If <rsc> is True, returns the short name used for resource

Handle_XSControl_Controller NormAdaptor () const
 Returns the norm controller itself

Handle_Dico_DictionaryOfTransient Context () const
 Returns the current Context List, Null if not defined
The Context is given to the TransientProcess for TransferRead

void SetAllContext (const Handle< Dico_DictionaryOfTransient > &context)
 Sets the current Context List, as a whole
Sets it to the TransferReader

void ClearContext ()
 Clears the whole current Context (nullifies it)

Standard_Boolean PrintTransferStatus (const Standard_Integer num, const Standard_Boolean wri, const Handle< Message_Messenger > &S) const
 Prints the transfer status of a transferred item, as beeing
the Mapped n0 <num>, from MapWriter if <wri> is True, or
from MapReader if <wri> is False
Returns True when done, False else (i.e. num out of range)

void InitTransferReader (const Standard_Integer mode)
 Sets a Transfer Reader, by internal ways, according mode :
0 recreates it clear, 1 clears it (does not recreate)
2 aligns Roots of TransientProcess from final Results
3 aligns final Results from Roots of TransientProcess
4 begins a new transfer (by BeginTransfer)
5 recreates TransferReader then begins a new transfer

void SetTransferReader (const Handle< XSControl_TransferReader > &TR)
 Sets a Transfer Reader, which manages transfers on reading

Handle_XSControl_TransferReader TransferReader () const
 Returns the Transfer Reader, Null if not set

Handle_Transfer_TransientProcess MapReader () const
 Returns the TransientProcess(internal data for TransferReader)

Standard_Boolean SetMapReader (const Handle< Transfer_TransientProcess > &TP)
 Changes the Map Reader, i.e. considers that the new one
defines the relevant read results (forgets the former ones)
Returns True when done, False in case of bad definition, i.e.
if Model from TP differs from that of Session

Handle_Standard_Transient Result (const Handle< Standard_Transient > &ent, const Standard_Integer mode) const
 Returns the result attached to a starting entity
If <mode> = 0, returns Final Result
If <mode> = 1, considers Last Result
If <mode> = 2, considers Final, else if absent, Last
returns it as Transient, if result is not transient returns
the Binder
<mode> = 10,11,12 idem but returns the Binder itself
(if it is not, e.g. Shape, returns the Binder)
<mode> = 20, returns the ResultFromModel

Standard_Integer TransferReadOne (const Handle< Standard_Transient > &ents)
 Commands the transfer of, either one entity, or a list
I.E. calls the TransferReader after having analysed <ents>
It is cumulated from the last BeginTransfer
<ents> is processed by GiveList, hence :

Standard_Integer TransferReadRoots ()
 Commands the transfer of all the root entities of the model
i.e. calls TransferRoot from the TransferReader with the Graph
No cumulation with former calls to TransferReadOne

Handle_Interface_InterfaceModel NewModel ()
 produces and returns a new Model well conditionned
It is produced by the Norm Controller
It can be Null (if this function is not implemented)

Handle_XSControl_TransferWriter TransferWriter () const
 Returns the Transfer Reader, Null if not set

Handle_Transfer_FinderProcess MapWriter () const
 Returns the FinderProcess (internal data for TransferWriter)

Standard_Boolean SetMapWriter (const Handle< Transfer_FinderProcess > &FP)
 Changes the Map Reader, i.e. considers that the new one
defines the relevant read results (forgets the former ones)
Returns True when done, False if <FP> is Null

void SetModeWriteShape (const Standard_Integer mode)
 Sets a mode to transfer Shapes from CasCade to entities of the
current norm, which interprets it (see various Controllers)
This call form could be later replaced by a more general one

Standard_Integer ModeWriteShape () const
 Records the current Mode to Write Shapes

IFSelect_ReturnStatus TransferWriteShape (const TopoDS_Shape &shape, const Standard_Boolean compgraph=Standard_True)
 Transfers a Shape from CasCade to a model of current norm,
according to the last call to SetModeWriteShape
Returns status :Done if OK, Fail if error during transfer,
Error if transfer badly initialised

Interface_CheckIterator TransferWriteCheckList () const
 Returns the check-list of last transfer (write)
It is recorded in the FinderProcess, but it must be bound with
resulting entities (in the resulting file model) rather than
with original objects (in fact, their mappers)

Handle_XSControl_Vars Vars () const
void SetVars (const Handle< XSControl_Vars > &newvars)
void ClearBinders ()
 Clears binders

void Destroy ()
 ~XSControl_WorkSession ()

Detailed Description


Constructor & Destructor Documentation


Member Function Documentation

virtual void XSControl_WorkSession::AdaptNorm ( ) [virtual]

Reimplemented from IFSelect_WorkSession.

Handle_Dico_DictionaryOfTransient XSControl_WorkSession::Context ( ) const
Handle_Transfer_TransientProcess XSControl_WorkSession::MapReader ( ) const
Handle_Transfer_FinderProcess XSControl_WorkSession::MapWriter ( ) const
Handle_Interface_InterfaceModel XSControl_WorkSession::NewModel ( )
Handle_XSControl_Controller XSControl_WorkSession::NormAdaptor ( ) const
Handle_XSControl_TransferReader XSControl_WorkSession::TransferReader ( ) const
  • <ents> a Selection : its SelectionResult
  • <ents> a HSequenceOfTransient : this list
  • <ents> the Model : in this specific case, all the roots,
    with no cumulation of former transfers (TransferReadRoots)
Handle_XSControl_TransferWriter XSControl_WorkSession::TransferWriter ( ) const
Handle_XSControl_Vars XSControl_WorkSession::Vars ( ) const

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