Storage_Root Class Reference

A root object extracted from a Storage_Data object. A Storage_Root encapsulates a persistent object which is a root of a Storage_Data object. It contains additional information: the name and the data type of the persistent object. When retrieving a Storage_Data object from a container (for example, a file) you access its roots with the function Roots which returns a sequence of root objects. The provided functions allow you to request information about each root of the sequence. You do not create explicit roots: when inserting data in a Storage_Data object, you just provide the persistent object and optionally its name to the function AddRoot. More...

#include <Storage_Root.hxx>

Inheritance diagram for Storage_Root:

Public Member Functions
	Storage_Root ()
	Storage_Root (const TCollection_AsciiString &theName, const Handle< Standard_Persistent > &theObject)
	Storage_Root (const TCollection_AsciiString &theName, const Standard_Integer theRef, const TCollection_AsciiString &theType)
void	SetName (const TCollection_AsciiString &theName)
TCollection_AsciiString	Name () const
	Returns the name of this root object. The name may have been given explicitly when the root was inserted into the Storage_Data object. If not, the name is a reference number which was assigned automatically by the driver when writing the set of data into the container. When naming the roots, it is easier to retrieve objects by significant references rather than by references without any semantic values. Warning The returned string will be empty if you call this function before having named this root object, either explicitly, or when writing the set of data into the container.
void	SetObject (const Handle< Standard_Persistent > &anObject)
Handle< Standard_Persistent >	Object () const
	Returns the persistent object encapsulated by this root.
TCollection_AsciiString	Type () const
	Returns the name of this root type.
void	SetReference (const Standard_Integer aRef)
Standard_Integer	Reference () const
void	SetType (const TCollection_AsciiString &aType)
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

A root object extracted from a Storage_Data object. A Storage_Root encapsulates a persistent object which is a root of a Storage_Data object. It contains additional information: the name and the data type of the persistent object. When retrieving a Storage_Data object from a container (for example, a file) you access its roots with the function Roots which returns a sequence of root objects. The provided functions allow you to request information about each root of the sequence. You do not create explicit roots: when inserting data in a Storage_Data object, you just provide the persistent object and optionally its name to the function AddRoot.

Constructor & Destructor Documentation

Storage_Root() [1/3]

Storage_Root::Storage_Root

(

)

Storage_Root() [2/3]

Storage_Root::Storage_Root	(	const TCollection_AsciiString &	theName,
		const Handle< Standard_Persistent > &	theObject )

Storage_Root() [3/3]

Storage_Root::Storage_Root	(	const TCollection_AsciiString &	theName,
		const Standard_Integer	theRef,
		const TCollection_AsciiString &	theType )

Member Function Documentation

Name()

TCollection_AsciiString Storage_Root::Name

(

)

const

Returns the name of this root object. The name may have been given explicitly when the root was inserted into the Storage_Data object. If not, the name is a reference number which was assigned automatically by the driver when writing the set of data into the container. When naming the roots, it is easier to retrieve objects by significant references rather than by references without any semantic values. Warning The returned string will be empty if you call this function before having named this root object, either explicitly, or when writing the set of data into the container.

Object()

Handle< Standard_Persistent > Storage_Root::Object

(

)

const

Returns the persistent object encapsulated by this root.

Reference()

Standard_Integer Storage_Root::Reference

(

)

const

SetName()

void Storage_Root::SetName

(

const TCollection_AsciiString &

theName

)

SetObject()

void Storage_Root::SetObject

(

const Handle< Standard_Persistent > &

anObject

)

SetReference()

void Storage_Root::SetReference

(

const Standard_Integer

aRef

)

SetType()

void Storage_Root::SetType

(

const TCollection_AsciiString &

aType

)

Type()

TCollection_AsciiString Storage_Root::Type

(

)

const

Returns the name of this root type.

---

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

• Storage_Root.hxx