Open CASCADE Technology  7.4.1.dev
Public Member Functions
Storage_Data Class Reference

A picture memorizing the data stored in a container (for example, in a file). A Storage_Data object represents either: More...

#include <Storage_Data.hxx>

Inheritance diagram for Storage_Data:
Inheritance graph
[legend]

Public Member Functions

 Storage_Data ()
 Creates an empty set of data. You explicitly create a Storage_Data object when preparing the set of objects to be stored together in a container (for example, in a file). Then use the function AddRoot to add persistent objects to the set of data. A Storage_Data object is also returned by the Read function of a Storage_Schema storage/retrieval algorithm. Use the functions NumberOfRoots and Roots to find the roots which were stored in the read container. More...
 
Storage_Error ErrorStatus () const
 Returns Storage_VSOk if. More...
 
void ClearErrorStatus ()
 Clears the error status positioned either by: More...
 
TCollection_AsciiString ErrorStatusExtension () const
 
TCollection_AsciiString CreationDate () const
 return the creation date More...
 
TCollection_AsciiString StorageVersion () const
 return the Storage package version More...
 
TCollection_AsciiString SchemaVersion () const
 get the version of the schema More...
 
TCollection_AsciiString SchemaName () const
 get the schema's name More...
 
void SetApplicationVersion (const TCollection_AsciiString &aVersion)
 set the version of the application More...
 
TCollection_AsciiString ApplicationVersion () const
 get the version of the application More...
 
void SetApplicationName (const TCollection_ExtendedString &aName)
 set the name of the application More...
 
TCollection_ExtendedString ApplicationName () const
 get the name of the application More...
 
void SetDataType (const TCollection_ExtendedString &aType)
 set the data type More...
 
TCollection_ExtendedString DataType () const
 returns data type More...
 
void AddToUserInfo (const TCollection_AsciiString &anInfo)
 add <theUserInfo> to the user informations More...
 
const TColStd_SequenceOfAsciiStringUserInfo () const
 return the user informations More...
 
void AddToComments (const TCollection_ExtendedString &aComment)
 add <theUserInfo> to the user informations More...
 
const TColStd_SequenceOfExtendedStringComments () const
 return the user informations More...
 
Standard_Integer NumberOfObjects () const
 the the number of persistent objects Return: the number of persistent objects readed More...
 
Standard_Integer NumberOfRoots () const
 Returns the number of root objects in this set of data. More...
 
void AddRoot (const Handle< Standard_Persistent > &anObject) const
 add a persistent root to write. the name of the root is a driver reference number. More...
 
void AddRoot (const TCollection_AsciiString &aName, const Handle< Standard_Persistent > &anObject) const
 Adds the root anObject to this set of data. The name of the root is aName if given; if not, it will be a reference number assigned 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. More...
 
void RemoveRoot (const TCollection_AsciiString &aName)
 Removes from this set of data the root object named aName. Warning Nothing is done if there is no root object whose name is aName in this set of data. More...
 
Handle< Storage_HSeqOfRoot > Roots () const
 Returns the roots of this set of data in a sequence. More...
 
Handle< Storage_RootFind (const TCollection_AsciiString &aName) const
 Gives the root object whose name is aName in this set of data. The returned object is a Storage_Root object, from which the object it encapsulates may be extracted. Warning A null handle is returned if there is no root object whose name is aName in this set of data. More...
 
Standard_Boolean IsRoot (const TCollection_AsciiString &aName) const
 returns Standard_True if <me> contains a root named <aName> More...
 
Standard_Integer NumberOfTypes () const
 Returns the number of types of objects used in this set of data. More...
 
Standard_Boolean IsType (const TCollection_AsciiString &aName) const
 Returns true if this set of data contains an object of type aName. Persistent objects from this set of data must have types which are recognized by the Storage_Schema algorithm used to store or retrieve them. More...
 
Handle< TColStd_HSequenceOfAsciiString > Types () const
 Gives the list of types of objects used in this set of data in a sequence. More...
 
Handle< Storage_HeaderDataHeaderData () const
 
Handle< Storage_RootDataRootData () const
 
Handle< Storage_TypeDataTypeData () const
 
Handle< Storage_InternalDataInternalData () const
 
