Root class for a temporary persistent object that reads data from a file and then creates transient object using the data. More...
#include <StdObjMgt_Persistent.hxx>
Public Types | |
| typedef Handle< StdObjMgt_Persistent >(* | Instantiator) () |
| Derived class instance create function. More... | |
| typedef NCollection_Sequence< Handle< StdObjMgt_Persistent > > | SequenceOfPersistent |
 Public Types inherited from Standard_Transient | |
| typedef void | base_type |
| Returns a type descriptor about this object. More... | |
Public Member Functions | |
| StdObjMgt_Persistent () | |
| virtual void | Read (StdObjMgt_ReadData &theReadData)=0 |
| Read persistent data from a file. More... | |
| virtual void | Write (StdObjMgt_WriteData &theWriteData) const =0 |
| Write persistent data to a file. More... | |
| virtual void | PChildren (SequenceOfPersistent &) const =0 |
| Gets persistent child objects. More... | |
| virtual Standard_CString | PName () const =0 |
| Returns persistent type name. More... | |
| virtual void | ImportDocument (const Handle< TDocStd_Document > &theDocument) const |
| Import transient document from the persistent data (to be overridden by document class; does nothing by default for other classes). More... | |
| virtual Handle< TDF_Attribute > | CreateAttribute () |
| Create an empty transient attribute (to be overridden by attribute classes; does nothing and returns a null handle by default for other classes). More... | |
| virtual Handle< TDF_Attribute > | GetAttribute () const |
| Get transient attribute for the persistent data (to be overridden by attribute classes; returns a null handle by default for non-attribute classes). More... | |
| virtual void | ImportAttribute () |
| Import transient attribute from the persistent data (to be overridden by attribute classes; does nothing by default for non-attribute classes). More... | |
| virtual Handle< TCollection_HAsciiString > | AsciiString () const |
| Get referenced ASCII string (to be overridden by ASCII string class; returns a null handle by default for other classes). More... | |
| virtual Handle< TCollection_HExtendedString > | ExtString () const |
| Get referenced extended string (to be overridden by extended string class; returns a null handle by default for other classes). More... | |
| virtual TDF_Label | Label (const Handle< TDF_Data > &theDF) const |
| Get a label expressed by referenced extended string (to be overridden by extended string class; returns a null label by default for other classes). More... | |
| Standard_Integer | TypeNum () const |
| Returns the assigned persistent type number. More... | |
| void | TypeNum (Standard_Integer theTypeNum) |
| Assigns a persistent type number to the object. More... | |
| Standard_Integer | RefNum () const |
| Returns the object reference number. More... | |
| void | RefNum (Standard_Integer theRefNum) |
| Sets an object reference number. More... | |
| Public Member Functions inherited from Standard_Transient | |
| Standard_Transient () | |
| Empty constructor. More... | |
| Standard_Transient (const Standard_Transient &) | |
| Copy constructor – does nothing. More... | |
| Standard_Transient & | operator= (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_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. 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... | |
Static Public Member Functions | |
| template<class Persistent > | |
| static Handle< StdObjMgt_Persistent > | Instantiate () |
| Create a derived class instance. 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
Root class for a temporary persistent object that reads data from a file and then creates transient object using the data.
Member Typedef Documentation
◆ Instantiator
| typedef Handle< StdObjMgt_Persistent >(* StdObjMgt_Persistent::Instantiator) () |
Derived class instance create function.
◆ SequenceOfPersistent
| typedef NCollection_Sequence<Handle< StdObjMgt_Persistent > > StdObjMgt_Persistent::SequenceOfPersistent |
Constructor & Destructor Documentation
◆ StdObjMgt_Persistent()
| StdObjMgt_Persistent::StdObjMgt_Persistent | ( | ) |
Member Function Documentation
◆ AsciiString()
|
virtual |
Get referenced ASCII string (to be overridden by ASCII string class; returns a null handle by default for other classes).
Reimplemented in StdLPersistent_HString::Ascii.
◆ CreateAttribute()
|
virtual |
Create an empty transient attribute (to be overridden by attribute classes; does nothing and returns a null handle by default for other classes).
Reimplemented in StdLPersistent_TreeNode.
◆ ExtString()
|
virtual |
Get referenced extended string (to be overridden by extended string class; returns a null handle by default for other classes).
Reimplemented in StdLPersistent_HString::Extended.
◆ GetAttribute()
|
virtual |
Get transient attribute for the persistent data (to be overridden by attribute classes; returns a null handle by default for non-attribute classes).
◆ ImportAttribute()
|
virtual |
Import transient attribute from the persistent data (to be overridden by attribute classes; does nothing by default for non-attribute classes).
Reimplemented in StdPersistent_Naming::Naming_1, StdPersistent_Naming::Naming, StdPersistent_DataXtd::Position, StdPersistent_DataXtd::Geometry, and StdLPersistent_TreeNode.
◆ ImportDocument()
|
virtual |
Import transient document from the persistent data (to be overridden by document class; does nothing by default for other classes).
Reimplemented in StdLPersistent_Document.
◆ Instantiate()
|
inlinestatic |
Create a derived class instance.
◆ Label()
Get a label expressed by referenced extended string (to be overridden by extended string class; returns a null label by default for other classes).
◆ PChildren()
|
pure virtual |
Gets persistent child objects.
Implemented in StdPersistent_Naming::Name_2, StdPersistent_Naming::Name_1, StdPersistent_Naming::Name, StdLPersistent_Data, ShapePersistent_BRep::CurveOn2Surfaces, ShapePersistent_BRep::PolygonOnClosedSurface, ShapePersistent_BRep::PolygonOnSurface, ShapePersistent_BRep::PolygonOnClosedTriangulation, ShapePersistent_BRep::PolygonOnTriangulation, ShapePersistent_BRep::Polygon3D, ShapePersistent_BRep::CurveOnClosedSurface, ShapePersistent_BRep::CurveOnSurface, ShapePersistent_BRep::Curve3D, ShapePersistent_BRep::CurveRepresentation, ShapePersistent_BRep::PointOnCurveOnSurface, ShapePersistent_BRep::PointsOnSurface, ShapePersistent_BRep::PointOnCurve, ShapePersistent_BRep::PointRepresentation, StdObjMgt_Attribute< Transient >::Simple< DataType >, StdObjMgt_Attribute< Transient >::Simple< Standard_Integer >, StdObjMgt_Attribute< Transient >::Simple< gp_Pnt >, StdObjMgt_Attribute< Transient >::Simple< Handle< StdObjMgt_Persistent > >, StdLPersistent_TreeNode, StdLPersistent_Document, StdPersistent_TopLoc::ItemLocation, ShapePersistent_TopoDS::HShape, ShapePersistent_Geom::Geometry, and StdPersistent_TopLoc::Datum3D.
◆ PName()
|
pure virtual |
Returns persistent type name.
Implemented in StdPersistent_TopLoc::ItemLocation, StdPersistent_TopLoc::Datum3D, StdPersistent_Naming::Name_2, StdPersistent_Naming::Name_1, StdPersistent_Naming::Name, StdObjMgt_Attribute< Transient >::Simple< DataType >, StdObjMgt_Attribute< Transient >::Simple< Standard_Integer >, StdObjMgt_Attribute< Transient >::Simple< gp_Pnt >, StdObjMgt_Attribute< Transient >::Simple< Handle< StdObjMgt_Persistent > >, StdObjMgt_Attribute< Transient >::Simple< DataType >, StdObjMgt_Attribute< Transient >::Simple< Standard_Integer >, StdObjMgt_Attribute< Transient >::Simple< gp_Pnt >, StdObjMgt_Attribute< Transient >::Simple< Handle< StdObjMgt_Persistent > >, StdObjMgt_Attribute< Transient >::Simple< DataType >, StdObjMgt_Attribute< Transient >::Simple< Standard_Integer >, StdObjMgt_Attribute< Transient >::Simple< gp_Pnt >, StdObjMgt_Attribute< Transient >::Simple< Handle< StdObjMgt_Persistent > >, StdObjMgt_Attribute< Transient >::Simple< DataType >, StdObjMgt_Attribute< Transient >::Simple< Standard_Integer >, StdObjMgt_Attribute< Transient >::Simple< gp_Pnt >, StdObjMgt_Attribute< Transient >::Simple< Handle< StdObjMgt_Persistent > >, StdObjMgt_Attribute< Transient >::Simple< DataType >, StdObjMgt_Attribute< Transient >::Simple< Standard_Integer >, StdObjMgt_Attribute< Transient >::Simple< gp_Pnt >, StdObjMgt_Attribute< Transient >::Simple< Handle< StdObjMgt_Persistent > >, StdObjMgt_Attribute< Transient >::Simple< DataType >, StdObjMgt_Attribute< Transient >::Simple< Standard_Integer >, StdObjMgt_Attribute< Transient >::Simple< gp_Pnt >, StdObjMgt_Attribute< Transient >::Simple< Handle< StdObjMgt_Persistent > >, StdLPersistent_TreeNode, StdLPersistent_HString::Extended, StdLPersistent_HString::Ascii, StdLPersistent_Document, StdLPersistent_Data, ShapePersistent_TopoDS::HShape, ShapePersistent_Geom::Geometry, ShapePersistent_BRep::CurveOn2Surfaces, ShapePersistent_BRep::PolygonOnClosedSurface, ShapePersistent_BRep::PolygonOnSurface, ShapePersistent_BRep::PolygonOnClosedTriangulation, ShapePersistent_BRep::PolygonOnTriangulation, ShapePersistent_BRep::Polygon3D, ShapePersistent_BRep::CurveOnClosedSurface, ShapePersistent_BRep::CurveOnSurface, ShapePersistent_BRep::Curve3D, ShapePersistent_BRep::GCurve, ShapePersistent_BRep::CurveRepresentation, ShapePersistent_BRep::PointOnSurface, ShapePersistent_BRep::PointOnCurveOnSurface, ShapePersistent_BRep::PointsOnSurface, ShapePersistent_BRep::PointOnCurve, and ShapePersistent_BRep::PointRepresentation.
◆ Read()
|
pure virtual |
Read persistent data from a file.
Implemented in StdPersistent_TopLoc::ItemLocation, StdPersistent_TopLoc::Datum3D, StdPersistent_Naming::Name_2, StdPersistent_Naming::Name_1, StdPersistent_Naming::Name, StdObjMgt_Attribute< Transient >::Simple< DataType >, StdObjMgt_Attribute< Transient >::Simple< Standard_Integer >, StdObjMgt_Attribute< Transient >::Simple< gp_Pnt >, StdObjMgt_Attribute< Transient >::Simple< Handle< StdObjMgt_Persistent > >, StdLPersistent_TreeNode, StdLPersistent_Document, StdLPersistent_Data, ShapePersistent_TopoDS::HShape, ShapePersistent_Geom::Geometry, ShapePersistent_BRep::CurveOn2Surfaces, ShapePersistent_BRep::PolygonOnClosedSurface, ShapePersistent_BRep::PolygonOnSurface, ShapePersistent_BRep::PolygonOnClosedTriangulation, ShapePersistent_BRep::PolygonOnTriangulation, ShapePersistent_BRep::Polygon3D, ShapePersistent_BRep::CurveOnClosedSurface, ShapePersistent_BRep::CurveOnSurface, ShapePersistent_BRep::Curve3D, ShapePersistent_BRep::GCurve, ShapePersistent_BRep::CurveRepresentation, ShapePersistent_BRep::PointOnSurface, ShapePersistent_BRep::PointOnCurveOnSurface, ShapePersistent_BRep::PointsOnSurface, ShapePersistent_BRep::PointOnCurve, and ShapePersistent_BRep::PointRepresentation.
◆ RefNum() [1/2]
|
inline |
Returns the object reference number.
◆ RefNum() [2/2]
|
inline |
Sets an object reference number.
◆ TypeNum() [1/2]
|
inline |
Returns the assigned persistent type number.
◆ TypeNum() [2/2]
|
inline |
Assigns a persistent type number to the object.
◆ Write()
|
pure virtual |
Write persistent data to a file.
Implemented in StdPersistent_TopLoc::ItemLocation, StdPersistent_TopLoc::Datum3D, StdPersistent_Naming::Name_2, StdPersistent_Naming::Name_1, StdPersistent_Naming::Name, StdObjMgt_Attribute< Transient >::Simple< DataType >, StdObjMgt_Attribute< Transient >::Simple< Standard_Integer >, StdObjMgt_Attribute< Transient >::Simple< gp_Pnt >, StdObjMgt_Attribute< Transient >::Simple< Handle< StdObjMgt_Persistent > >, StdLPersistent_TreeNode, StdLPersistent_Document, StdLPersistent_Data, ShapePersistent_TopoDS::HShape, ShapePersistent_Geom::Geometry, ShapePersistent_BRep::CurveOn2Surfaces, ShapePersistent_BRep::PolygonOnClosedSurface, ShapePersistent_BRep::PolygonOnSurface, ShapePersistent_BRep::PolygonOnClosedTriangulation, ShapePersistent_BRep::PolygonOnTriangulation, ShapePersistent_BRep::Polygon3D, ShapePersistent_BRep::CurveOnClosedSurface, ShapePersistent_BRep::CurveOnSurface, ShapePersistent_BRep::Curve3D, ShapePersistent_BRep::GCurve, ShapePersistent_BRep::CurveRepresentation, ShapePersistent_BRep::PointOnSurface, ShapePersistent_BRep::PointOnCurveOnSurface, ShapePersistent_BRep::PointsOnSurface, ShapePersistent_BRep::PointOnCurve, and ShapePersistent_BRep::PointRepresentation.
The documentation for this class was generated from the following file:
