source: branches/maven/projects/autogen/src/main/resources/ice/bio-formats.vm @ 5490

Revision 5490, 5.2 KB checked in by curtis, 10 years ago (diff)

Combine MetadataStore and MetadataRetrieve Ice interfaces into one IMetadata.

Line 
1//
2// bio-formats.ice
3//
4
5/*
6OME Bio-Formats package for reading and converting biological file formats.
7Copyright (C) 2005-@year@ UW-Madison LOCI and Glencoe Software, Inc.
8
9This program is free software; you can redistribute it and/or modify
10it under the terms of the GNU General Public License as published by
11the Free Software Foundation; either version 2 of the License, or
12(at your option) any later version.
13
14This program is distributed in the hope that it will be useful,
15but WITHOUT ANY WARRANTY; without even the implied warranty of
16MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17GNU General Public License for more details.
18
19You should have received a copy of the GNU General Public License
20along with this program; if not, write to the Free Software
21Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
22*/
23
24/*-----------------------------------------------------------------------------
25 *
26 * THIS IS AUTOMATICALLY GENERATED CODE.  DO NOT MODIFY.
27 * Created by $user via MetadataAutogen on $timestamp
28 *
29 *-----------------------------------------------------------------------------
30 */
31
32[["java:package:loci.ice"]]
33
34module formats {
35
36  sequence<byte> ByteSeq;
37  sequence<ByteSeq> ByteByteSeq;
38  sequence<short> ShortSeq;
39  sequence<ShortSeq> ShortShortSeq;
40  sequence<int> IntSeq;
41  sequence<string> StringSeq;
42
43  interface IMetadata;
44
45  interface IFormatReader {
46    void setId(string id);
47
48    //const int MUST_GROUP = 0;
49    //const int CAN_GROUP = 1;
50    //const int CANNOT_GROUP = 2;
51
52    bool isThisType(string name, bool open);
53    //bool isThisType2(ByteSeq block);
54    int getImageCount();
55    bool isRGB();
56    int getSizeX();
57    int getSizeY();
58    int getSizeZ();
59    int getSizeC();
60    int getSizeT();
61    int getPixelType();
62    int getEffectiveSizeC();
63    int getRGBChannelCount();
64    bool isIndexed();
65    bool isFalseColor();
66    ByteByteSeq get8BitLookupTable();
67    ShortShortSeq get16BitLookupTable();
68    IntSeq getChannelDimLengths();
69    StringSeq getChannelDimTypes();
70    int getThumbSizeX();
71    int getThumbSizeY();
72    bool isLittleEndian();
73    string getDimensionOrder();
74    bool isOrderCertain();
75    bool isInterleaved();
76    bool isInterleavedSubC(int subC);
77    //ByteSeq openBytes1(int no);
78    ByteSeq openBytes(int no, int x, int y, int width, int height);
79    //ByteSeq openBytes3(int no, ByteSeq buf);
80    //ByteSeq openBytes4(int no, ByteSeq buf,
81    //  int x, int y, int width, int height);
82    ByteSeq openThumbBytes(int no);
83    void closeFile(bool fileOnly);
84    string getFormat();
85    StringSeq getSuffixes();
86    void close();
87    int getSeriesCount();
88    void setSeries(int no);
89    int getSeries();
90    void setNormalized(bool normalize);
91    bool isNormalized();
92    void setMetadataCollected(bool collect);
93    bool isMetadataCollected();
94    void setOriginalMetadataPopulated(bool populate);
95    bool isOriginalMetadataPopulated();
96    void setGroupFiles(bool group);
97    bool isGroupFiles();
98    bool isMetadataComplete();
99    int fileGroupOption(string id);
100    StringSeq getUsedFiles();
101    string getCurrentFile();
102    int getIndex(int z, int c, int t);
103    IntSeq getZCTCoords(int index);
104    //Object getMetadataValue(string field);
105    //Hashtable getMetadata();
106    //CoreMetadata getCoreMetadata();
107    void setMetadataFiltered(bool filter);
108    bool isMetadataFiltered();
109    void setMetadataStore(IMetadata* store);
110    //IMetadata* getMetadataStore();
111    //Object getMetadataStoreRoot();
112    //IFormatReader[] getUnderlyingReaders();
113  };
114
115  interface IFormatWriter {
116    void setId(string id);
117    void close();
118    void saveBytes1(ByteSeq bytes, bool last);
119    void saveBytes2(ByteSeq bytes, int series, bool lastInSeries, bool last);
120    bool canDoStacks();
121    void setMetadataRetrieve(IMetadata* r);
122    IMetadata getMetadataRetrieve();
123    void setFramesPerSecond(int rate);
124    int getFramesPerSecond();
125    StringSeq getCompressionTypes();
126    IntSeq getPixelTypes();
127    bool isSupportedType(int type);
128    void setCompression(string compress);
129    bool isThisType(string name);
130    string getFormat();
131    StringSeq getSuffixes();
132  };
133
134  interface IMetadata {
135    // -- MetadataRetrieve methods --
136
137    string getOMEXML();
138
139    // - Entity counting -
140
141#foreach ($entity in $q.entities())
142#set ($dummy = $q.setEntity($entity))
143#if ($q.countable())
144    int get${entity}Count($q.argsList($q.chop()));
145#end###if countable
146#end##foreach $entity
147
148    // - Entity retrieval -
149
150    string getUUID();
151#foreach ($entity in $q.entities())
152#set ($dummy = $q.setEntity($entity))
153
154    // - $entity property retrieval -
155
156#foreach ($prop in $q.props())
157#set ($dummy = $q.setProperty($prop))
158    $q.ice($q.type()) get$entity$prop($q.argsList());
159#end##foreach $prop
160#end##foreach $entity
161
162    // -- MetadataStore methods --
163
164    void createRoot();
165    //void setRoot(Object root);
166    //Object getRoot();
167
168    // - Entity storage -
169
170    void setUUID(string uuid);
171#foreach ($entity in $q.entities())
172#set ($dummy = $q.setEntity($entity))
173
174    // - $entity property storage -
175#foreach ($prop in $q.props())
176#set ($dummy = $q.setProperty($prop))
177    void set$entity$prop($q.ice($q.type()) $q.var($prop), $q.argsList());
178#end##foreach $prop
179#end##foreach $entity
180  };
181};
Note: See TracBrowser for help on using the repository browser.