src/CDM/CDM_MetaData.cdl

   1 -- Created on: 1997-10-22
   2 -- Created by: Jean-Louis Frenkel
   3 -- Copyright (c) 1997-1999 Matra Datavision
   4 -- Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 --
   6 -- This file is part of Open CASCADE Technology software library.
   7 --
   8 -- This library is free software; you can redistribute it and/or modify it under
   9 -- the terms of the GNU Lesser General Public License version 2.1 as published
  10 -- by the Free Software Foundation, with special exception defined in the file
  11 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 -- distribution for complete text of the license and disclaimer of any warranty.
  13 --
  14 -- Alternatively, this file may be used under the terms of Open CASCADE
  15 -- commercial license or contractual agreement.
  16
  17 class MetaData from CDM inherits Transient from Standard
  18
  19 uses ExtendedString from TCollection,Document from CDM,MetaDataLookUpTable from CDM, DocumentPointer from CDM,
  20 Application from CDM
  21 raises NoSuchObject from Standard
  22
  23 is
  24
  25     Create(aFolder,aName, aPath: ExtendedString from TCollection;
  26            aFileName: ExtendedString from TCollection; ReadOnly:Boolean from Standard)
  27     returns  MetaData from CDM is private;
  28
  29     Create(aFolder,aName, aPath, aVersion: ExtendedString from TCollection;
  30            aFileName: ExtendedString from TCollection; ReadOnly:Boolean from Standard)
  31     returns  MetaData from CDM is private;
  32
  33
  34
  35     LookUp(myclass; aFolder,aName, aPath: ExtendedString from TCollection;
  36            aFileName: ExtendedString from TCollection; ReadOnly:Boolean from Standard)
  37     returns  MetaData from CDM;
  38
  39     LookUp(myclass; aFolder,aName, aPath, aVersion: ExtendedString from TCollection; aFileName: ExtendedString from TCollection; ReadOnly:Boolean from Standard)
  40     returns  MetaData from CDM;
  41
  42
  43
  44
  45     IsRetrieved(me) returns Boolean from Standard;
  46
  47     Document(me) returns Document from CDM;
  48
  49     Folder(me) returns ExtendedString from TCollection;
  50     ---Purpose: returns the folder in which the meta-data has to be created
  51     --          or has to be found.
  52     --
  53     Name(me) returns ExtendedString from TCollection;
  54     ---Purpose: returns the name under which the meta-data has to be created
  55     --          or has to be found.
  56     --
  57
  58     Version(me) returns ExtendedString from TCollection
  59     ---Purpose: returns the version under which the meta-data has to be found.
  60     -- Warning: raises NoSuchObject from Standard if no Version has been defined
  61
  62     raises NoSuchObject from Standard;
  63
  64     HasVersion(me) returns Boolean from Standard;
  65     ---Purpose: indicates that the version has to be taken into account when
  66     --          searching the corresponding meta-data.
  67
  68     FileName(me) returns ExtendedString from TCollection;
  69     ---Category: programming facility
  70     --
  71     Print(me; anOStream:  in out OStream from Standard)
  72     returns OStream from Standard;
  73     ---C++: return &
  74     ---C++: alias "Standard_OStream& operator << (Standard_OStream& anOStream);"
  75     --
  76
  77     Path(me) returns ExtendedString from TCollection;
  78
  79
  80     ---Category: methods to modify the metadata.
  81     --
  82     SetDocument(me: mutable; aDocument: Document from CDM)
  83     is private;
  84
  85     UnsetDocument(me: mutable);
  86
  87     LookUpTable(myclass) returns MetaDataLookUpTable from CDM
  88     is private;
  89     ---C++: return const&
  90     --
  91     DocumentVersion(me: mutable; anApplication: Application from CDM) returns Integer from Standard
  92     is private;
  93
  94     IsReadOnly(me) returns Boolean from Standard;
  95
  96     SetIsReadOnly(me: mutable);
  97
  98     UnsetIsReadOnly(me: mutable);
  99
 100 fields
 101     myIsRetrieved: Boolean from Standard;
 102     myDocument: DocumentPointer from CDM;
 103     myFolder: ExtendedString from TCollection;
 104     myName: ExtendedString from TCollection;
 105
 106     myVersion: ExtendedString from TCollection;
 107     myHasVersion: Boolean from Standard;
 108
 109     myFileName: ExtendedString from TCollection;
 110     myPath: ExtendedString from TCollection;
 111
 112
 113     myDocumentVersion: Integer from Standard;
 114
 115     myIsReadOnly: Boolean from Standard;
 116
 117  friends SetMetaData from class Document from CDM(me: mutable; aMetaData: MetaData from CDM),
 118         class Reference from CDM,
 119         SetDocumentVersion from class Application from CDM(me; aDocument: Document from CDM; aMetaData: MetaData from CDM)
 120 end MetaData from CDM;