Open CASCADE Technology  7.7.0.dev
Public Member Functions

IGESData_GeneralModule Class Referenceabstract

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:
Inheritance graph
[legend]

Public Member Functions

void FillSharedCase (const Standard_Integer CN, const 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) More...
 
virtual void OwnSharedCase (const Standard_Integer CN, const 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. More...
 
virtual void ListImpliedCase (const Standard_Integer CN, const 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. More...
 
virtual void OwnImpliedCase (const Standard_Integer CN, const 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. More...
 
void CheckCase (const Standard_Integer CN, const Handle< Standard_Transient > &ent, const Interface_ShareTool &shares, 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. More...
 
virtual IGESData_DirChecker DirChecker (const Standard_Integer CN, const 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. More...
 
virtual void OwnCheckCase (const Standard_Integer CN, const Handle< IGESData_IGESEntity > &ent, const Interface_ShareTool &shares, Handle< Interface_Check > &ach) const =0
 Performs Specific Semantic Check for each type of Entity. More...
 
virtual Standard_Boolean CanCopy (const Standard_Integer CN, const Handle< Standard_Transient > &ent) const override
 Specific answer to the question "is Copy properly implemented" For IGES, answer is always True. More...
 
virtual Standard_Boolean NewVoid (const Standard_Integer CN, Handle< Standard_Transient > &entto) const override=0
 Specific creation of a new void entity. More...
 
void CopyCase (const Standard_Integer CN, const Handle< Standard_Transient > &entfrom, const 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. More...
 
virtual void OwnCopyCase (const Standard_Integer CN, const Handle< IGESData_IGESEntity > &entfrom, const Handle< IGESData_IGESEntity > &entto, Interface_CopyTool &TC) const =0
 Copies parameters which are specific of each Type of Entity. More...
 
virtual void RenewImpliedCase (const Standard_Integer CN, const Handle< Standard_Transient > &entfrom, const 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. More...
 
virtual void OwnRenewCase (const Standard_Integer CN, const Handle< IGESData_IGESEntity > &entfrom, const 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. More...
 
virtual void WhenDeleteCase (const Standard_Integer CN, const Handle< Standard_Transient > &ent, const Standard_Boolean 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. More...
 
virtual void OwnDeleteCase (const Standard_Integer CN, const Handle< IGESData_IGESEntity > &ent) const
 Specific preparation for delete, acts on own parameters Default does nothing, to be redefined as required. More...
 
virtual Handle< TCollection_HAsciiStringName (const Standard_Integer CN, const 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 ... More...
 
- Public Member Functions inherited from Interface_GeneralModule
virtual void FillShared (const Handle< Interface_InterfaceModel > &model, const Standard_Integer CN, const 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. More...
 
void Share (Interface_EntityIterator &iter, const Handle< Standard_Transient > &shared) const
 Adds an Entity to a Shared List (uses GetOneItem on <iter>) More...
 
virtual void ListImplied (const Handle< Interface_InterfaceModel > &model, const Standard_Integer CN, const 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. More...
 
virtual Standard_Boolean Dispatch (const Standard_Integer CN, const Handle< Standard_Transient > &entfrom, 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. More...
 
virtual Standard_Boolean NewCopiedCase (const Standard_Integer CN, const Handle< Standard_Transient > &entfrom, 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. More...
 
virtual Standard_Integer CategoryNumber (const Standard_Integer CN, const 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". More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::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 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. 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...
 
Standard_TransientThis () 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. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 

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

virtual Standard_Boolean IGESData_GeneralModule::CanCopy ( const Standard_Integer  CN,
const 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 Standard_Integer  CN,
const Handle< Standard_Transient > &  ent,
const Interface_ShareTool shares,
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 Standard_Integer  CN,
const Handle< Standard_Transient > &  entfrom,
const 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 Standard_Integer  CN,
const 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 IGESSolid_GeneralModule, IGESGraph_GeneralModule, IGESGeom_GeneralModule, IGESDraw_GeneralModule, IGESDimen_GeneralModule, IGESDefs_GeneralModule, IGESData_DefaultGeneral, IGESBasic_GeneralModule, and IGESAppli_GeneralModule.

◆ FillSharedCase()

void IGESData_GeneralModule::FillSharedCase ( const Standard_Integer  CN,
const 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()

virtual void IGESData_GeneralModule::ListImpliedCase ( const Standard_Integer  CN,
const 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()

virtual Handle< TCollection_HAsciiString > IGESData_GeneralModule::Name ( const Standard_Integer  CN,
const 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()

virtual Standard_Boolean IGESData_GeneralModule::NewVoid ( const Standard_Integer  CN,
Handle< Standard_Transient > &  entto 
) const
overridepure virtual

◆ OwnCheckCase()

virtual void IGESData_GeneralModule::OwnCheckCase ( const Standard_Integer  CN,
const Handle< IGESData_IGESEntity > &  ent,
const Interface_ShareTool shares,
Handle< Interface_Check > &  ach 
) const
pure virtual

◆ OwnCopyCase()

virtual void IGESData_GeneralModule::OwnCopyCase ( const Standard_Integer  CN,
const Handle< IGESData_IGESEntity > &  entfrom,
const Handle< IGESData_IGESEntity > &  entto,
Interface_CopyTool TC 
) const
pure virtual

◆ OwnDeleteCase()

virtual void IGESData_GeneralModule::OwnDeleteCase ( const Standard_Integer  CN,
const 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 Standard_Integer  CN,
const 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 Standard_Integer  CN,
const Handle< IGESData_IGESEntity > &  entfrom,
const 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 Standard_Integer  CN,
const 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 IGESSolid_GeneralModule, IGESGraph_GeneralModule, IGESGeom_GeneralModule, IGESDraw_GeneralModule, IGESDimen_GeneralModule, IGESDefs_GeneralModule, IGESData_DefaultGeneral, IGESBasic_GeneralModule, and IGESAppli_GeneralModule.

◆ RenewImpliedCase()

virtual void IGESData_GeneralModule::RenewImpliedCase ( const Standard_Integer  CN,
const Handle< Standard_Transient > &  entfrom,
const 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()

virtual void IGESData_GeneralModule::WhenDeleteCase ( const Standard_Integer  CN,
const Handle< Standard_Transient > &  ent,
const Standard_Boolean  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: