Open CASCADE Technology  6.9.0
Public Member Functions

Interface_ReaderModule Class Referenceabstract

Defines unitary operations required to read an Entity from a File (see FileReaderData, FileReaderTool), under control of a FileReaderTool. The initial creation is performed by a GeneralModule (set in GeneralLib). Then, which remains is Loading data from the FileReaderData to the Entity. More...

#include <Interface_ReaderModule.hxx>

Inheritance diagram for Interface_ReaderModule:
Inheritance graph
[legend]

Public Member Functions

virtual Standard_Integer CaseNum (const Handle< Interface_FileReaderData > &data, const Standard_Integer num) const =0
 Translates the type of record <num> in <data> to a positive Case Number. If Recognition fails, must return 0. More...
 
virtual void Read (const Standard_Integer casenum, const Handle< Interface_FileReaderData > &data, const Standard_Integer num, Handle< Interface_Check > &ach, const Handle< Standard_Transient > &ent) const =0
 Performs the effective loading from <data>, record <num>, to the Entity <ent> formerly created In case of Error or Warning, fills <ach> with messages Remark that the Case Number comes from translating a record. More...
 
virtual Standard_Boolean NewRead (const Standard_Integer casenum, const Handle< Interface_FileReaderData > &data, const Standard_Integer num, Handle< Interface_Check > &ach, Handle< Standard_Transient > &ent) const
 Specific operator (create+read) defaulted to do nothing. It can be redefined when it is not possible to work in two steps (NewVoid then Read). This occurs when no default constructor is defined : hence the result <ent> must be created with an effective definition from the reader. Remark : if NewRead is defined, Copy has nothing to do. More...
 
- 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

Defines unitary operations required to read an Entity from a File (see FileReaderData, FileReaderTool), under control of a FileReaderTool. The initial creation is performed by a GeneralModule (set in GeneralLib). Then, which remains is Loading data from the FileReaderData to the Entity.

To work, a GeneralModule has formerly recognized the Type read from FileReaderData as a positive Case Number, then the ReaderModule reads it according to this Case Number

Member Function Documentation

virtual Standard_Integer Interface_ReaderModule::CaseNum ( const Handle< Interface_FileReaderData > &  data,
const Standard_Integer  num 
) const
pure virtual

Translates the type of record <num> in <data> to a positive Case Number. If Recognition fails, must return 0.

Implemented in IGESData_ReadWriteModule, and StepData_ReadWriteModule.

virtual Standard_Boolean Interface_ReaderModule::NewRead ( const Standard_Integer  casenum,
const Handle< Interface_FileReaderData > &  data,
const Standard_Integer  num,
Handle< Interface_Check > &  ach,
Handle< Standard_Transient > &  ent 
) const
virtual

Specific operator (create+read) defaulted to do nothing. It can be redefined when it is not possible to work in two steps (NewVoid then Read). This occurs when no default constructor is defined : hence the result <ent> must be created with an effective definition from the reader. Remark : if NewRead is defined, Copy has nothing to do.

Returns True if it has produced something, false else. If nothing was produced, <ach> should be filled : it will be treated as "Unrecognized case" by reader tool.

virtual void Interface_ReaderModule::Read ( const Standard_Integer  casenum,
const Handle< Interface_FileReaderData > &  data,
const Standard_Integer  num,
Handle< Interface_Check > &  ach,
const Handle< Standard_Transient > &  ent 
) const
pure virtual

Performs the effective loading from <data>, record <num>, to the Entity <ent> formerly created In case of Error or Warning, fills <ach> with messages Remark that the Case Number comes from translating a record.

Implemented in StepData_ReadWriteModule, and IGESData_ReadWriteModule.


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