Open CASCADE Technology 7.8.0
Public Member Functions | Protected Attributes
StdObjMgt_SharedObject::SharedBase< TransientT, Base > Class Template Reference

#include <StdObjMgt_SharedObject.hxx>

Inheritance diagram for StdObjMgt_SharedObject::SharedBase< TransientT, Base >:
Inheritance graph
[legend]

Public Member Functions

void Transient (const Handle< TransientT > &theTransient)
 Changes transient object.
 
const Handle< TransientT > & Import ()
 Import transient object from the persistent data.
 
- Public Member Functions inherited from StdObjMgt_Persistent
 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 Standard_CString PName () const =0
 Returns persistent type name.
 
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).
 
virtual Handle< TDF_AttributeCreateAttribute ()
 Create an empty transient attribute (to be overridden by attribute classes; does nothing and returns a null handle by default for other classes).
 
virtual Handle< TDF_AttributeGetAttribute () 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 Handle< TCollection_HAsciiStringAsciiString () const
 Get referenced ASCII string (to be overridden by ASCII string class; returns a null handle by default for other classes).
 
virtual Handle< TCollection_HExtendedStringExtString () 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 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).
 
Standard_Integer TypeNum () const
 Returns the assigned persistent type number.
 
void TypeNum (Standard_Integer theTypeNum)
 Assigns a persistent type number to the object.
 
Standard_Integer RefNum () const
 Returns the object reference number.
 
void RefNum (Standard_Integer 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_Transientoperator= (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_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.
 
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.
 

Protected Attributes

Handle< TransientTmyTransient
 

Additional Inherited Members

- Public Types inherited from StdObjMgt_Persistent
typedef Handle< StdObjMgt_Persistent >(* Instantiator) ()
 Derived class instance create function.
 
typedef NCollection_Sequence< Handle< StdObjMgt_Persistent > > SequenceOfPersistent
 
- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object.
 
- Static Public Member Functions inherited from StdObjMgt_Persistent
template<class Persistent >
static Handle< StdObjMgt_PersistentInstantiate ()
 Create a derived class instance.
 
- Static Public Member Functions inherited from Standard_Transient
static constexpr const charget_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.
 

Member Function Documentation

◆ Import()

template<class TransientT , class Base = StdObjMgt_Persistent>
const Handle< TransientT > & StdObjMgt_SharedObject::SharedBase< TransientT, Base >::Import ( )
inline

Import transient object from the persistent data.

◆ Transient()

template<class TransientT , class Base = StdObjMgt_Persistent>
void StdObjMgt_SharedObject::SharedBase< TransientT, Base >::Transient ( const Handle< TransientT > &  theTransient)
inline

Changes transient object.

Field Documentation

◆ myTransient

template<class TransientT , class Base = StdObjMgt_Persistent>
Handle< TransientT > StdObjMgt_SharedObject::SharedBase< TransientT, Base >::myTransient
protected

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