Defines basic File Access Module (Recognize, Read, Write) That is : ReaderModule (Recognize & Read) + Write for StepWriter (for a more centralized description) Warning : A sub-class of ReadWriteModule, which belongs to a particular Protocol, must use the same definition for Case Numbers (give the same Value for a StepType defined as a String from a File as the Protocol does for the corresponding Entity) More...
#include <StepData_ReadWriteModule.hxx>
Public Member Functions | |
| Standard_Integer | CaseNum (const Handle< Interface_FileReaderData > &data, const Standard_Integer num) const override |
| Translate the Type of record <num> in <data> to a positive Case Number, or 0 if failed. Works with a StepReaderData, in which the Type of an Entity is defined as a String : Reads the RecordType <num> then calls CaseNum (this type) Warning : The methods CaseStep, StepType and Recognize, must be in phase (triplets CaseNum-StepType-Type of Object) | |
| virtual Standard_Integer | CaseStep (const TCollection_AsciiString &atype) const =0 |
| Defines Case Numbers corresponding to the recognized Types Called by CaseNum (data,num) above for a Simple Type Entity Warning : CaseStep must give the same Value as Protocol does for the Entity type which corresponds to this Type given as a String. | |
| virtual Standard_Integer | CaseStep (const TColStd_SequenceOfAsciiString &types) const |
| Same a above but for a Complex Type Entity ("Plex") The provided Default recognizes nothing. | |
| virtual Standard_Boolean | IsComplex (const Standard_Integer CN) const |
| Returns True if the Case Number corresponds to a Complex Type ("Plex"). Remember that all possible combinations must be aknowledged to be processed Default is False for all cases. For a Protocol which defines possible Plexes, this method must be redefined. | |
| virtual const TCollection_AsciiString & | StepType (const Standard_Integer CN) const =0 |
| Function specific to STEP, which delivers the StepType as it is recorded in and read from a File compliant with STEP. This method is symmetric to the method CaseStep. StepType can be different from Dynamic Type's name, but belongs to the same class of Object. Returns an empty String if <CN> is zero. Warning : For a Complex Type Entity, returns an Empty String (Complex Type must be managed by users) | |
| virtual TCollection_AsciiString | ShortType (const Standard_Integer CN) const |
| Function specific to STEP. Some STEP Types have a short form This method can be redefined to fill it By default, returns an empty string, which is then interpreted to take normal form from StepType. | |
| virtual Standard_Boolean | ComplexType (const Standard_Integer CN, TColStd_SequenceOfAsciiString &types) const |
| Function specific to STEP, which delivers the list of types which corresponds to a complex type. If <CN> is not for a complex type, this method returns False. Else it returns True and fills the list in alphabetic order. The default returns False. To be redefined as required. | |
| void | Read (const Standard_Integer CN, const Handle< Interface_FileReaderData > &data, const Standard_Integer num, Handle< Interface_Check > &ach, const Handle< Standard_Transient > &ent) const override |
| General Read Function, calls ReadStep. | |
| virtual void | ReadStep (const Standard_Integer CN, const Handle< StepData_StepReaderData > &data, const Standard_Integer num, Handle< Interface_Check > &ach, const Handle< Standard_Transient > &ent) const =0 |
| Specific Read Function. Works with StepReaderData. | |
| virtual void | WriteStep (const Standard_Integer CN, StepData_StepWriter &SW, const Handle< Standard_Transient > &ent) const =0 |
| Write Function, switched by CaseNum. | |
 Public Member Functions inherited from Interface_ReaderModule | |
