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

#include <StepData_ReadWriteModule.hxx>

Inheritance diagram for StepData_ReadWriteModule:

Public Member Functions
int	CaseNum (const occ::handle< Interface_FileReaderData > &datadata, const int numnum) const override
	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 int	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 int	CaseStep (const NCollection_Sequence< TCollection_AsciiString > &typestypes) const
	Same a above but for a Complex Type Entity ("Plex") The provided Default recognizes nothing.
virtual bool	IsComplex (const int CN) const
	Returns True if the Case Number corresponds to a Complex Type ("Plex"). Remember that all possible combinations must be acknowledged to be processed Default is False for all cases. For a Protocol which defines possible Plexes, this method must be redefined.
virtual const std::string_view &	StepType (const int 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 TCollection_AsciiString	ShortType (const int 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 bool	ComplexType (const int CN, NCollection_Sequence< TCollection_AsciiString > &typestypes) 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.
void	Read (const int CN, const occ::handle< Interface_FileReaderData > &datadata, const int numnum, occ::handle< Interface_Check > &ach, const occ::handle< Standard_Transient > &ent) const override
	General Read Function, calls ReadStep.
virtual void	ReadStep (const int CN, const occ::handle< StepData_StepReaderData > &datadata, const int numnum, occ::handle< Interface_Check > &ach, const occ::handle< Standard_Transient > &ent) const =0
	Specific Read Function. Works with StepReaderData.
virtual void	WriteStep (const int CN, StepData_StepWriter &SW, const occ::handle< Standard_Transient > &ent) const =0
	Write Function, switched by CaseNum.
Public Member Functions inherited from Interface_ReaderModule
virtual bool	NewRead (const int casenum, const occ::handle< Interface_FileReaderData > &datadata, const int numnum, occ::handle< Interface_Check > &ach, occ::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.
Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.
	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.
Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.
virtual	~Standard_Transient ()=default
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
bool	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.
bool	IsKind (const opencascade::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.
bool	IsKind (const char *const 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.
Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
int	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
virtual void	Delete () const
	Memory deallocator for transient classes.

Additional Inherited Members
typedef void	base_type
	Returns a type descriptor about this object.
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.
static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

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

CaseNum()

int StepData_ReadWriteModule::CaseNum ( const occ::handle< Interface_FileReaderData > & data, const int num ) const

overridevirtual

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

Implements Interface_ReaderModule.

CaseStep() [1/2]

virtual int StepData_ReadWriteModule::CaseStep ( const NCollection_Sequence< TCollection_AsciiString > & types ) const

virtual

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

Reimplemented in RWHeaderSection_ReadWriteModule.

CaseStep() [2/2]

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

pure virtual

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.

Implemented in RWHeaderSection_ReadWriteModule.

ComplexType()

virtual bool StepData_ReadWriteModule::ComplexType ( const int CN, NCollection_Sequence< TCollection_AsciiString > & 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.

IsComplex()

virtual bool StepData_ReadWriteModule::IsComplex ( const int CN ) const

virtual

Returns True if the Case Number corresponds to a Complex Type ("Plex"). Remember that all possible combinations must be acknowledged to be processed Default is False for all cases. For a Protocol which defines possible Plexes, this method must be redefined.

Reimplemented in RWHeaderSection_ReadWriteModule.

Read()

void StepData_ReadWriteModule::Read ( const int CN, const occ::handle< Interface_FileReaderData > & data, const int num, occ::handle< Interface_Check > & ach, const occ::handle< Standard_Transient > & ent ) const

overridevirtual

General Read Function, calls ReadStep.

Implements Interface_ReaderModule.

ReadStep()

virtual void StepData_ReadWriteModule::ReadStep ( const int CN, const occ::handle< StepData_StepReaderData > & data, const int num, occ::handle< Interface_Check > & ach, const occ::handle< Standard_Transient > & ent ) const

pure virtual

Specific Read Function. Works with StepReaderData.

Implemented in RWHeaderSection_ReadWriteModule.

ShortType()

virtual TCollection_AsciiString StepData_ReadWriteModule::ShortType ( const int 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.

StepType()

virtual const std::string_view & StepData_ReadWriteModule::StepType ( const int CN ) const

pure virtual

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

Implemented in RWHeaderSection_ReadWriteModule.

WriteStep()

virtual void StepData_ReadWriteModule::WriteStep ( const int CN, StepData_StepWriter & SW, const occ::handle< Standard_Transient > & ent ) const

pure virtual

Write Function, switched by CaseNum.

Implemented in RWHeaderSection_ReadWriteModule.

---

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

• StepData_ReadWriteModule.hxx