void Clear () const
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (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_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. 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...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. 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

A picture memorizing the data stored in a container (for example, in a file). A Storage_Data object represents either:

Constructor & Destructor Documentation

◆ Storage_Data()

Storage_Data::Storage_Data ( )

Creates an empty set of data. You explicitly create a Storage_Data object when preparing the set of objects to be stored together in a container (for example, in a file). Then use the function AddRoot to add persistent objects to the set of data. A Storage_Data object is also returned by the Read function of a Storage_Schema storage/retrieval algorithm. Use the functions NumberOfRoots and Roots to find the roots which were stored in the read container.

Member Function Documentation

◆ AddRoot() [1/2]

void Storage_Data::AddRoot ( const Handle< Standard_Persistent > &  anObject) const

add a persistent root to write. the name of the root is a driver reference number.

◆ AddRoot() [2/2]

void Storage_Data::AddRoot ( const TCollection_AsciiString aName,
const Handle< Standard_Persistent > &  anObject 
) const

Adds the root anObject to this set of data. The name of the root is aName if given; if not, it will be a reference number assigned 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.

◆ AddToComments()

void Storage_Data::AddToComments ( const TCollection_ExtendedString aComment)

add <theUserInfo> to the user informations

◆ AddToUserInfo()

void Storage_Data::AddToUserInfo ( const TCollection_AsciiString anInfo)

add <theUserInfo> to the user informations

◆ ApplicationName()

TCollection_ExtendedString Storage_Data::ApplicationName ( ) const

get the name of the application

◆ ApplicationVersion()

TCollection_AsciiString Storage_Data::ApplicationVersion ( ) const

get the version of the application

◆ Clear()

void Storage_Data::Clear ( ) const

◆ ClearErrorStatus()

void Storage_Data::ClearErrorStatus ( )

Clears the error status positioned either by:

  • the last storage operation performed with the Read function, or
  • the last retrieval operation performed with the Write function by a Storage_Schema algorithm, on this set of data. This error status may be read by the function ErrorStatus.

◆ Comments()

const TColStd_SequenceOfExtendedString& Storage_Data::Comments ( ) const

return the user informations

◆ CreationDate()

TCollection_AsciiString Storage_Data::CreationDate ( ) const

return the creation date

◆ DataType()

TCollection_ExtendedString Storage_Data::DataType ( ) const

returns data type

◆ ErrorStatus()

Storage_Error Storage_Data::ErrorStatus ( ) const

Returns Storage_VSOk if.

  • the last storage operation performed with the function Read, or
  • the last retrieval operation performed with the function Write by a Storage_Schema algorithm, on this set of data was successful. If the storage or retrieval operation was not performed, the returned error status indicates the reason why the operation failed. The algorithm stops its analysis at the first detected error

◆ ErrorStatusExtension()

TCollection_AsciiString Storage_Data::ErrorStatusExtension ( ) const

◆ Find()

Handle< Storage_Root > Storage_Data::Find ( const TCollection_AsciiString aName) const

Gives the root object whose name is aName in this set of data. The returned object is a Storage_Root object, from which the object it encapsulates may be extracted. Warning A null handle is returned if there is no root object whose name is aName in this set of data.

◆ HeaderData()

Handle< Storage_HeaderData > Storage_Data::HeaderData ( ) const

◆ InternalData()

Handle< Storage_InternalData > Storage_Data::InternalData ( ) const

◆ IsRoot()

Standard_Boolean Storage_Data::IsRoot ( const TCollection_AsciiString aName) const

returns Standard_True if <me> contains a root named <aName>

◆ IsType()

Standard_Boolean Storage_Data::IsType ( const TCollection_AsciiString aName) const

Returns true if this set of data contains an object of type aName. Persistent objects from this set of data must have types which are recognized by the Storage_Schema algorithm used to store or retrieve them.

◆ NumberOfObjects()

Standard_Integer Storage_Data::NumberOfObjects ( ) const

the the number of persistent objects Return: the number of persistent objects readed

◆ NumberOfRoots()

Standard_Integer Storage_Data::NumberOfRoots ( ) const

Returns the number of root objects in this set of data.

  • When preparing a storage operation, the result is the number of roots inserted into this set of data with the function AddRoot.
  • When retrieving an object, the result is the number of roots stored in the read container. Use the Roots function to get these roots in a sequence.

◆ NumberOfTypes()

Standard_Integer Storage_Data::NumberOfTypes ( ) const

Returns the number of types of objects used in this set of data.

◆ RemoveRoot()

void Storage_Data::RemoveRoot ( const TCollection_AsciiString aName)

Removes from this set of data the root object named aName. Warning Nothing is done if there is no root object whose name is aName in this set of data.

◆ RootData()

Handle< Storage_RootData > Storage_Data::RootData ( ) const

◆ Roots()

Handle< Storage_HSeqOfRoot > Storage_Data::Roots ( ) const

Returns the roots of this set of data in a sequence.

  • When preparing a storage operation, the sequence contains the roots inserted into this set of data with the function AddRoot.
  • When retrieving an object, the sequence contains the roots stored in the container read.
  • An empty sequence is returned if there is no root in this set of data.

◆ SchemaName()

TCollection_AsciiString Storage_Data::SchemaName ( ) const

get the schema's name

◆ SchemaVersion()

TCollection_AsciiString Storage_Data::SchemaVersion ( ) const

get the version of the schema

◆ SetApplicationName()

void Storage_Data::SetApplicationName ( const TCollection_ExtendedString aName)

set the name of the application

◆ SetApplicationVersion()

void Storage_Data::SetApplicationVersion ( const TCollection_AsciiString aVersion)

set the version of the application

◆ SetDataType()

void Storage_Data::SetDataType ( const TCollection_ExtendedString aType)

set the data type

◆ StorageVersion()

TCollection_AsciiString Storage_Data::StorageVersion ( ) const

return the Storage package version

◆ TypeData()

Handle< Storage_TypeData > Storage_Data::TypeData ( ) const

◆ Types()

Handle< TColStd_HSequenceOfAsciiString > Storage_Data::Types ( ) const

Gives the list of types of objects used in this set of data in a sequence.

◆ UserInfo()

const TColStd_SequenceOfAsciiString& Storage_Data::UserInfo ( ) const

return the user informations


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