Open CASCADE Technology  7.4.1.dev
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_DocumentDocument () const
 
TCollection_ExtendedString Folder () const
 returns the folder in which the meta-data has to be created or has to be found. More...
 
TCollection_ExtendedString Name () const
 returns the name under which the meta-data has to be created or has to be found. More...
 
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 More...
 
Standard_Boolean HasVersion () const
 indicates that the version has to be taken into account when searching the corresponding meta-data. More...
 
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 ()
 
void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const
 Dumps the content of me into the stream. More...
 
- 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...
 

Static Public Member Functions

static Handle< CDM_MetaDataLookUp (const TCollection_ExtendedString &aFolder, const TCollection_ExtendedString &aName, const TCollection_ExtendedString &aPath, const TCollection_ExtendedString &aFileName, const Standard_Boolean ReadOnly)
 
static Handle< CDM_MetaDataLookUp (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 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...
 

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. More...
 
void CDM_Application::SetDocumentVersion (const Handle< CDM_Document > &aDocument, const Handle< CDM_MetaData > &aMetaData) const
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 

Member Function Documentation

◆ Document()

Handle< CDM_Document > CDM_MetaData::Document ( ) const

◆ DumpJson()

void CDM_MetaData::DumpJson ( Standard_OStream theOStream,
Standard_Integer  theDepth = -1 
) const

Dumps the content of me into the stream.

◆ FileName()

TCollection_ExtendedString CDM_MetaData::FileName ( ) const

◆ Folder()

TCollection_ExtendedString CDM_MetaData::Folder ( ) const

returns the folder in which the meta-data has to be created or has to be found.

◆ HasVersion()

Standard_Boolean CDM_MetaData::HasVersion ( ) const

indicates that the version has to be taken into account when searching the corresponding meta-data.

◆ IsReadOnly()

Standard_Boolean CDM_MetaData::IsReadOnly ( ) const

◆ IsRetrieved()

Standard_Boolean CDM_MetaData::IsRetrieved ( ) const

◆ LookUp() [1/2]

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

◆ LookUp() [2/2]

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

◆ Name()

TCollection_ExtendedString CDM_MetaData::Name ( ) const

returns the name under which the meta-data has to be created or has to be found.

◆ operator<<()

Standard_OStream& CDM_MetaData::operator<< ( Standard_OStream anOStream)

◆ Path()

TCollection_ExtendedString CDM_MetaData::Path ( ) const

◆ Print()

Standard_OStream& CDM_MetaData::Print ( Standard_OStream anOStream) const

◆ SetIsReadOnly()

void CDM_MetaData::SetIsReadOnly ( )

◆ UnsetDocument()

void CDM_MetaData::UnsetDocument ( )

◆ UnsetIsReadOnly()

void CDM_MetaData::UnsetIsReadOnly ( )

◆ Version()

TCollection_ExtendedString CDM_MetaData::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

Friends And Related Function Documentation

◆ CDM_Application::SetDocumentVersion

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

◆ CDM_Document::SetMetaData

void CDM_Document::SetMetaData ( const Handle< CDM_MetaData > &  aMetaData)
friend

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.


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