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

DataExchange
TKXSBase
Interface


Interface_FileReaderTool Class Reference

Defines services which are required to load an InterfaceModel
from a File. Typically, it may firstly transform a system
file into a FileReaderData object, then work on it, not longer
considering file contents, to load an Interface Model.
It may also work on a FileReaderData already loaded.

FileReaderTool provides, on one hand, some general services
which are common to all read operations but can be redefined,
plus general actions to be performed specifically for each
Norm, as deferred methods to define.

In particular, FileReaderTool defines the Interface's Unknown
and Error entities
.

#include <Interface_FileReaderTool.hxx>

Inheritance diagram for Interface_FileReaderTool:

Inheritance graph
[legend]

Public Member Functions

void * operator new (size_t, void *anAddress)
void * operator new (size_t size)
void operator delete (void *anAddress)
Standard_EXPORT void SetData (const Handle(Interface_FileReaderData)&reader, const Handle(Interface_Protocol)&protocol)
 Sets Data to a FileReaderData. Works with a Protocol
.
Standard_EXPORT Handle_Interface_Protocol Protocol () const
 Returns the Protocol given at creation time
.
Standard_EXPORT Handle_Interface_FileReaderData Data () const
 Returns the FileReaderData which is used to work
.
Standard_EXPORT void SetModel (const Handle(Interface_InterfaceModel)&amodel)
 Stores a Model. Used when the Model has been loaded
.
Standard_EXPORT Handle_Interface_InterfaceModel Model () const
 Returns the stored Model
.
Standard_EXPORT void SetMessenger (const Handle(Message_Messenger)&messenger)
 Sets Messenger used for outputting messages
.
Standard_EXPORT Handle_Message_Messenger Messenger () const
 Returns Messenger used for outputting messages.
The returned object is guaranteed to be non-null;
default is Message::Messenger().
.
Standard_EXPORT void SetTraceLevel (const Standard_Integer tracelev)
 Sets trace level used for outputting messages
- 0: no trace at all
- 1: errors
- 2: errors and warnings
- 3: all messages
Default is 1 : Errors traced
.
Standard_EXPORT Standard_Integer TraceLevel () const
 Returns trace level used for outputting messages.
.
Standard_EXPORT void SetErrorHandle (const Standard_Boolean err)
 Allows controlling whether exception raisings are handled
