RWHeaderSection_ReadWriteModule Class Reference

General module to read and write HeaderSection entities. More...

#include <RWHeaderSection_ReadWriteModule.hxx>

Inheritance diagram for RWHeaderSection_ReadWriteModule:

Public Member Functions
	RWHeaderSection_ReadWriteModule ()
int	CaseStep (const TCollection_AsciiString &atype) const override
	associates a positive Case Number to each type of HeaderSection entity, given as a String defined in the EXPRESS form
int	CaseStep (const NCollection_Sequence< TCollection_AsciiString > &typestypes) const override
	associates a positive Case Number to each type of HeaderSection Complex entity, given as a String defined in the EXPRESS form
bool	IsComplex (const int CN) const override
	returns True if the Case Number corresponds to a Complex Type
const std::string_view &	StepType (const int CN) const override
	returns a StepType (defined in EXPRESS form which belongs to a Type of Entity, identified by its CaseNumber determined by Protocol
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 override
	Specific Read Function. Works with StepReaderData.
void	WriteStep (const int CN, StepData_StepWriter &SW, const occ::handle< Standard_Transient > &ent) const override
	Write Function, switched by CaseNum.
Public Member Functions inherited from StepData_ReadWriteModule
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 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.
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

General module to read and write HeaderSection entities.

Constructor & Destructor Documentation

RWHeaderSection_ReadWriteModule()

RWHeaderSection_ReadWriteModule::RWHeaderSection_ReadWriteModule

(

)

Member Function Documentation

CaseStep() [1/2]

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

overridevirtual

associates a positive Case Number to each type of HeaderSection Complex entity, given as a String defined in the EXPRESS form

Reimplemented from StepData_ReadWriteModule.

CaseStep() [2/2]

int RWHeaderSection_ReadWriteModule::CaseStep ( const TCollection_AsciiString & atype ) const

overridevirtual

associates a positive Case Number to each type of HeaderSection entity, given as a String defined in the EXPRESS form

Implements StepData_ReadWriteModule.

IsComplex()

bool RWHeaderSection_ReadWriteModule::IsComplex ( const int CN ) const

overridevirtual

returns True if the Case Number corresponds to a Complex Type

Reimplemented from StepData_ReadWriteModule.

ReadStep()

void RWHeaderSection_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

overridevirtual

Specific Read Function. Works with StepReaderData.

Implements StepData_ReadWriteModule.

StepType()

const std::string_view & RWHeaderSection_ReadWriteModule::StepType ( const int CN ) const

overridevirtual

returns a StepType (defined in EXPRESS form which belongs to a Type of Entity, identified by its CaseNumber determined by Protocol

Implements StepData_ReadWriteModule.

WriteStep()

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

overridevirtual

Write Function, switched by CaseNum.

Implements StepData_ReadWriteModule.

---

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

• RWHeaderSection_ReadWriteModule.hxx