StdObjMgt_Persistent Class Reference

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>

Inheritance diagram for StdObjMgt_Persistent:

Public Types
typedef occ::handle< StdObjMgt_Persistent >(*	Instantiator) ()
	Derived class instance create function.
typedef NCollection_Sequence< occ::handle< StdObjMgt_Persistent > >	SequenceOfPersistent
typedef void	base_type
	Returns a type descriptor about this object.

Public Member Functions
	StdObjMgt_Persistent ()
virtual void	Read (StdObjMgt_ReadData &theReadData)=0
	Read persistent data from a file.
virtual void	Write (StdObjMgt_WriteData &theWriteData) const =0
	Write persistent data to a file.
virtual void	PChildren (SequenceOfPersistent &) const =0
	Gets persistent child objects.
virtual const char *	PName () const =0
	Returns persistent type name.
virtual void	ImportDocument (const occ::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).
virtual occ::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).
virtual occ::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).
virtual void	ImportAttribute ()
	Import transient attribute from the persistent data (to be overridden by attribute classes; does nothing by default for non-attribute classes).
virtual occ::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).
virtual occ::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).
virtual TDF_Label	Label (const occ::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).
int	TypeNum () const
	Returns the assigned persistent type number.
void	TypeNum (int theTypeNum)
	Assigns a persistent type number to the object.
int	RefNum () const
	Returns the object reference number.
void	RefNum (int theRefNum)
	Sets an object reference number.
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.

Static Public Member Functions
template<class Persistent>
static occ::handle< StdObjMgt_Persistent >	Instantiate ()
	Create a derived class instance.
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

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 occ::handle< StdObjMgt_Persistent >(* StdObjMgt_Persistent::Instantiator) ()

Derived class instance create function.

SequenceOfPersistent

typedef NCollection_Sequence<occ::handle<StdObjMgt_Persistent> > StdObjMgt_Persistent::SequenceOfPersistent

Constructor & Destructor Documentation

StdObjMgt_Persistent()

StdObjMgt_Persistent::StdObjMgt_Persistent

(

)

Member Function Documentation

AsciiString()

virtual occ::handle< TCollection_HAsciiString > StdObjMgt_Persistent::AsciiString ( ) const

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 occ::handle< TDF_Attribute > StdObjMgt_Persistent::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, StdLPersistent_Value::AsciiString, StdLPersistent_Value::Integer, StdLPersistent_Value::Name, and StdLPersistent_Value::UAttribute.

ExtString()

virtual occ::handle< TCollection_HExtendedString > StdObjMgt_Persistent::ExtString ( ) const

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 occ::handle< TDF_Attribute > StdObjMgt_Persistent::GetAttribute ( ) const

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 void StdObjMgt_Persistent::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 StdLPersistent_TreeNode, StdLPersistent_Void::instance< AttribClass >, StdLPersistent_Void::instance< TDataStd_Directory >, StdLPersistent_Void::instance< TDataStd_NoteBook >, StdLPersistent_Void::instance< TDataStd_Tick >, StdPersistent_DataXtd::Geometry, StdPersistent_DataXtd::Position, StdPersistent_Naming::Naming, and StdPersistent_Naming::Naming_1.

ImportDocument()

virtual void StdObjMgt_Persistent::ImportDocument ( const occ::handle< TDocStd_Document > & theDocument ) const

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

template<class Persistent>

occ::handle< StdObjMgt_Persistent > StdObjMgt_Persistent::Instantiate ( )

inlinestatic

Create a derived class instance.

Label()

virtual TDF_Label StdObjMgt_Persistent::Label ( const occ::handle< TDF_Data > & theDF ) const

virtual

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

virtual void StdObjMgt_Persistent::PChildren ( SequenceOfPersistent & ) const

pure virtual

Gets persistent child objects.

Implemented in ShapePersistent_BRep::Curve3D, ShapePersistent_BRep::CurveOn2Surfaces, ShapePersistent_BRep::CurveOnClosedSurface, ShapePersistent_BRep::CurveOnSurface, ShapePersistent_BRep::CurveRepresentation, ShapePersistent_BRep::PointOnCurve, ShapePersistent_BRep::PointOnCurveOnSurface, ShapePersistent_BRep::PointRepresentation, ShapePersistent_BRep::PointsOnSurface, ShapePersistent_BRep::Polygon3D, ShapePersistent_BRep::PolygonOnClosedSurface, ShapePersistent_BRep::PolygonOnClosedTriangulation, ShapePersistent_BRep::PolygonOnSurface, ShapePersistent_BRep::PolygonOnTriangulation, ShapePersistent_Geom::Geometry, ShapePersistent_TopoDS::HShape, StdLPersistent_Data, StdLPersistent_Document, StdLPersistent_HArray1::instance< ArrayClass >, StdLPersistent_HArray1::instance< NCollection_HArray1< double > >, StdLPersistent_HArray1::instance< NCollection_HArray1< int > >, StdLPersistent_HArray1::instance< NCollection_HArray1< occ::handle< StdObjMgt_Persistent > > >, StdLPersistent_HArray1::instance< NCollection_HArray1< uint8_t > >, StdLPersistent_HArray2::instance< ArrayClass >, StdLPersistent_HArray2::instance< NCollection_HArray2< double > >, StdLPersistent_HArray2::instance< NCollection_HArray2< int > >, StdLPersistent_HArray2::instance< NCollection_HArray2< occ::handle< StdObjMgt_Persistent > > >, StdLPersistent_TreeNode, StdLPersistent_Void::instance< AttribClass >, StdLPersistent_Void::instance< TDataStd_Directory >, StdLPersistent_Void::instance< TDataStd_NoteBook >, StdLPersistent_Void::instance< TDataStd_Tick >, StdObjMgt_Attribute< Transient >::Simple< DataType >, StdObjMgt_Attribute< Transient >::Simple< gp_Pnt >, StdObjMgt_Attribute< Transient >::Simple< int >, StdObjMgt_Attribute< Transient >::Simple< occ::handle< StdObjMgt_Persistent > >, StdPersistent_Naming::Name, StdPersistent_Naming::Name_1, StdPersistent_Naming::Name_2, StdPersistent_TopLoc::Datum3D, and StdPersistent_TopLoc::ItemLocation.

PName()

virtual const char * StdObjMgt_Persistent::PName ( ) const

pure virtual

Returns persistent type name.

