OCC Main Page | DataExchange | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

DataExchange
TKXSBase
IFSelect


IFSelect_SessionDumper Class Reference

A SessionDumper is called by SessionFile. It takes into
account a set of classes (such as Selections, Dispatches ...).
SessionFile writes the Type (as defined by cdl) of each Item
and its general Parameters. It manages the names of the Items.

A SessionDumper must be able to Write the Parameters which are
own of each Item it takes into account, given its Class, then
to Recognize the Type and Read its Own Parameters to create
an Item of this Type with these own Parameters.

Then, there must be defined one sub-type of SessionDumper per
consistent set of classes (e.g. a package).

By Own Parameters, understand Parameters given at Creation Time
if there are, or specific of a given class, apart from those
defined at superclass levels (e.g. Final Selection for a
Dispatch, Input Selection for a SelectExtract or SelectDeduct,
Direct Status for a SelectExtract, etc...).

The Parameters are those stored in a WorkSession, they can be
of Types : IntParam, HAsciiString (for TextParam), Selection,
Dispatch.

SessionDumpers are organized in a Library which is used by
SessionFile. They are put at Creation Time in this Library.
.

#include <IFSelect_SessionDumper.hxx>

Inheritance diagram for IFSelect_SessionDumper:

Inheritance graph
[legend]

Public Member Functions

Standard_EXPORT Handle_IFSelect_SessionDumper Next () const
 Returns the Next SesionDumper in the Library. Returns a Null
Handle at the End.
.
virtual Standard_EXPORT Standard_Boolean WriteOwn (IFSelect_SessionFile &file, const Handle(Standard_Transient)&item) const =0
 Writes the Own Parameters of a given Item, if it forecast to
manage its Type.
Returns True if it has recognized the Type of the Item (in
this case, it is assumed to have written the Own Parameters if
there are some), False else : in that case, SessionFile will
try another SessionDumper in the Library.
WriteOwn can use these methods from SessionFile : SendVoid,
SendItem, SendText, and if necessary, WorkSession.
.
virtual Standard_EXPORT Standard_Boolean ReadOwn (IFSelect_SessionFile &file, const TCollection_AsciiString &type, Handle(Standard_Transient)&item) const =0
 Recognizes a Type (given as <type>) then Creates an Item of
this Type with the Own Parameter, as required.
Returns True if it has recognized the Type (in this case, it
is assumed to have created the Item, returned as <item>),
False else : in that case, SessionFile will try another
SessionDumper in the Library.
ReadOwn can use these methods from SessionFile to access Own
Parameters : NbOwnParams, IsVoid, IsText, TextValue, ItemValue
.
Standard_EXPORT const Handle (Standard_Type)&DynamicType() const

Static Public Member Functions

static Standard_EXPORT Handle_IFSelect_SessionDumper First ()
 Returns the First item of the Library of Dumper. The Next ones
are then obtained by Next on the returned items
.

Protected Member Functions

Standard_EXPORT IFSelect_SessionDumper ()
 The Initialization puts a just created SessionDumper in the
Library of SessionDumper. Then, it suffices to create once
a SessionDumper to fill the Library with it
.

Private Attributes

Handle_IFSelect_SessionDumper thenext

Constructor & Destructor Documentation

Standard_EXPORT IFSelect_SessionDumper::IFSelect_SessionDumper  )  [protected]
 


Member Function Documentation

static Standard_EXPORT Handle_IFSelect_SessionDumper IFSelect_SessionDumper::First  )  [static]
 

Standard_EXPORT const IFSelect_SessionDumper::Handle Standard_Type   )  const
 

Reimplemented in IFSelect_BasicDumper, and IGESSelect_Dumper.

Standard_EXPORT Handle_IFSelect_SessionDumper IFSelect_SessionDumper::Next  )  const
 

virtual Standard_EXPORT Standard_Boolean IFSelect_SessionDumper::ReadOwn IFSelect_SessionFile file,
const TCollection_AsciiString &  type,
Handle(Standard_Transient)&  item
const [pure virtual]
 

Implemented in IFSelect_BasicDumper, and IGESSelect_Dumper.

virtual Standard_EXPORT Standard_Boolean IFSelect_SessionDumper::WriteOwn IFSelect_SessionFile file,
const Handle(Standard_Transient)&  item
const [pure virtual]
 

Implemented in IFSelect_BasicDumper, and IGESSelect_Dumper.


Field Documentation

Handle_IFSelect_SessionDumper IFSelect_SessionDumper::thenext [private]
 


The documentation for this class was generated from the following file:
Generated on Mon Aug 25 14:39:56 2008 for OpenCASCADE by  doxygen 1.4.1