IGESData_GeneralModule Class Reference

Definition of General Services adapted to IGES. This Services comprise : Shared & Implied Lists, Copy, Check They are adapted according to the organisation of IGES Entities : Directory Part, Lists of Associativities and Properties are specifically processed. More...

#include <IGESData_GeneralModule.hxx>

Inheritance diagram for IGESData_GeneralModule:

Public Member Functions
void	FillSharedCase (const int CN, const occ::handle< Standard_Transient > &ent, Interface_EntityIterator &iter) const override
	Fills the list of Entities shared by an IGESEntity <ent>, according a Case Number <CN> (formerly computed by CaseNum). Considers Properties and Directory Part, and calls OwnSharedCase (which is adapted to each Type of Entity).
virtual void	OwnSharedCase (const int CN, const occ::handle< IGESData_IGESEntity > &ent, Interface_EntityIterator &iter) const =0
	Lists the Entities shared by a given IGESEntity <ent>, from its specific parameters : specific for each type.
void	ListImpliedCase (const int CN, const occ::handle< Standard_Transient > &ent, Interface_EntityIterator &iter) const override
	Lists the Implied References of <ent>. Here, these are the Associativities, plus the Entities defined by OwnSharedCase.
virtual void	OwnImpliedCase (const int CN, const occ::handle< IGESData_IGESEntity > &ent, Interface_EntityIterator &iter) const
	Specific list of Entities implied by a given IGESEntity <ent> (in addition to Associativities). By default, there are none, but this method can be redefined as required.
void	CheckCase (const int CN, const occ::handle< Standard_Transient > &ent, const Interface_ShareTool &shares, occ::handle< Interface_Check > &ach) const override
	Semantic Checking of an IGESEntity. Performs general Checks, which use DirChecker, then call OwnCheck which does a check specific for each type of Entity.
virtual IGESData_DirChecker	DirChecker (const int CN, const occ::handle< IGESData_IGESEntity > &ent) const =0
	Returns a DirChecker, specific for each type of Entity (identified by its Case Number) : this DirChecker defines constraints which must be respected by the DirectoryPart.
virtual void	OwnCheckCase (const int CN, const occ::handle< IGESData_IGESEntity > &ent, const Interface_ShareTool &shares, occ::handle< Interface_Check > &ach) const =0
	Performs Specific Semantic Check for each type of Entity.
bool	CanCopy (const int CN, const occ::handle< Standard_Transient > &ent) const override
	Specific answer to the question "is Copy properly implemented" For IGES, answer is always True.
bool	NewVoid (const int CN, occ::handle< Standard_Transient > &entto) const override=0
	Specific creation of a new void entity.
void	CopyCase (const int CN, const occ::handle< Standard_Transient > &entfrom, const occ::handle< Standard_Transient > &entto, Interface_CopyTool &TC) const override
	Copy ("Deep") from <entfrom> to <entto> (same type) by using a CopyTool which provides its working Map. For IGESEntities, Copies general data (Directory Part, List of Properties) and call OwnCopyCase.
virtual void	OwnCopyCase (const int CN, const occ::handle< IGESData_IGESEntity > &entfrom, const occ::handle< IGESData_IGESEntity > &entto, Interface_CopyTool &TC) const =0
	Copies parameters which are specific of each Type of Entity.
void	RenewImpliedCase (const int CN, const occ::handle< Standard_Transient > &entfrom, const occ::handle< Standard_Transient > &entto, const Interface_CopyTool &TC) const override
	Renewing of Implied References. For IGESEntities, Copies general data(List of Associativities) and calls OwnRenewCase.
virtual void	OwnRenewCase (const int CN, const occ::handle< IGESData_IGESEntity > &entfrom, const occ::handle< IGESData_IGESEntity > &entto, const Interface_CopyTool &TC) const
	Renews parameters which are specific of each Type of Entity : the provided default does nothing, but this method may be redefined as required.
void	WhenDeleteCase (const int CN, const occ::handle< Standard_Transient > &ent, const bool dispatched) const override
	Prepares an IGES Entity for delete : works on directory part then calls OwnDeleteCase While dispatch requires to copy the entities, <dispatched> is ignored, entities are cleared in any case.
virtual void	OwnDeleteCase (const int CN, const occ::handle< IGESData_IGESEntity > &ent) const
	Specific preparation for delete, acts on own parameters Default does nothing, to be redefined as required.
occ::handle< TCollection_HAsciiString >	Name (const int CN, const occ::handle< Standard_Transient > &ent, const Interface_ShareTool &shares) const override
	Returns the name of an IGES Entity (its NameValue) Can be redefined for an even more specific case ...
Public Member Functions inherited from Interface_GeneralModule
virtual void	FillShared (const occ::handle< Interface_InterfaceModel > &model, const int CN, const occ::handle< Standard_Transient > &ent, Interface_EntityIterator &iter) const
	Specific filling of the list of Entities shared by an Entity <ent>, according a Case Number <CN> (formerly computed by CaseNum), considered in the context of a Model <model> Default calls FillSharedCase (i.e., ignores the model) Can be redefined to use the model for working.