| virtual Standard_Boolean | NewRead (const Standard_Integer casenum, const Handle< Interface_FileReaderData > &data, const Standard_Integer num, Handle< Interface_Check > &ach, 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 () |
| Destructor must be virtual. | |
| virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
| Returns a type descriptor about this object. | |
| Standard_Boolean | IsInstance (const opencascade::handle< Standard_Type > &theType) const |
| Returns a true value if this is an instance of Type. | |
| Standard_Boolean | IsInstance (const Standard_CString theTypeName) const |
| Returns a true value if this is an instance of TypeName. | |
| 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. | |
| 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. | |
| 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. | |
| Standard_Integer | GetRefCount () const noexcept |
| Get the reference counter of this object. | |
| void | IncrementRefCounter () noexcept |
| Increments the reference counter of this object. | |
| Standard_Integer | DecrementRefCounter () noexcept |
| Decrements the reference counter of this object; returns the decremented value. | |
| virtual void | Delete () const |
| Memory deallocator for transient classes. | |
Additional Inherited Members | |
| Public Types inherited from Standard_Transient | |
| typedef void | base_type |
| Returns a type descriptor about this object. | |
| Static Public Member Functions inherited from Standard_Transient | |
| 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 basic File Access Module (Recognize, Read, Write) That is : ReaderModule (Recognize & Read) + Write for StepWriter (for a more centralized description) Warning : A sub-class of ReadWriteModule, which belongs to a particular Protocol, must use the same definition for Case Numbers (give the same Value for a StepType defined as a String from a File as the Protocol does for the corresponding Entity)
Member Function Documentation
◆ CaseNum()
|
overridevirtual |
Translate the Type of record <num> in <data> to a positive Case Number, or 0 if failed. Works with a StepReaderData, in which the Type of an Entity is defined as a String : Reads the RecordType <num> then calls CaseNum (this type) Warning : The methods CaseStep, StepType and Recognize, must be in phase (triplets CaseNum-StepType-Type of Object)
Implements Interface_ReaderModule.
◆ CaseStep() [1/2]
|
pure virtual |
Defines Case Numbers corresponding to the recognized Types Called by CaseNum (data,num) above for a Simple Type Entity Warning : CaseStep must give the same Value as Protocol does for the Entity type which corresponds to this Type given as a String.
Implemented in RWHeaderSection_ReadWriteModule, and RWStepAP214_ReadWriteModule.
◆ CaseStep() [2/2]
|
virtual |
Same a above but for a Complex Type Entity ("Plex") The provided Default recognizes nothing.
Reimplemented in RWHeaderSection_ReadWriteModule, and RWStepAP214_ReadWriteModule.
◆ ComplexType()
|
virtual |
Function specific to STEP, which delivers the list of types which corresponds to a complex type. If <CN> is not for a complex type, this method returns False. Else it returns True and fills the list in alphabetic order. The default returns False. To be redefined as required.
Reimplemented in RWStepAP214_ReadWriteModule.
◆ IsComplex()
|
virtual |
Returns True if the Case Number corresponds to a Complex Type ("Plex"). Remember that all possible combinations must be aknowledged to be processed Default is False for all cases. For a Protocol which defines possible Plexes, this method must be redefined.
Reimplemented in RWHeaderSection_ReadWriteModule, and RWStepAP214_ReadWriteModule.
◆ Read()
|
overridevirtual |
General Read Function, calls ReadStep.
Implements Interface_ReaderModule.
◆ ReadStep()
|
pure virtual |
Specific Read Function. Works with StepReaderData.
Implemented in RWHeaderSection_ReadWriteModule, and RWStepAP214_ReadWriteModule.
◆ ShortType()
|
virtual |
Function specific to STEP. Some STEP Types have a short form This method can be redefined to fill it By default, returns an empty string, which is then interpreted to take normal form from StepType.
◆ StepType()
|
pure virtual |
Function specific to STEP, which delivers the StepType as it is recorded in and read from a File compliant with STEP. This method is symmetric to the method CaseStep. StepType can be different from Dynamic Type's name, but belongs to the same class of Object. Returns an empty String if <CN> is zero. Warning : For a Complex Type Entity, returns an Empty String (Complex Type must be managed by users)
Implemented in RWHeaderSection_ReadWriteModule, and RWStepAP214_ReadWriteModule.
◆ WriteStep()
|
pure virtual |
Write Function, switched by CaseNum.
Implemented in RWHeaderSection_ReadWriteModule, and RWStepAP214_ReadWriteModule.
The documentation for this class was generated from the following file:
