OCCT3D OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    IGESDraw_GeneralModule Class Reference

    Definition of General Services for IGESDraw (specific part) This Services comprise : Shared & Implied Lists, Copy, Check. More...

    #include <IGESDraw_GeneralModule.hxx>

    Inheritance diagram for IGESDraw_GeneralModule:

    Public Member Functions

     IGESDraw_GeneralModule ()
     Creates a GeneralModule from IGESDraw and puts it into GeneralLib.
    void OwnSharedCase (const int CN, const occ::handle< IGESData_IGESEntity > &ent, Interface_EntityIterator &iter) const override
     Lists the Entities shared by a given IGESEntity <ent>, from its specific parameters : specific for each type.
    void OwnImpliedCase (const int CN, const occ::handle< IGESData_IGESEntity > &ent, Interface_EntityIterator &iter) const override
     Specific list of Entities implied by an IGESEntity <ent> (in addition to Associativities). Redefined for ViewsVisible ...
    IGESData_DirChecker DirChecker (const int CN, const occ::handle< IGESData_IGESEntity > &ent) const override
     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.
    void OwnCheckCase (const int CN, const occ::handle< IGESData_IGESEntity > &ent, const Interface_ShareTool &shares, occ::handle< Interface_Check > &ach) const override
     Performs Specific Semantic Check for each type of Entity.
    bool NewVoid (const int CN, occ::handle< Standard_Transient > &entto) const override
     Specific creation of a new void entity.
    void OwnCopyCase (const int CN, const occ::handle< IGESData_IGESEntity > &entfrom, const occ::handle< IGESData_IGESEntity > &entto, Interface_CopyTool &TC) const override
     Copies parameters which are specific of each Type of Entity.
    void OwnRenewCase (const int CN, const occ::handle< IGESData_IGESEntity > &entfrom, const occ::handle< IGESData_IGESEntity > &entto, const Interface_CopyTool &TC) const override
     Renews parameters which are specific of each Type of Entity : redefined for ViewsVisible ... (takes only the implied ref.s which have also been copied).
    void OwnDeleteCase (const int CN, const occ::handle< IGESData_IGESEntity > &ent) const override
     Clears parameters with can cause looping structures : redefined for ViewsVisible ... (clears the implied ref.s).
    int CategoryNumber (const int CN, const occ::handle< Standard_Transient > &ent, const Interface_ShareTool &shares) const override
     Returns a category number which characterizes an entity Planar : Auxiliary Subfigures and ConnectPoint : Structure others : Drawing.
    Public Member Functions inherited from IGESData_GeneralModule
    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).
    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.
    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.
    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.
    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.
    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.
    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.
    occ::handle< TCollection_HAsciiStringName (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.
    Public Member Functions inherited from Standard_Transient
     Standard_Transient ()
     Empty constructor.
     Standard_Transient (const Standard_Transient &)
     Copy constructor – does nothing.
    Standard_Transientoperator= (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_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.
    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 for IGESDraw (specific part) This Services comprise : Shared & Implied Lists, Copy, Check.

    Constructor & Destructor Documentation

    ◆ IGESDraw_GeneralModule()

    IGESDraw_GeneralModule::IGESDraw_GeneralModule ( )

    Creates a GeneralModule from IGESDraw and puts it into GeneralLib.

    Member Function Documentation

    ◆ CategoryNumber()

    int IGESDraw_GeneralModule::CategoryNumber ( const int CN,
    const occ::handle< Standard_Transient > & ent,
    const Interface_ShareTool & shares ) const
    overridevirtual

    Returns a category number which characterizes an entity Planar : Auxiliary Subfigures and ConnectPoint : Structure others : Drawing.

    Reimplemented from Interface_GeneralModule.

    ◆ DirChecker()

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

    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.

    Implements IGESData_GeneralModule.

    ◆ NewVoid()

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

    Specific creation of a new void entity.

    Implements IGESData_GeneralModule.

    ◆ OwnCheckCase()

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

    Performs Specific Semantic Check for each type of Entity.

    Implements IGESData_GeneralModule.

    ◆ OwnCopyCase()

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

    Copies parameters which are specific of each Type of Entity.

    Implements IGESData_GeneralModule.

    ◆ OwnDeleteCase()

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

    Clears parameters with can cause looping structures : redefined for ViewsVisible ... (clears the implied ref.s).

    Reimplemented from IGESData_GeneralModule.

    ◆ OwnImpliedCase()

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

    Specific list of Entities implied by an IGESEntity <ent> (in addition to Associativities). Redefined for ViewsVisible ...

    Reimplemented from IGESData_GeneralModule.

    ◆ OwnRenewCase()

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

    Renews parameters which are specific of each Type of Entity : redefined for ViewsVisible ... (takes only the implied ref.s which have also been copied).

    Reimplemented from IGESData_GeneralModule.

    ◆ OwnSharedCase()

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

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

    Implements IGESData_GeneralModule.


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