void	Share (Interface_EntityIterator &iter, const occ::handle< Standard_Transient > &shared) const
	Adds an Entity to a Shared List (uses GetOneItem on <iter>).
virtual void	ListImplied (const occ::handle< Interface_InterfaceModel > &model, const int CN, const occ::handle< Standard_Transient > &ent, Interface_EntityIterator &iter) const
	List the Implied References of <ent> considered in the context of a Model <model> : i.e. the Entities which are Referenced while not considered as Shared (not copied if <ent> is, references not renewed by CopyCase but by ImpliedCase, only if referenced Entities have been Copied too) FillShared + ListImplied give the complete list of References Default calls ListImpliedCase (i.e. ignores the model) Can be redefined to use the model for working.
virtual bool	Dispatch (const int CN, const occ::handle< Standard_Transient > &entfrom, occ::handle< Standard_Transient > &entto, Interface_CopyTool &TC) const
	Dispatches an entity Returns True if it works by copy, False if it just duplicates the starting Handle.
virtual bool	NewCopiedCase (const int CN, const occ::handle< Standard_Transient > &entfrom, occ::handle< Standard_Transient > &entto, Interface_CopyTool &TC) const
	Specific operator (create+copy) defaulted to do nothing. It can be redefined : When it is not possible to work in two steps (NewVoid then CopyCase). This can occur when there is no default constructor : hence the result <entto> must be created with an effective definition. Remark : if NewCopiedCase is defined, CopyCase has nothing to do Returns True if it has produced something, false else.
virtual int	CategoryNumber (const int CN, const occ::handle< Standard_Transient > &ent, const Interface_ShareTool &shares) const
	Returns a category number which characterizes an entity Category Numbers are managed by the class Category <shares> can be used to evaluate this number in the context Default returns 0 which means "unspecified".
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

Definition of General Services adapted to IGES. This Services comprise : Shared & Implied Lists, Copy, Check They are adapted according to the organisation of IGES Entities : Directory Part, Lists of Associativities and Properties are specifically processed.

Member Function Documentation

CanCopy()

bool IGESData_GeneralModule::CanCopy ( const int CN, const occ::handle< Standard_Transient > & ent ) const

overridevirtual

Specific answer to the question "is Copy properly implemented" For IGES, answer is always True.

Reimplemented from Interface_GeneralModule.

CheckCase()

void IGESData_GeneralModule::CheckCase ( const int CN, const occ::handle< Standard_Transient > & ent, const Interface_ShareTool & shares, occ::handle< Interface_Check > & ach ) const

overridevirtual

Semantic Checking of an IGESEntity. Performs general Checks, which use DirChecker, then call OwnCheck which does a check specific for each type of Entity.

Implements Interface_GeneralModule.

CopyCase()

void IGESData_GeneralModule::CopyCase ( const int CN, const occ::handle< Standard_Transient > & entfrom, const occ::handle< Standard_Transient > & entto, Interface_CopyTool & TC ) const

overridevirtual

Copy ("Deep") from <entfrom> to <entto> (same type) by using a CopyTool which provides its working Map. For IGESEntities, Copies general data (Directory Part, List of Properties) and call OwnCopyCase.

Implements Interface_GeneralModule.

DirChecker()

virtual IGESData_DirChecker IGESData_GeneralModule::DirChecker ( const int CN, const occ::handle< IGESData_IGESEntity > & ent ) const

pure virtual

Returns a DirChecker, specific for each type of Entity (identified by its Case Number) : this DirChecker defines constraints which must be respected by the DirectoryPart.

Implemented in IGESAppli_GeneralModule, IGESBasic_GeneralModule, IGESData_DefaultGeneral, IGESDefs_GeneralModule, IGESDimen_GeneralModule, IGESDraw_GeneralModule, IGESGeom_GeneralModule, IGESGraph_GeneralModule, and IGESSolid_GeneralModule.

FillSharedCase()

void IGESData_GeneralModule::FillSharedCase ( const int CN, const occ::handle< Standard_Transient > & ent, Interface_EntityIterator & iter ) const

overridevirtual

Fills the list of Entities shared by an IGESEntity <ent>, according a Case Number <CN> (formerly computed by CaseNum). Considers Properties and Directory Part, and calls OwnSharedCase (which is adapted to each Type of Entity).

Implements Interface_GeneralModule.

ListImpliedCase()

void IGESData_GeneralModule::ListImpliedCase ( const int CN, const occ::handle< Standard_Transient > & ent, Interface_EntityIterator & iter ) const

overridevirtual

Lists the Implied References of <ent>. Here, these are the Associativities, plus the Entities defined by OwnSharedCase.

Reimplemented from Interface_GeneralModule.

Name()

