// This file is generated by WOK (CPPExt). // Please do not edit this file; modify original file instead. // The copyright and license terms as defined for the original file apply to // this header file considered to be the "object code" form of the original source. #ifndef _XSControl_WorkSession_HeaderFile #define _XSControl_WorkSession_HeaderFile #ifndef _Standard_HeaderFile #include #endif #ifndef _Standard_DefineHandle_HeaderFile #include #endif #ifndef _Handle_XSControl_WorkSession_HeaderFile #include #endif #ifndef _Handle_XSControl_Controller_HeaderFile #include #endif #ifndef _Handle_XSControl_TransferReader_HeaderFile #include #endif #ifndef _Handle_XSControl_TransferWriter_HeaderFile #include #endif #ifndef _Handle_Dico_DictionaryOfTransient_HeaderFile #include #endif #ifndef _Standard_Integer_HeaderFile #include #endif #ifndef _Handle_XSControl_Vars_HeaderFile #include #endif #ifndef _IFSelect_WorkSession_HeaderFile #include #endif #ifndef _Standard_Boolean_HeaderFile #include #endif #ifndef _Standard_CString_HeaderFile #include #endif #ifndef _Handle_Message_Messenger_HeaderFile #include #endif #ifndef _Handle_Transfer_TransientProcess_HeaderFile #include #endif #ifndef _Handle_Standard_Transient_HeaderFile #include #endif #ifndef _Handle_Interface_InterfaceModel_HeaderFile #include #endif #ifndef _Handle_Transfer_FinderProcess_HeaderFile #include #endif #ifndef _IFSelect_ReturnStatus_HeaderFile #include #endif class XSControl_Controller; class XSControl_TransferReader; class XSControl_TransferWriter; class Dico_DictionaryOfTransient; class XSControl_Vars; class Message_Messenger; class Transfer_TransientProcess; class Standard_Transient; class Interface_InterfaceModel; class Transfer_FinderProcess; class TopoDS_Shape; class Interface_CheckIterator; //! This WorkSession completes the basic one, by adding :
//! - use of Controller, with norm selection...
//! - management of transfers (both ways) with auxiliary classes
//! TransferReader and TransferWriter
//! -> these transfers may work with a Context List : its items
//! are given by the user, according to the transfer to be
//! i.e. it is interpreted by the Actors
//! Each item is accessed by a Name
class XSControl_WorkSession : public IFSelect_WorkSession { public: Standard_EXPORT XSControl_WorkSession(); //! 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_EXPORT virtual void ClearData(const Standard_Integer mode) ; //! Selects a Norm defined by its name.
//! A Norm is described and handled by a Controller
//! Returns True if done, False if 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_EXPORT Standard_Boolean SelectNorm(const Standard_CString normname,const Standard_CString profile = "") ; //! Sets a Profile as current for the current Norm
//! Returns True if done, False if is unknown for this norm
//!
//! For more infos on Profile, query the Profile of the Controller
Standard_EXPORT Standard_Boolean SelectProfile(const Standard_CString profile) ; //! Selects a Norm defined by its Controller itself
Standard_EXPORT void SetController(const Handle(XSControl_Controller)& ctl) ; //! This method is called once a new norm has been successfully
//! selected. It can be redefined, default does nothing
Standard_EXPORT virtual void AdaptNorm() ; //! 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 is True, returns the short name used for resource
Standard_EXPORT Standard_CString SelectedNorm(const Standard_Boolean rsc = Standard_False) const; //! Returns the norm controller itself
Standard_EXPORT Handle_XSControl_Controller NormAdaptor() const; //! Returns the current Context List, Null if not defined
//! The Context is given to the TransientProcess for TransferRead
Standard_EXPORT Handle_Dico_DictionaryOfTransient Context() const; //! Sets the current Context List, as a whole
//! Sets it to the TransferReader
Standard_EXPORT void SetAllContext(const Handle(Dico_DictionaryOfTransient)& context) ; //! Clears the whole current Context (nullifies it)
Standard_EXPORT void ClearContext() ; //! Prints the transfer status of a transferred item, as beeing
//! the Mapped n0 , from MapWriter if is True, or
//! from MapReader if is False
//! Returns True when done, False else (i.e. num out of range)
Standard_EXPORT Standard_Boolean PrintTransferStatus(const Standard_Integer num,const Standard_Boolean wri,const Handle(Message_Messenger)& S) const; //! 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
Standard_EXPORT void InitTransferReader(const Standard_Integer mode) ; //! Sets a Transfer Reader, which manages transfers on reading
Standard_EXPORT void SetTransferReader(const Handle(XSControl_TransferReader)& TR) ; //! Returns the Transfer Reader, Null if not set
Standard_EXPORT Handle_XSControl_TransferReader TransferReader() const; //! Returns the TransientProcess(internal data for TransferReader)
Standard_EXPORT Handle_Transfer_TransientProcess MapReader() const; //! 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
Standard_EXPORT Standard_Boolean SetMapReader(const Handle(Transfer_TransientProcess)& TP) ; //! Returns the result attached to a starting entity
//! If = 0, returns Final Result
//! If = 1, considers Last Result
//! If = 2, considers Final, else if absent, Last
//! returns it as Transient, if result is not transient returns
//! the Binder
//! = 10,11,12 idem but returns the Binder itself
//! (if it is not, e.g. Shape, returns the Binder)
//! = 20, returns the ResultFromModel
Standard_EXPORT Handle_Standard_Transient Result(const Handle(Standard_Transient)& ent,const Standard_Integer mode) const; //! Commands the transfer of, either one entity, or a list
//! I.E. calls the TransferReader after having analysed
//! It is cumulated from the last BeginTransfer
//! is processed by GiveList, hence :
//! - a Selection : its SelectionResult
//! - a HSequenceOfTransient : this list
//! - the Model : in this specific case, all the roots,
//! with no cumulation of former transfers (TransferReadRoots)
Standard_EXPORT Standard_Integer TransferReadOne(const Handle(Standard_Transient)& ents) ; //! 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
Standard_EXPORT Standard_Integer TransferReadRoots() ; //! 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)
Standard_EXPORT Handle_Interface_InterfaceModel NewModel() ; //! Returns the Transfer Reader, Null if not set
Standard_EXPORT Handle_XSControl_TransferWriter TransferWriter() const; //! Returns the FinderProcess (internal data for TransferWriter)
Standard_EXPORT Handle_Transfer_FinderProcess MapWriter() const; //! 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 is Null
Standard_EXPORT Standard_Boolean SetMapWriter(const Handle(Transfer_FinderProcess)& FP) ; //! 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_EXPORT void SetModeWriteShape(const Standard_Integer mode) ; //! Records the current Mode to Write Shapes
Standard_EXPORT Standard_Integer ModeWriteShape() const; //! 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
Standard_EXPORT IFSelect_ReturnStatus TransferWriteShape(const TopoDS_Shape& shape,const Standard_Boolean compgraph = Standard_True) ; //! 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)
Standard_EXPORT Interface_CheckIterator TransferWriteCheckList() const; Standard_EXPORT Handle_XSControl_Vars Vars() const; Standard_EXPORT void SetVars(const Handle(XSControl_Vars)& newvars) ; //! Clears binders
Standard_EXPORT void ClearBinders() ; Standard_EXPORT void Destroy() ; ~XSControl_WorkSession() { Destroy(); } DEFINE_STANDARD_RTTI(XSControl_WorkSession) protected: private: Handle_XSControl_Controller theController; Handle_XSControl_TransferReader theTransferRead; Handle_XSControl_TransferWriter theTransferWrite; Handle_Dico_DictionaryOfTransient theContext; Standard_Integer theModeWriteShape; Handle_XSControl_Vars theVars; }; // other Inline functions and methods (like "C++: function call" methods) #endif