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)
More...

#include <StepData_ReadWriteModule.hxx>

Inheritance diagram for StepData_ReadWriteModule:

[legend]

Public Member Functions
Standard_Integer	CaseNum (const Handle< Interface_FileReaderData > &data, const Standard_Integer num) const
	Translate the Type of record <num> in <data> to a positive <br> Case Number, or 0 if failed. <br> Works with a StepReaderData, in which the Type of an Entity <br> is defined as a String : Reads the RecordType <num> then calls <br> CaseNum (this type) <br> Warning : The methods CaseStep, StepType and Recognize, must be in phase (triplets CaseNum-StepType-Type of Object) More...

virtual Standard_Integer	CaseStep (const TCollection_AsciiString &atype) const =0
	Defines Case Numbers corresponding to the recognized Types <br> Called by CaseNum (data,num) above for a Simple Type Entity <br> Warning : CaseStep must give the same Value as Protocol does for the Entity type which corresponds to this Type given as a String More...

virtual Standard_Integer	CaseStep (const TColStd_SequenceOfAsciiString &types) const
	Same a above but for a Complex Type Entity ("Plex") The provided Default recognizes nothing More...

virtual 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. More...

virtual const TCollection_AsciiString &	StepType (const Standard_Integer CN) const =0
	Function specific to STEP, which delivers the StepType as it <br> is recorded in and read from a File compliant with STEP. <br> This method is symmetric to the method CaseStep. <br> StepType can be different from Dynamic Type's name, but <br> belongs to the same class of Object. <br> Returns an empty String if <CN> is zero. <br> Warning : For a Complex Type Entity, returns an Empty String (Complex Type must be managed by users) More...

virtual 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 More...

virtual 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. More...

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 More...

virtual 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 More...

virtual void	WriteStep (const Standard_Integer CN, StepData_StepWriter &SW, const Handle< Standard_Transient > &ent) const =0
	Write Function, switched by CaseNum More...

Public Member Functions inherited from Interface_ReaderModule
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. <br> It can be redefined when it is not possible to work in two <br> steps (NewVoid then Read). This occurs when no default <br> constructor is defined : hence the result <ent> must be <br> created with an effective definition from the reader. <br> Remark : if NewRead is defined, Copy has nothing to do. <br> 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. 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_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter. More...

virtual	~Standard_Transient ()
	Destructor must be virtual. More...

virtual void	ShallowDump (Standard_OStream &) const

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 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)

Member Function Documentation

Standard_Integer StepData_ReadWriteModule::CaseNum	(	const Handle< Interface_FileReaderData > &	data,
		const Standard_Integer	num
	)		const

virtual

Translate the Type of record <num> in <data> to a positive <br>
     Case Number, or 0 if failed. <br>
     Works with a StepReaderData, in which the Type of an Entity <br>
     is defined as a String : Reads the RecordType <num> then calls <br>
     CaseNum (this type) <br>

Warning : The methods CaseStep, StepType and Recognize,
must be in phase (triplets CaseNum-StepType-Type of Object)

Implements Interface_ReaderModule.

virtual Standard_Integer StepData_ReadWriteModule::CaseStep ( const TCollection_AsciiString & atype ) const

pure virtual

Defines Case Numbers corresponding to the recognized Types <br>
     Called by CaseNum (data,num) above for a Simple Type Entity <br>

Warning : CaseStep must give the same Value as Protocol does for the
Entity type which corresponds to this Type given as a String

Implemented in StepData_DescrReadWrite, RWHeaderSection_ReadWriteModule, and RWStepAP214_ReadWriteModule.

virtual Standard_Integer StepData_ReadWriteModule::CaseStep ( const TColStd_SequenceOfAsciiString & types ) const

virtual

Same a above but for a Complex Type Entity ("Plex")
The provided Default recognizes nothing

Reimplemented in StepData_DescrReadWrite, RWHeaderSection_ReadWriteModule, and RWStepAP214_ReadWriteModule.

virtual Standard_Boolean StepData_ReadWriteModule::ComplexType	(	const Standard_Integer	CN,
		TColStd_SequenceOfAsciiString &	types
	)		const

virtual

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.

Reimplemented in StepData_DescrReadWrite, and RWStepAP214_ReadWriteModule.

virtual Standard_Boolean StepData_ReadWriteModule::IsComplex ( const Standard_Integer CN ) const

virtual

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.

Reimplemented in StepData_DescrReadWrite, RWHeaderSection_ReadWriteModule, and RWStepAP214_ReadWriteModule.

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

General Read Function, calls ReadStep

Implements Interface_ReaderModule.

virtual 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

Specific Read Function. Works with StepReaderData

Implemented in StepData_DescrReadWrite, RWStepAP214_ReadWriteModule, and RWHeaderSection_ReadWriteModule.

virtual TCollection_AsciiString StepData_ReadWriteModule::ShortType ( const Standard_Integer CN ) const

virtual

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 const TCollection_AsciiString& StepData_ReadWriteModule::StepType ( const Standard_Integer CN ) const

pure virtual

Function specific to STEP, which delivers the StepType as it <br>
     is recorded in and read from a File compliant with STEP. <br>
     This method is symmetric to the method CaseStep. <br>
     StepType can be different from Dynamic Type's name, but <br>
     belongs to the same class of Object. <br>
     Returns an empty String if <CN> is zero. <br>

Warning : For a Complex Type Entity, returns an Empty String
(Complex Type must be managed by users)

Implemented in StepData_DescrReadWrite, RWHeaderSection_ReadWriteModule, and RWStepAP214_ReadWriteModule.

virtual void StepData_ReadWriteModule::WriteStep	(	const Standard_Integer	CN,
		StepData_StepWriter &	SW,
		const Handle< Standard_Transient > &	ent
	)		const

pure virtual

Write Function, switched by CaseNum

Implemented in StepData_DescrReadWrite, RWStepAP214_ReadWriteModule, and RWHeaderSection_ReadWriteModule.

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

StepData_ReadWriteModule.hxx

Public Member Functions

Detailed Description

Member Function Documentation