If err is False, they are not (hence, dbx can take control)
If err is True, they are, and they are traced
(by putting on messenger Entity's Number and file record num)
Default given at Model's creation time is True
.
Standard_EXPORT Standard_Boolean ErrorHandle () const
 Returns ErrorHandle flag
.
Standard_EXPORT void SetEntities ()
 Fills records with empty entities; once done, each entity can
ask the FileReaderTool for any entity referenced through an
identifier. Calls Recognize which is specific to each specific
type of FileReaderTool
.
virtual Standard_EXPORT Standard_Boolean Recognize (const Standard_Integer num, Handle(Interface_Check)&ach, Handle(Standard_Transient)&ent)=0
 Recognizes a record, given its number. Specific to each
Interface; called by SetEntities. It can call the basic method
RecognizeByLib.
Returns False if recognition has failed, True else.
<ach> has not to be filled if simply Recognition has failed :
it must record true error messages : RecognizeByLib can
generate error messages if NewRead is called

Note that it works thru a Recognizer (method Evaluate) which
has to be memorized before starting
.
Standard_EXPORT Standard_Boolean RecognizeByLib (const Standard_Integer num, Interface_GeneralLib &glib, Interface_ReaderLib &rlib, Handle(Interface_Check)&ach, Handle(Standard_Transient)&ent) const
 Recognizes a record with the help of Libraries. Can be used
to implement the method Recognize.
<rlib> is used to find Protocol and CaseNumber to apply
<glib> performs the creation (by service NewVoid, or NewRead
if NewVoid gave no result)
<ach> is a check, which is transmitted to NewRead if it is
called, gives a result but which is false
<ent> is the result
Returns False if recognition has failed, True else
.
Standard_EXPORT Handle_Standard_Transient UnknownEntity () const
 Provides an unknown entity, specific to the Interface
called by SetEntities when Recognize has failed (Unknown alone)
or by LoadModel when an Entity has caused a Fail on reading
(to keep at least its literal description)
Uses Protocol to do it
.
Standard_EXPORT Handle_Interface_InterfaceModel NewModel () const
 Creates an empty Model of the norm. Uses Protocol to do it
.
Standard_EXPORT void LoadModel (const Handle(Interface_InterfaceModel)&amodel)
 Reads and fills Entities from the FileReaderData set by
SetData to an InterfaceModel.
It enchains required operations, the specific ones correspond
to deferred methods (below) to be defined for each Norm.
It manages also error recovery and trace.
Remark : it calls SetModel.
It Can raise any error which can occur during a load
operation, unless Error Handling is set.
This method can also be redefined if judged necessary.
.
Standard_EXPORT Handle_Standard_Transient LoadedEntity (const Standard_Integer num)
 Reads, Fills and Returns one Entity read from a Record of the
FileReaderData. This Method manages also case of Fail or
Warning, by producing a ReportEntyty plus , for a Fail, a
literal Content (as an UnknownEntity). Performs also Trace
.
virtual Standard_EXPORT void BeginRead (const Handle(Interface_InterfaceModel)&amodel)=0
 Fills model's header; each Interface defines for its Model its
own file header; this method fills it from FileReaderTool.+
It is called by AnalyseFile from InterfaceModel
.
virtual Standard_EXPORT Standard_Boolean AnalyseRecord (const Standard_Integer num, const Handle(Standard_Transient)&anent, Handle(Interface_Check)&acheck)=0
 Fills an Entity, given record no; specific to each Interface,
called by AnalyseFile from InterfaceModel (which manages its
calling arguments)
To work, each Interface can define a method in its proper
Transient class, like this (given as an example) :
AnalyseRecord (me : mutable; FR : in out FileReaderTool;
num : Integer; acheck : in out Check)
returns Boolean;
and call it from AnalyseRecord

Returned Value : True if the entity could be loaded, False
else (in case of syntactic fail)
.
virtual Standard_EXPORT void Destroy ()
virtual Standard_EXPORT ~Interface_FileReaderTool ()
virtual Standard_EXPORT void EndRead (const Handle(Interface_InterfaceModel)&amodel)
 Ends file reading after reading all the entities
default is doing nothing; redefinable as necessary
.

Protected Member Functions

Standard_EXPORT Interface_FileReaderTool ()
 Constructor; sets default fields
.

Private Attributes

Handle_Interface_Protocol theproto
Handle_Interface_FileReaderData thereader
Handle_Interface_InterfaceModel themodel
Handle_Message_Messenger themessenger
Standard_Integer thetrace
Standard_Boolean theerrhand
Standard_Integer thenbrep0
Standard_Integer thenbreps
Handle_TColStd_HArray1OfTransient thereports

Constructor & Destructor Documentation

virtual Standard_EXPORT Interface_FileReaderTool::~Interface_FileReaderTool  )  [inline, virtual]
 

Standard_EXPORT Interface_FileReaderTool::Interface_FileReaderTool  )  [protected]
 


Member Function Documentation

virtual Standard_EXPORT Standard_Boolean Interface_FileReaderTool::AnalyseRecord const Standard_Integer  num,
const Handle(Standard_Transient)&  anent,
Handle(Interface_Check)&  acheck
[pure virtual]
 

Implemented in IGESData_IGESReaderTool, and StepData_StepReaderTool.

virtual Standard_EXPORT void Interface_FileReaderTool::BeginRead const Handle(Interface_InterfaceModel)&  amodel  )  [pure virtual]
 

Implemented in IGESData_IGESReaderTool, and StepData_StepReaderTool.

Standard_EXPORT Handle_Interface_FileReaderData Interface_FileReaderTool::Data  )  const
 

virtual Standard_EXPORT void Interface_FileReaderTool::Destroy  )  [virtual]
 

