Open CASCADE Technology
6.5.4
|
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>
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. | |
Storage_Error | ErrorStatus () const |
Returns Storage_VSOk if | |
void | ClearErrorStatus () |
Clears the error status positioned either by: | |
TCollection_AsciiString | ErrorStatusExtension () const |
TCollection_AsciiString | CreationDate () const |
return the creation date | |
TCollection_AsciiString | StorageVersion () const |
return the Storage package version | |
TCollection_AsciiString | SchemaVersion () const |
get the version of the schema | |
TCollection_AsciiString | SchemaName () const |
get the schema's name | |
void | SetApplicationVersion (const TCollection_AsciiString &aVersion) |
set the version of the application | |
TCollection_AsciiString | ApplicationVersion () const |
get the version of the application | |
void | SetApplicationName (const TCollection_ExtendedString &aName) |
set the name of the application | |
TCollection_ExtendedString | ApplicationName () const |
get the name of the application | |
void | SetDataType (const TCollection_ExtendedString &aType) |
set the data type | |
TCollection_ExtendedString | DataType () const |
returns data type | |
void | AddToUserInfo (const TCollection_AsciiString &anInfo) |
add <theUserInfo> to the user informations | |
const TColStd_SequenceOfAsciiString & | UserInfo () const |
return the user informations | |
void | AddToComments (const TCollection_ExtendedString &aComment) |
add <theUserInfo> to the user informations | |
const TColStd_SequenceOfExtendedString & | Comments () const |
return the user informations | |
Standard_Integer | NumberOfObjects () const |
the the number of persistent objects Return: the number of persistent objects readed | |
Standard_Integer | NumberOfRoots () const |
Returns the number of root objects in this set of data. | |
void | AddRoot (const Handle< Standard_Persistent > &anObject) const |
add a persistent root to write. the name of the root is a driver reference number. | |
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. | |
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. | |
Handle_Storage_HSeqOfRoot | Roots () const |
Returns the roots of this set of data in a sequence. | |
Handle_Storage_Root | 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. | |
Standard_Boolean | IsRoot (const TCollection_AsciiString &aName) const |
returns Standard_True if <me> contains a root named <aName> | |
Standard_Integer | NumberOfTypes () const |
Returns the number of types of objects used in this set of data. | |
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. | |
Handle_TColStd_HSequenceOfAsciiString | Types () const |
Gives the list of types of objects used in this set of data in a sequence. |
void Storage_Data::AddRoot | ( | const Handle< Standard_Persistent > & | anObject | ) | const |
void Storage_Data::AddRoot | ( | const TCollection_AsciiString & | aName, |
const Handle< Standard_Persistent > & | anObject | ||
) | const |
void Storage_Data::AddToComments | ( | const TCollection_ExtendedString & | aComment | ) |
void Storage_Data::AddToUserInfo | ( | const TCollection_AsciiString & | anInfo | ) |
Storage_Error Storage_Data::ErrorStatus | ( | ) | const |
Handle_Storage_Root Storage_Data::Find | ( | const TCollection_AsciiString & | aName | ) | const |
Standard_Boolean Storage_Data::IsRoot | ( | const TCollection_AsciiString & | aName | ) | const |
Standard_Boolean Storage_Data::IsType | ( | const TCollection_AsciiString & | aName | ) | const |
Standard_Integer Storage_Data::NumberOfRoots | ( | ) | const |
Standard_Integer Storage_Data::NumberOfTypes | ( | ) | const |
void Storage_Data::RemoveRoot | ( | const TCollection_AsciiString & | aName | ) |
Handle_Storage_HSeqOfRoot Storage_Data::Roots | ( | ) | const |
void Storage_Data::SetApplicationVersion | ( | const TCollection_AsciiString & | aVersion | ) |
Handle_TColStd_HSequenceOfAsciiString Storage_Data::Types | ( | ) | const |