Implemented in ShapePersistent_BRep::Curve3D, ShapePersistent_BRep::CurveOn2Surfaces, ShapePersistent_BRep::CurveOnClosedSurface, ShapePersistent_BRep::CurveOnSurface, ShapePersistent_BRep::CurveRepresentation, ShapePersistent_BRep::GCurve, ShapePersistent_BRep::PointOnCurve, ShapePersistent_BRep::PointOnCurveOnSurface, ShapePersistent_BRep::PointOnSurface, ShapePersistent_BRep::PointRepresentation, ShapePersistent_BRep::PointsOnSurface, ShapePersistent_BRep::Polygon3D, ShapePersistent_BRep::PolygonOnClosedSurface, ShapePersistent_BRep::PolygonOnClosedTriangulation, ShapePersistent_BRep::PolygonOnSurface, ShapePersistent_BRep::PolygonOnTriangulation, ShapePersistent_Geom::Geometry, ShapePersistent_TopoDS::HShape, StdLPersistent_Data, StdLPersistent_Document, StdLPersistent_HArray1::instance< ArrayClass >, StdLPersistent_HArray1::instance< NCollection_HArray1< double > >, StdLPersistent_HArray1::instance< NCollection_HArray1< int > >, StdLPersistent_HArray1::instance< NCollection_HArray1< occ::handle< StdObjMgt_Persistent > > >, StdLPersistent_HArray1::instance< NCollection_HArray1< uint8_t > >, StdLPersistent_HArray1::named_instance< ArrayClass >, StdLPersistent_HArray2::instance< ArrayClass >, StdLPersistent_HArray2::instance< NCollection_HArray2< double > >, StdLPersistent_HArray2::instance< NCollection_HArray2< int > >, StdLPersistent_HArray2::instance< NCollection_HArray2< occ::handle< StdObjMgt_Persistent > > >, StdLPersistent_HArray2::named_instance< ArrayClass >, StdLPersistent_HString::Ascii, StdLPersistent_HString::Extended, StdLPersistent_TreeNode, StdLPersistent_Value::AsciiString, StdLPersistent_Value::Comment, StdLPersistent_Value::Integer, StdLPersistent_Value::Name, StdLPersistent_Value::Reference, StdLPersistent_Value::TagSource, StdLPersistent_Value::UAttribute, StdLPersistent_Void::instance< AttribClass >, StdLPersistent_Void::instance< AttribClass >, StdLPersistent_Void::instance< AttribClass >, StdLPersistent_Void::instance< AttribClass >, StdLPersistent_Void::instance< AttribClass >, StdLPersistent_Void::instance< AttribClass >, StdLPersistent_Void::instance< AttribClass >, StdLPersistent_Void::instance< AttribClass >, StdLPersistent_Void::instance< AttribClass >, StdLPersistent_Void::instance< TDataStd_Directory >, StdLPersistent_Void::instance< TDataStd_Directory >, StdLPersistent_Void::instance< TDataStd_Directory >, StdLPersistent_Void::instance< TDataStd_Directory >, StdLPersistent_Void::instance< TDataStd_Directory >, StdLPersistent_Void::instance< TDataStd_Directory >, StdLPersistent_Void::instance< TDataStd_Directory >, StdLPersistent_Void::instance< TDataStd_Directory >, StdLPersistent_Void::instance< TDataStd_Directory >, StdLPersistent_Void::instance< TDataStd_NoteBook >, StdLPersistent_Void::instance< TDataStd_NoteBook >, StdLPersistent_Void::instance< TDataStd_NoteBook >, StdLPersistent_Void::instance< TDataStd_NoteBook >, StdLPersistent_Void::instance< TDataStd_NoteBook >, StdLPersistent_Void::instance< TDataStd_NoteBook >, StdLPersistent_Void::instance< TDataStd_NoteBook >, StdLPersistent_Void::instance< TDataStd_NoteBook >, StdLPersistent_Void::instance< TDataStd_NoteBook >, StdLPersistent_Void::instance< TDataStd_Tick >, StdLPersistent_Void::instance< TDataStd_Tick >, StdLPersistent_Void::instance< TDataStd_Tick >, StdLPersistent_Void::instance< TDataStd_Tick >, StdLPersistent_Void::instance< TDataStd_Tick >, StdLPersistent_Void::instance< TDataStd_Tick >, StdLPersistent_Void::instance< TDataStd_Tick >, StdLPersistent_Void::instance< TDataStd_Tick >, StdLPersistent_Void::instance< TDataStd_Tick >, StdObjMgt_Attribute< Transient >::Simple< DataType >, StdObjMgt_Attribute< Transient >::Simple< DataType >, StdObjMgt_Attribute< Transient >::Simple< DataType >, StdObjMgt_Attribute< Transient >::Simple< DataType >, StdObjMgt_Attribute< Transient >::Simple< DataType >, StdObjMgt_Attribute< Transient >::Simple< DataType >, StdObjMgt_Attribute< Transient >::Simple< gp_Pnt >, StdObjMgt_Attribute< Transient >::Simple< gp_Pnt >, StdObjMgt_Attribute< Transient >::Simple< gp_Pnt >, StdObjMgt_Attribute< Transient >::Simple< gp_Pnt >, StdObjMgt_Attribute< Transient >::Simple< gp_Pnt >, StdObjMgt_Attribute< Transient >::Simple< int >, StdObjMgt_Attribute< Transient >::Simple< int >, StdObjMgt_Attribute< Transient >::Simple< int >, StdObjMgt_Attribute< Transient >::Simple< int >, StdObjMgt_Attribute< Transient >::Simple< int >, StdObjMgt_Attribute< Transient >::Simple< occ::handle< StdObjMgt_Persistent > >, StdObjMgt_Attribute< Transient >::Simple< occ::handle< StdObjMgt_Persistent > >, StdObjMgt_Attribute< Transient >::Simple< occ::handle< StdObjMgt_Persistent > >, StdObjMgt_Attribute< Transient >::Simple< occ::handle< StdObjMgt_Persistent > >, StdObjMgt_Attribute< Transient >::Simple< occ::handle< StdObjMgt_Persistent > >, StdPersistent_Naming::Name, StdPersistent_Naming::Name_1, StdPersistent_Naming::Name_2, StdPersistent_TopLoc::Datum3D, and StdPersistent_TopLoc::ItemLocation.

Read()

virtual void StdObjMgt_Persistent::Read ( StdObjMgt_ReadData & theReadData )

pure virtual

Read persistent data from a file.