occ::handle< TCollection_HAsciiString > IGESData_GeneralModule::Name ( const int CN, const occ::handle< Standard_Transient > & ent, const Interface_ShareTool & shares ) const

overridevirtual

Returns the name of an IGES Entity (its NameValue) Can be redefined for an even more specific case ...

Reimplemented from Interface_GeneralModule.

NewVoid()

bool IGESData_GeneralModule::NewVoid ( const int CN, occ::handle< Standard_Transient > & entto ) const

overridepure virtual

Specific creation of a new void entity.

Implements Interface_GeneralModule.

Implemented in IGESAppli_GeneralModule, IGESBasic_GeneralModule, IGESData_DefaultGeneral, IGESDefs_GeneralModule, IGESDimen_GeneralModule, IGESDraw_GeneralModule, IGESGeom_GeneralModule, IGESGraph_GeneralModule, and IGESSolid_GeneralModule.

OwnCheckCase()

virtual void IGESData_GeneralModule::OwnCheckCase ( const int CN, const occ::handle< IGESData_IGESEntity > & ent, const Interface_ShareTool & shares, occ::handle< Interface_Check > & ach ) const

pure virtual

Performs Specific Semantic Check for each type of Entity.

Implemented in IGESAppli_GeneralModule, IGESBasic_GeneralModule, IGESData_DefaultGeneral, IGESDefs_GeneralModule, IGESDimen_GeneralModule, IGESDraw_GeneralModule, IGESGeom_GeneralModule, IGESGraph_GeneralModule, and IGESSolid_GeneralModule.

OwnCopyCase()

virtual void IGESData_GeneralModule::OwnCopyCase ( const int CN, const occ::handle< IGESData_IGESEntity > & entfrom, const occ::handle< IGESData_IGESEntity > & entto, Interface_CopyTool & TC ) const

pure virtual

Copies parameters which are specific of each Type of Entity.

Implemented in IGESAppli_GeneralModule, IGESBasic_GeneralModule, IGESData_DefaultGeneral, IGESDefs_GeneralModule, IGESDimen_GeneralModule, IGESDraw_GeneralModule, IGESGeom_GeneralModule, IGESGraph_GeneralModule, and IGESSolid_GeneralModule.

OwnDeleteCase()

virtual void IGESData_GeneralModule::OwnDeleteCase ( const int CN, const occ::handle< IGESData_IGESEntity > & ent ) const

virtual

Specific preparation for delete, acts on own parameters Default does nothing, to be redefined as required.

Reimplemented in IGESDraw_GeneralModule.

OwnImpliedCase()

virtual void IGESData_GeneralModule::OwnImpliedCase ( const int CN, const occ::handle< IGESData_IGESEntity > & ent, Interface_EntityIterator & iter ) const

virtual

Specific list of Entities implied by a given IGESEntity <ent> (in addition to Associativities). By default, there are none, but this method can be redefined as required.

Reimplemented in IGESDraw_GeneralModule.

OwnRenewCase()

virtual void IGESData_GeneralModule::OwnRenewCase ( const int CN, const occ::handle< IGESData_IGESEntity > & entfrom, const occ::handle< IGESData_IGESEntity > & entto, const Interface_CopyTool & TC ) const

virtual

Renews parameters which are specific of each Type of Entity : the provided default does nothing, but this method may be redefined as required.

Reimplemented in IGESDraw_GeneralModule.

OwnSharedCase()

virtual void IGESData_GeneralModule::OwnSharedCase ( const int CN, const occ::handle< IGESData_IGESEntity > & ent, Interface_EntityIterator & iter ) const

pure virtual

Lists the Entities shared by a given IGESEntity <ent>, from its specific parameters : specific for each type.

Implemented in IGESAppli_GeneralModule, IGESBasic_GeneralModule, IGESData_DefaultGeneral, IGESDefs_GeneralModule, IGESDimen_GeneralModule, IGESDraw_GeneralModule, IGESGeom_GeneralModule, IGESGraph_GeneralModule, and IGESSolid_GeneralModule.

RenewImpliedCase()

void IGESData_GeneralModule::RenewImpliedCase ( const int CN, const occ::handle< Standard_Transient > & entfrom, const occ::handle< Standard_Transient > & entto, const Interface_CopyTool & TC ) const

overridevirtual

Renewing of Implied References. For IGESEntities, Copies general data(List of Associativities) and calls OwnRenewCase.

Reimplemented from Interface_GeneralModule.

WhenDeleteCase()

void IGESData_GeneralModule::WhenDeleteCase ( const int CN, const occ::handle< Standard_Transient > & ent, const bool dispatched ) const

overridevirtual

Prepares an IGES Entity for delete : works on directory part then calls OwnDeleteCase While dispatch requires to copy the entities, <dispatched> is ignored, entities are cleared in any case.

Reimplemented from Interface_GeneralModule.

---

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

• IGESData_GeneralModule.hxx