OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    Interface_ReaderModule Class Referenceabstract

    Defines unitary operations required to read an Entity from a File (see FileReaderData, FileReaderTool), under control of a FileReaderTool. The initial creation is performed by a GeneralModule (set in GeneralLib). Then, which remains is Loading data from the FileReaderData to the Entity. More...

    #include <Interface_ReaderModule.hxx>

    Inheritance diagram for Interface_ReaderModule:

    Public Member Functions

    virtual int CaseNum (const occ::handle< Interface_FileReaderData > &datadata, const int numnum) const =0
     Translates the type of record <num> in <data> to a positive Case Number. If Recognition fails, must return 0.
    virtual void Read (const int casenum, const occ::handle< Interface_FileReaderData > &datadata, const int numnum, occ::handle< Interface_Check > &ach, const occ::handle< Standard_Transient > &ent) const =0
     Performs the effective loading from <data>, record <num>, to the Entity <ent> formerly created In case of Error or Warning, fills <ach> with messages Remark that the Case Number comes from translating a record.
    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

    Defines unitary operations required to read an Entity from a File (see FileReaderData, FileReaderTool), under control of a FileReaderTool. The initial creation is performed by a GeneralModule (set in GeneralLib). Then, which remains is Loading data from the FileReaderData to the Entity.

    To work, a GeneralModule has formerly recognized the Type read from FileReaderData as a positive Case Number, then the ReaderModule reads it according to this Case Number

    Member Function Documentation

    ◆ CaseNum()

    virtual int Interface_ReaderModule::CaseNum ( const occ::handle< Interface_FileReaderData > & data,
    const int num ) const
    pure virtual

    Translates the type of record <num> in <data> to a positive Case Number. If Recognition fails, must return 0.

    Implemented in IGESData_ReadWriteModule, and StepData_ReadWriteModule.

    ◆ NewRead()

    virtual bool Interface_ReaderModule::NewRead ( const int casenum,
    const occ::handle< Interface_FileReaderData > & data,
    const int num,
    occ::handle< Interface_Check > & ach,
    occ::handle< Standard_Transient > & ent ) const
    virtual

    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.

    Returns True if it has produced something, false else. If nothing was produced, <ach> should be filled : it will be treated as "Unrecognized case" by reader tool.

    ◆ Read()

    virtual void Interface_ReaderModule::Read ( const int casenum,
    const occ::handle< Interface_FileReaderData > & data,
    const int num,
    occ::handle< Interface_Check > & ach,
    const occ::handle< Standard_Transient > & ent ) const
    pure virtual

    Performs the effective loading from <data>, record <num>, to the Entity <ent> formerly created In case of Error or Warning, fills <ach> with messages Remark that the Case Number comes from translating a record.

    Implemented in IGESData_ReadWriteModule, and StepData_ReadWriteModule.


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