virtual Standard_EXPORT void Interface_FileReaderTool::EndRead const Handle(Interface_InterfaceModel)&  amodel  )  [virtual]
 

Reimplemented in IGESData_IGESReaderTool, and StepData_StepReaderTool.

Standard_EXPORT Standard_Boolean Interface_FileReaderTool::ErrorHandle  )  const
 

Standard_EXPORT Handle_Standard_Transient Interface_FileReaderTool::LoadedEntity const Standard_Integer  num  ) 
 

Standard_EXPORT void Interface_FileReaderTool::LoadModel const Handle(Interface_InterfaceModel)&  amodel  ) 
 

Standard_EXPORT Handle_Message_Messenger Interface_FileReaderTool::Messenger  )  const
 

Standard_EXPORT Handle_Interface_InterfaceModel Interface_FileReaderTool::Model  )  const
 

Standard_EXPORT Handle_Interface_InterfaceModel Interface_FileReaderTool::NewModel  )  const
 

void Interface_FileReaderTool::operator delete void *  anAddress  )  [inline]
 

Reimplemented in IGESData_IGESReaderTool, and StepData_StepReaderTool.

void* Interface_FileReaderTool::operator new size_t  size  )  [inline]
 

Reimplemented in IGESData_IGESReaderTool, and StepData_StepReaderTool.

void* Interface_FileReaderTool::operator new size_t  ,
void *  anAddress
[inline]
 

Reimplemented in IGESData_IGESReaderTool, and StepData_StepReaderTool.

Standard_EXPORT Handle_Interface_Protocol Interface_FileReaderTool::Protocol  )  const
 

virtual Standard_EXPORT Standard_Boolean Interface_FileReaderTool::Recognize const Standard_Integer  num,
Handle(Interface_Check)&  ach,
Handle(Standard_Transient)&  ent
[pure virtual]
 

Implemented in IGESData_IGESReaderTool, and StepData_StepReaderTool.

Standard_EXPORT Standard_Boolean Interface_FileReaderTool::RecognizeByLib const Standard_Integer  num,
Interface_GeneralLib glib,
Interface_ReaderLib rlib,
Handle(Interface_Check)&  ach,
Handle(Standard_Transient)&  ent
const
 

Standard_EXPORT void Interface_FileReaderTool::SetData const Handle(Interface_FileReaderData)&  reader,
const Handle(Interface_Protocol)&  protocol
 

Standard_EXPORT void Interface_FileReaderTool::SetEntities  ) 
 

Standard_EXPORT void Interface_FileReaderTool::SetErrorHandle const Standard_Boolean  err  ) 
 

Standard_EXPORT void Interface_FileReaderTool::SetMessenger const Handle(Message_Messenger)&  messenger  ) 
 

Standard_EXPORT void Interface_FileReaderTool::SetModel const Handle(Interface_InterfaceModel)&  amodel  ) 
 

Standard_EXPORT void Interface_FileReaderTool::SetTraceLevel const Standard_Integer  tracelev  ) 
 

Standard_EXPORT Standard_Integer Interface_FileReaderTool::TraceLevel  )  const
 

Standard_EXPORT Handle_Standard_Transient Interface_FileReaderTool::UnknownEntity  )  const
 


Field Documentation

Standard_Boolean Interface_FileReaderTool::theerrhand [private]
 

Handle_Message_Messenger Interface_FileReaderTool::themessenger [private]
 

Handle_Interface_InterfaceModel Interface_FileReaderTool::themodel [private]
 

Standard_Integer Interface_FileReaderTool::thenbrep0 [private]
 

Standard_Integer Interface_FileReaderTool::thenbreps [private]
 

Handle_Interface_Protocol Interface_FileReaderTool::theproto [private]
 

Handle_Interface_FileReaderData Interface_FileReaderTool::thereader [private]
 

Handle_TColStd_HArray1OfTransient Interface_FileReaderTool::thereports [private]
 

Standard_Integer Interface_FileReaderTool::thetrace [private]
 


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