StdStorage_Root Class Reference
Describes a named persistent root. More...
#include <StdStorage_Root.hxx>
Inheritance diagram for StdStorage_Root:
Public Member Functions | |
| StdStorage_Root () | |
| Creates an empty root. | |
| StdStorage_Root (const TCollection_AsciiString &theName, const Handle< StdObjMgt_Persistent > &theObject) | |
| Creates a root for writing. | |
| TCollection_AsciiString | Name () const |
| Returns a name of the root. | |
| void | SetName (const TCollection_AsciiString &theName) |
| Sets a name to the root object. | |
| Handle< StdObjMgt_Persistent > | Object () const |
| Returns a root's persistent object. | |
| void | SetObject (const Handle< StdObjMgt_Persistent > &anObject) |
| Sets a root's persistent object. | |
| TCollection_AsciiString | Type () const |
| Returns a root's persistent type. | |
| void | SetType (const TCollection_AsciiString &aType) |
| Sets a root's persistent type. | |
| Standard_Integer | Reference () const |
| Returns root's position in the root data section. | |
 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
Describes a named persistent root.
Constructor & Destructor Documentation
◆ StdStorage_Root() [1/2]
| StdStorage_Root::StdStorage_Root | ( | ) |
Creates an empty root.
◆ StdStorage_Root() [2/2]
| StdStorage_Root::StdStorage_Root | ( | const TCollection_AsciiString & | theName, |
| const Handle< StdObjMgt_Persistent > & | theObject ) |
Creates a root for writing.
Member Function Documentation
◆ Name()
| TCollection_AsciiString StdStorage_Root::Name | ( | ) | const |
Returns a name of the root.
◆ Object()
| Handle< StdObjMgt_Persistent > StdStorage_Root::Object | ( | ) | const |
Returns a root's persistent object.
◆ Reference()
| Standard_Integer StdStorage_Root::Reference | ( | ) | const |
Returns root's position in the root data section.
◆ SetName()
| void StdStorage_Root::SetName | ( | const TCollection_AsciiString & | theName | ) |
Sets a name to the root object.
◆ SetObject()
| void StdStorage_Root::SetObject | ( | const Handle< StdObjMgt_Persistent > & | anObject | ) |
Sets a root's persistent object.
◆ SetType()
| void StdStorage_Root::SetType | ( | const TCollection_AsciiString & | aType | ) |
Sets a root's persistent type.
◆ Type()
| TCollection_AsciiString StdStorage_Root::Type | ( | ) | const |
Returns a root's persistent type.
The documentation for this class was generated from the following file:
Generated by
1.12.0