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

DataExchange
TKXSBase
StepData


StepData_ReadWriteModule Class Reference

Defines basic File Access Module (Recognize, Read, Write)
That is : ReaderModule (Recognize & Read) + Write for
StepWriter (for a more centralized description)
Warning : A sub-class of ReadWriteModule, which belongs to a particular
Protocol, must use the same definition for Case Numbers (give
the same Value for a StepType defined as a String from a File
as the Protocol does for the corresponding Entity)
.

#include <StepData_ReadWriteModule.hxx>

Inheritance diagram for StepData_ReadWriteModule:

Inheritance graph
[legend]

Public Member Functions

Standard_EXPORT Standard_Integer CaseNum (const Handle(Interface_FileReaderData)&data, const Standard_Integer num) const
 Translate the Type of record <num> in <data> to a positive
Case Number, or 0 if failed.
Works with a StepReaderData, in which the Type of an Entity
is defined as a String : Reads the RecordType <num> then calls
CaseNum (this type)
Warning : The methods CaseStep, StepType and Recognize,
must be in phase (triplets CaseNum-StepType-Type of Object)
.
virtual Standard_EXPORT Standard_Integer CaseStep (const TCollection_AsciiString &atype) const =0
 Defines Case Numbers corresponding to the recognized Types
Called by CaseNum (data,num) above for a Simple Type Entity
Warning : CaseStep must give the same Value as Protocol does for the
Entity type which corresponds to this Type given as a String
.
virtual Standard_EXPORT Standard_Integer CaseStep (const TColStd_SequenceOfAsciiString &types) const
 Same a above but for a Complex Type Entity ("Plex")
The provided Default recognizes nothing
.
virtual Standard_EXPORT Standard_Boolean IsComplex (const Standard_Integer CN) const
 Returns True if the Case Number corresponds to a Complex Type
("Plex"). Remember that all possible combinations must be
aknowledged to be processed
Default is False for all cases. For a Protocol which defines
possible Plexes, this method must be redefined.
.
virtual Standard_EXPORT const
TCollection_AsciiString & 
StepType (const Standard_Integer CN) const =0
 Function specific to STEP, which delivers the StepType as it
is recorded in and read from a File compliant with STEP.
This method is symmetric to the method CaseStep.
StepType can be different from Dynamic Type's name, but
belongs to the same class of Object.
Returns an empty String if <cn> is zero.
Warning : For a Complex Type Entity, returns an Empty String
(Complex Type must be managed by users)
.
virtual Standard_EXPORT TCollection_AsciiString ShortType (const Standard_Integer CN) const
 Function specific to STEP. Some STEP Types have a short form
This method can be redefined to fill it
By default, returns an empty string, which is then interpreted
to take normal form from StepType
.
virtual Standard_EXPORT Standard_Boolean ComplexType (const Standard_Integer CN, TColStd_SequenceOfAsciiString &types) const
 Function specific to STEP, which delivers the list of types
which corresponds to a complex type. If <cn> is not for a
complex type, this method returns False. Else it returns True
and fills the list in alphabetic order.
The default returns False. To be redefined as required.
.
Standard_EXPORT void Read (const Standard_Integer CN, const Handle(Interface_FileReaderData)&data, const Standard_Integer num, Handle(Interface_Check)&ach, const Handle(Standard_Transient)&ent) const
 General Read Function, calls ReadStep
.
virtual Standard_EXPORT void ReadStep (const Standard_Integer CN, const Handle(StepData_StepReaderData)&data, const Standard_Integer num, Handle(Interface_Check)&ach, const Handle(Standard_Transient)&ent) const =0
 Specific Read Function. Works with StepReaderData
.
virtual Standard_EXPORT void WriteStep (const Standard_Integer CN, StepData_StepWriter &SW, const Handle(Standard_Transient)&ent) const =0
 Write Function, switched by CaseNum
.
Standard_EXPORT const Handle (Standard_Type)&DynamicType() const

Member Function Documentation

Standard_EXPORT Standard_Integer StepData_ReadWriteModule::CaseNum const Handle(Interface_FileReaderData)&  data,
const Standard_Integer  num
const [virtual]
 

Implements Interface_ReaderModule.

virtual Standard_EXPORT Standard_Integer StepData_ReadWriteModule::CaseStep const TColStd_SequenceOfAsciiString &  types  )  const [virtual]
 

Reimplemented in RWHeaderSection_ReadWriteModule, RWStepAP214_ReadWriteModule, and StepData_DescrReadWrite.

virtual Standard_EXPORT Standard_Integer StepData_ReadWriteModule::CaseStep const TCollection_AsciiString &  atype  )  const [pure virtual]
 

Implemented in RWHeaderSection_ReadWriteModule, RWStepAP214_ReadWriteModule, and StepData_DescrReadWrite.

virtual Standard_EXPORT Standard_Boolean StepData_ReadWriteModule::ComplexType const Standard_Integer  CN,
TColStd_SequenceOfAsciiString &  types
const [virtual]
 

Reimplemented in RWStepAP214_ReadWriteModule, and StepData_DescrReadWrite.

Standard_EXPORT const StepData_ReadWriteModule::Handle Standard_Type   )  const
 

Reimplemented from Interface_ReaderModule.

Reimplemented in RWHeaderSection_ReadWriteModule, RWStepAP214_ReadWriteModule, and StepData_DescrReadWrite.

virtual Standard_EXPORT Standard_Boolean StepData_ReadWriteModule::IsComplex const Standard_Integer  CN  )  const [virtual]
 

Reimplemented in RWHeaderSection_ReadWriteModule, RWStepAP214_ReadWriteModule, and StepData_DescrReadWrite.

Standard_EXPORT void StepData_ReadWriteModule::Read const Standard_Integer  CN,
const Handle(Interface_FileReaderData)&  data,
const Standard_Integer  num,
Handle(Interface_Check)&  ach,
const Handle(Standard_Transient)&  ent
const [virtual]
 

Implements Interface_ReaderModule.

virtual Standard_EXPORT void StepData_ReadWriteModule::ReadStep const Standard_Integer  CN,
const Handle(StepData_StepReaderData)&  data,
const Standard_Integer  num,
Handle(Interface_Check)&  ach,
const Handle(Standard_Transient)&  ent
const [pure virtual]
 

Implemented in RWHeaderSection_ReadWriteModule, RWStepAP214_ReadWriteModule, and StepData_DescrReadWrite.

virtual Standard_EXPORT TCollection_AsciiString StepData_ReadWriteModule::ShortType const Standard_Integer  CN  )  const [virtual]
 

virtual Standard_EXPORT const TCollection_AsciiString& StepData_ReadWriteModule::StepType const Standard_Integer  CN  )  const [pure virtual]
 

Implemented in RWHeaderSection_ReadWriteModule, RWStepAP214_ReadWriteModule, and StepData_DescrReadWrite.

virtual Standard_EXPORT void StepData_ReadWriteModule::WriteStep const Standard_Integer  CN,
StepData_StepWriter SW,
const Handle(Standard_Transient)&  ent
const [pure virtual]
 

Implemented in RWHeaderSection_ReadWriteModule, RWStepAP214_ReadWriteModule, and StepData_DescrReadWrite.


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