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-2012 OPEN CASCADE SAS
   5 --
   6 -- The content of this file is subject to the Open CASCADE Technology Public
   7 -- License Version 6.5 (the "License"). You may not use the content of this file
   8 -- except in compliance with the License. Please obtain a copy of the License
   9 -- at http://www.opencascade.org and read it completely before using this file.
  10 --
  11 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
  12 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
  13 --
  14 -- The Original Code and all software distributed under the License is
  15 -- distributed on an "AS IS" basis, without warranty of any kind, and the
  16 -- Initial Developer hereby disclaims all such warranties, including without
  17 -- limitation, any warranties of merchantability, fitness for a particular
  18 -- purpose or non-infringement. Please see the License for the specific terms
  19 -- and conditions governing the rights and limitations under the License.
  20
  21
  22 class MetaData from CDM inherits Transient from Standard
  23
  24 uses ExtendedString from TCollection,Document from CDM,MetaDataLookUpTable from CDM, DocumentPointer from CDM,
  25 Application from CDM
  26 raises NoSuchObject from Standard
  27
  28 is
  29
  30     Create(aFolder,aName, aPath: ExtendedString from TCollection;
  31            aFileName: ExtendedString from TCollection; ReadOnly:Boolean from Standard)
  32     returns  MetaData from CDM is private;
  33
  34     Create(aFolder,aName, aPath, aVersion: ExtendedString from TCollection;
  35            aFileName: ExtendedString from TCollection; ReadOnly:Boolean from Standard)
  36     returns  MetaData from CDM is private;
  37
  38
  39
  40     LookUp(myclass; aFolder,aName, aPath: ExtendedString from TCollection;
  41            aFileName: ExtendedString from TCollection; ReadOnly:Boolean from Standard)
  42     returns  MetaData from CDM;
  43
  44     LookUp(myclass; aFolder,aName, aPath, aVersion: ExtendedString from TCollection; aFileName: ExtendedString from TCollection; ReadOnly:Boolean from Standard)
  45     returns  MetaData from CDM;
  46
  47
  48
  49
  50     IsRetrieved(me) returns Boolean from Standard;
  51
  52     Document(me) returns Document from CDM;
  53
  54     Folder(me) returns ExtendedString from TCollection;
  55     ---Purpose: returns the folder in which the meta-data has to be created
  56     --          or has to be found.
  57     --
  58     Name(me) returns ExtendedString from TCollection;
  59     ---Purpose: returns the name under which the meta-data has to be created
  60     --          or has to be found.
  61     --
  62
  63     Version(me) returns ExtendedString from TCollection
  64     ---Purpose: returns the version under which the meta-data has to be found.
  65     -- Warning: raises NoSuchObject from Standard if no Version has been defined
  66
  67     raises NoSuchObject from Standard;
  68
  69     HasVersion(me) returns Boolean from Standard;
  70     ---Purpose: indicates that the version has to be taken into account when
  71     --          searching the corresponding meta-data.
  72
  73     FileName(me) returns ExtendedString from TCollection;
  74     ---Category: programming facility
  75     --
  76     Print(me; anOStream:  in out OStream from Standard)
  77     returns OStream from Standard;
  78     ---C++: return &
  79     ---C++: alias "Standard_OStream& operator << (Standard_OStream& anOStream);"
  80     --
  81
  82     Path(me) returns ExtendedString from TCollection;
  83
  84
  85     ---Category: methods to modify the metadata.
  86     --
  87     SetDocument(me: mutable; aDocument: Document from CDM)
  88     is private;
  89
  90     UnsetDocument(me: mutable);
  91
  92     LookUpTable(myclass) returns MetaDataLookUpTable from CDM
  93     is private;
  94     ---C++: return const&
  95     --
  96     DocumentVersion(me: mutable; anApplication: Application from CDM) returns Integer from Standard
  97     is private;
  98
  99     IsReadOnly(me) returns Boolean from Standard;
 100
 101     SetIsReadOnly(me: mutable);
 102
 103     UnsetIsReadOnly(me: mutable);
 104
 105 fields
 106     myIsRetrieved: Boolean from Standard;
 107     myDocument: DocumentPointer from CDM;
 108     myFolder: ExtendedString from TCollection;
 109     myName: ExtendedString from TCollection;
 110
 111     myVersion: ExtendedString from TCollection;
 112     myHasVersion: Boolean from Standard;
 113
 114     myFileName: ExtendedString from TCollection;
 115     myPath: ExtendedString from TCollection;
 116
 117
 118     myDocumentVersion: Integer from Standard;
 119
 120     myIsReadOnly: Boolean from Standard;
 121
 122  friends SetMetaData from class Document from CDM(me: mutable; aMetaData: MetaData from CDM),
 123         class Reference from CDM,
 124         SetDocumentVersion from class Application from CDM(me; aDocument: Document from CDM; aMetaData: MetaData from CDM)
 125 end MetaData from CDM;