StepSelect_WorkLibrary Class Reference

Performs Read and Write a STEP File with a STEP Model Following the protocols, Copy may be implemented or not. More...

#include <StepSelect_WorkLibrary.hxx>

Inheritance diagram for StepSelect_WorkLibrary:

Public Member Functions
	StepSelect_WorkLibrary (const bool copymode=true)
	Creates a STEP WorkLibrary <copymode> precises whether Copy is implemented or not.
void	SetDumpLabel (const int modemode)
	Selects a mode to dump entities 0 (D) : prints numbers, then displays table number/label 1 : prints labels, then displays table label/number 2 : prints labels onky.
int	ReadFile (const char *const namename, occ::handle< Interface_InterfaceModel > &model, const occ::handle< Interface_Protocol > &protocol) const override
	Reads a STEP File and returns a STEP Model (into <mod>), or lets <mod> "Null" in case of Error Returns 0 if OK, 1 if Read Error, -1 if File not opened.
int	ReadStream (const char *const theName, std::istream &theIStream, occ::handle< Interface_InterfaceModel > &model, const occ::handle< Interface_Protocol > &protocol) const override
	Reads a STEP File from stream and returns a STEP Model (into <mod>), or lets <mod> "Null" in case of Error Returns 0 if OK, 1 if Read Error, -1 if File not opened.
bool	WriteFile (IFSelect_ContextWrite &ctx) const override
	Writes a File from a STEP Model Returns False (and writes no file) if <ctx> does not bring a STEP Model.
bool	CopyModel (const occ::handle< Interface_InterfaceModel > &original, const occ::handle< Interface_InterfaceModel > &newmodel, const Interface_EntityIterator &list, Interface_CopyTool &TC) const override
	Performs the copy of entities from an original model to a new one. Works according <copymode> : if True, standard copy is run else nothing is done and returned value is False.
void	DumpEntity (const occ::handle< Interface_InterfaceModel > &model, const occ::handle< Interface_Protocol > &protocol, const occ::handle< Standard_Transient > &entity, Standard_OStream &S, const int levellevel) const override
	Dumps an entity under STEP form, i.e. as a part of a Step file Works with a StepDumper. Level 0 just displays type; level 1 displays the entity itself and level 2 displays the entity plus its shared ones (one sub-level : immediately shared entities).
Public Member Functions inherited from IFSelect_WorkLibrary
void	DumpEntity (const occ::handle< Interface_InterfaceModel > &model, const occ::handle< Interface_Protocol > &protocol, const occ::handle< Standard_Transient > &entity, Standard_OStream &S) const
	Calls deferred DumpEntity with the recorded default level.
void	SetDumpLevels (const int def, const int max)
	Records a default level and a maximum value for level level for DumpEntity can go between 0 and <max> default value will be <def>.
void	DumpLevels (int &def, int &max) const
	Returns the recorded default and maximum dump levels If none was recorded, max is returned negative, def as zero.
void	SetDumpHelp (const int levellevel, const char *const help)
	Records a short line of help for a level (0 - max).
const char *	DumpHelp (const int levellevel) const
	Returns the help line recorded for <level>, or an empty string.
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.
Protected Member Functions inherited from IFSelect_WorkLibrary
	IFSelect_WorkLibrary ()
	Required to initialise fields.

Detailed Description

Performs Read and Write a STEP File with a STEP Model Following the protocols, Copy may be implemented or not.

Constructor & Destructor Documentation

StepSelect_WorkLibrary()

StepSelect_WorkLibrary::StepSelect_WorkLibrary

(

const bool

copymode = true

)

Creates a STEP WorkLibrary <copymode> precises whether Copy is implemented or not.

Member Function Documentation

CopyModel()

bool StepSelect_WorkLibrary::CopyModel ( const occ::handle< Interface_InterfaceModel > & original, const occ::handle< Interface_InterfaceModel > & newmodel, const Interface_EntityIterator & list, Interface_CopyTool & TC ) const

overridevirtual

Performs the copy of entities from an original model to a new one. Works according <copymode> : if True, standard copy is run else nothing is done and returned value is False.

Reimplemented from IFSelect_WorkLibrary.

DumpEntity()

void StepSelect_WorkLibrary::DumpEntity ( const occ::handle< Interface_InterfaceModel > & model, const occ::handle< Interface_Protocol > & protocol, const occ::handle< Standard_Transient > & entity, Standard_OStream & S, const int level ) const

overridevirtual

Dumps an entity under STEP form, i.e. as a part of a Step file Works with a StepDumper. Level 0 just displays type; level 1 displays the entity itself and level 2 displays the entity plus its shared ones (one sub-level : immediately shared entities).

Implements IFSelect_WorkLibrary.

ReadFile()

int StepSelect_WorkLibrary::ReadFile ( const char *const name, occ::handle< Interface_InterfaceModel > & model, const occ::handle< Interface_Protocol > & protocol ) const

overridevirtual

Reads a STEP File and returns a STEP Model (into <mod>), or lets <mod> "Null" in case of Error Returns 0 if OK, 1 if Read Error, -1 if File not opened.

Implements IFSelect_WorkLibrary.

ReadStream()

int StepSelect_WorkLibrary::ReadStream ( const char *const theName, std::istream & theIStream, occ::handle< Interface_InterfaceModel > & model, const occ::handle< Interface_Protocol > & protocol ) const

overridevirtual

Reads a STEP File from stream and returns a STEP Model (into <mod>), or lets <mod> "Null" in case of Error Returns 0 if OK, 1 if Read Error, -1 if File not opened.

Reimplemented from IFSelect_WorkLibrary.

SetDumpLabel()

void StepSelect_WorkLibrary::SetDumpLabel

(

const int

mode

)

Selects a mode to dump entities 0 (D) : prints numbers, then displays table number/label 1 : prints labels, then displays table label/number 2 : prints labels onky.

WriteFile()

bool StepSelect_WorkLibrary::WriteFile ( IFSelect_ContextWrite & ctx ) const

overridevirtual

Writes a File from a STEP Model Returns False (and writes no file) if <ctx> does not bring a STEP Model.

Implements IFSelect_WorkLibrary.

---

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

• StepSelect_WorkLibrary.hxx