Implemented in ShapePersistent_BRep::Curve3D, ShapePersistent_BRep::CurveOn2Surfaces, ShapePersistent_BRep::CurveOnClosedSurface, ShapePersistent_BRep::CurveOnSurface, ShapePersistent_BRep::CurveRepresentation, ShapePersistent_BRep::GCurve, ShapePersistent_BRep::PointOnCurve, ShapePersistent_BRep::PointOnCurveOnSurface, ShapePersistent_BRep::PointOnSurface, ShapePersistent_BRep::PointRepresentation, ShapePersistent_BRep::PointsOnSurface, ShapePersistent_BRep::Polygon3D, ShapePersistent_BRep::PolygonOnClosedSurface, ShapePersistent_BRep::PolygonOnClosedTriangulation, ShapePersistent_BRep::PolygonOnSurface, ShapePersistent_BRep::PolygonOnTriangulation, ShapePersistent_Geom::Geometry, ShapePersistent_TopoDS::HShape, StdLPersistent_Data, StdLPersistent_Document, StdLPersistent_TreeNode, StdLPersistent_Void::instance< AttribClass >, StdLPersistent_Void::instance< TDataStd_Directory >, StdLPersistent_Void::instance< TDataStd_NoteBook >, StdLPersistent_Void::instance< TDataStd_Tick >, StdObjMgt_Attribute< Transient >::Simple< DataType >, StdObjMgt_Attribute< Transient >::Simple< gp_Pnt >, StdObjMgt_Attribute< Transient >::Simple< int >, StdObjMgt_Attribute< Transient >::Simple< occ::handle< StdObjMgt_Persistent > >, StdPersistent_Naming::Name, StdPersistent_Naming::Name_1, StdPersistent_Naming::Name_2, StdPersistent_TopLoc::Datum3D, and StdPersistent_TopLoc::ItemLocation.

RefNum() [1/2]

int StdObjMgt_Persistent::RefNum ( ) const

inline

Returns the object reference number.

RefNum() [2/2]

void StdObjMgt_Persistent::RefNum ( int theRefNum )

inline

Sets an object reference number.

TypeNum() [1/2]

int StdObjMgt_Persistent::TypeNum ( ) const

inline

Returns the assigned persistent type number.

TypeNum() [2/2]

void StdObjMgt_Persistent::TypeNum ( int theTypeNum )

inline

Assigns a persistent type number to the object.

Write()

virtual void StdObjMgt_Persistent::Write ( StdObjMgt_WriteData & theWriteData ) const

pure virtual

Write persistent data to a file.

Implemented in ShapePersistent_BRep::Curve3D, ShapePersistent_BRep::CurveOn2Surfaces, ShapePersistent_BRep::CurveOnClosedSurface, ShapePersistent_BRep::CurveOnSurface, ShapePersistent_BRep::CurveRepresentation, ShapePersistent_BRep::GCurve, ShapePersistent_BRep::PointOnCurve, ShapePersistent_BRep::PointOnCurveOnSurface, ShapePersistent_BRep::PointOnSurface, ShapePersistent_BRep::PointRepresentation, ShapePersistent_BRep::PointsOnSurface, ShapePersistent_BRep::Polygon3D, ShapePersistent_BRep::PolygonOnClosedSurface, ShapePersistent_BRep::PolygonOnClosedTriangulation, ShapePersistent_BRep::PolygonOnSurface, ShapePersistent_BRep::PolygonOnTriangulation, ShapePersistent_Geom::Geometry, ShapePersistent_TopoDS::HShape, StdLPersistent_Data, StdLPersistent_Document, StdLPersistent_TreeNode, StdLPersistent_Void::instance< AttribClass >, StdLPersistent_Void::instance< TDataStd_Directory >, StdLPersistent_Void::instance< TDataStd_NoteBook >, StdLPersistent_Void::instance< TDataStd_Tick >, StdObjMgt_Attribute< Transient >::Simple< DataType >, StdObjMgt_Attribute< Transient >::Simple< gp_Pnt >, StdObjMgt_Attribute< Transient >::Simple< int >, StdObjMgt_Attribute< Transient >::Simple< occ::handle< StdObjMgt_Persistent > >, StdPersistent_Naming::Name, StdPersistent_Naming::Name_1, StdPersistent_Naming::Name_2, StdPersistent_TopLoc::Datum3D, and StdPersistent_TopLoc::ItemLocation.

---

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

• StdObjMgt_Persistent.hxx