Open CASCADE Technology  6.5.4
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Static Public Member Functions | Friends
CDM_MetaData Class Reference

#include <CDM_MetaData.hxx>

Inheritance diagram for CDM_MetaData:
Inheritance graph
[legend]

Public Member Functions

Standard_Boolean IsRetrieved () const
Handle_CDM_Document Document () const
TCollection_ExtendedString Folder () const
 returns the folder in which the meta-data has to be created
or has to be found.


TCollection_ExtendedString Name () const
 returns the name under which the meta-data has to be created
or has to be found.


TCollection_ExtendedString Version () const
 returns the version under which the meta-data has to be found.
Warning: raises NoSuchObject from Standard if no Version has been defined

Standard_Boolean HasVersion () const
 indicates that the version has to be taken into account when
searching the corresponding meta-data.

TCollection_ExtendedString FileName () const
Standard_OStreamPrint (Standard_OStream &anOStream) const
Standard_OStreamoperator<< (Standard_OStream &anOStream)
TCollection_ExtendedString Path () const
void UnsetDocument ()
Standard_Boolean IsReadOnly () const
void SetIsReadOnly ()
void UnsetIsReadOnly ()

Static Public Member Functions

static Handle_CDM_MetaData LookUp (const TCollection_ExtendedString &aFolder, const TCollection_ExtendedString &aName, const TCollection_ExtendedString &aPath, const TCollection_ExtendedString &aFileName, const Standard_Boolean ReadOnly)
static Handle_CDM_MetaData LookUp (const TCollection_ExtendedString &aFolder, const TCollection_ExtendedString &aName, const TCollection_ExtendedString &aPath, const TCollection_ExtendedString &aVersion, const TCollection_ExtendedString &aFileName, const Standard_Boolean ReadOnly)

Friends

void CDM_Document::SetMetaData (const Handle< CDM_MetaData > &aMetaData)
 associates database information to a document which
has been stored. The name of the document is now the
name which has beenused to store the data.

void CDM_Application::SetDocumentVersion (const Handle< CDM_Document > &aDocument, const Handle< CDM_MetaData > &aMetaData) const

Member Function Documentation

Handle_CDM_Document CDM_MetaData::Document ( ) const
static Handle_CDM_MetaData CDM_MetaData::LookUp ( const TCollection_ExtendedString aFolder,
const TCollection_ExtendedString aName,
const TCollection_ExtendedString aPath,
const TCollection_ExtendedString aFileName,
const Standard_Boolean  ReadOnly 
) [static]
static Handle_CDM_MetaData CDM_MetaData::LookUp ( const TCollection_ExtendedString aFolder,
const TCollection_ExtendedString aName,
const TCollection_ExtendedString aPath,
const TCollection_ExtendedString aVersion,
const TCollection_ExtendedString aFileName,
const Standard_Boolean  ReadOnly 
) [static]
Standard_OStream& CDM_MetaData::operator<< ( Standard_OStream anOStream)

Friends And Related Function Documentation

void CDM_Application::SetDocumentVersion ( const Handle< CDM_Document > &  aDocument,
const Handle< CDM_MetaData > &  aMetaData 
) const [friend]
void CDM_Document::SetMetaData ( const Handle< CDM_MetaData > &  aMetaData) [friend]

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