source: trunk/components/bio-formats-auto/src/ice/bio-formats.vm @ 4953

Revision 4953, 5.4 KB checked in by melissa, 11 years ago (diff)

Switched licenses from GPL v3 or later to GPL v2 or later.

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 MetadataRetrieve;
44  interface MetadataStore;
45
46  interface IFormatReader {
47    void setId(string id);
48
49    void setRetrieveAsStore(MetadataRetrieve* retrieve);
50    //const int MUST_GROUP = 0;
51    //const int CAN_GROUP = 1;
52    //const int CANNOT_GROUP = 2;
53
54    bool isThisType(string name, bool open);
55    //bool isThisType2(ByteSeq block);
56    int getImageCount();
57    bool isRGB();
58    int getSizeX();
59    int getSizeY();
60    int getSizeZ();
61    int getSizeC();
62    int getSizeT();
63    int getPixelType();
64    int getEffectiveSizeC();
65    int getRGBChannelCount();
66    bool isIndexed();
67    bool isFalseColor();
68    ByteByteSeq get8BitLookupTable();
69    ShortShortSeq get16BitLookupTable();
70    IntSeq getChannelDimLengths();
71    StringSeq getChannelDimTypes();
72    int getThumbSizeX();
73    int getThumbSizeY();
74    bool isLittleEndian();
75    string getDimensionOrder();
76    bool isOrderCertain();
77    bool isInterleaved();
78    bool isInterleavedSubC(int subC);
79    //ByteSeq openBytes1(int no);
80    ByteSeq openBytes(int no, int x, int y, int width, int height);
81    //ByteSeq openBytes3(int no, ByteSeq buf);
82    //ByteSeq openBytes4(int no, ByteSeq buf,
83    //  int x, int y, int width, int height);
84    ByteSeq openThumbBytes(int no);
85    void closeFile(bool fileOnly);
86    string getFormat();
87    StringSeq getSuffixes();
88    void close();
89    int getSeriesCount();
90    void setSeries(int no);
91    int getSeries();
92    void setNormalized(bool normalize);
93    bool isNormalized();
94    void setMetadataCollected(bool collect);
95    bool isMetadataCollected();
96    void setOriginalMetadataPopulated(bool populate);
97    bool isOriginalMetadataPopulated();
98    void setGroupFiles(bool group);
99    bool isGroupFiles();
100    bool isMetadataComplete();
101    int fileGroupOption(string id);
102    StringSeq getUsedFiles();
103    string getCurrentFile();
104    int getIndex(int z, int c, int t);
105    IntSeq getZCTCoords(int index);
106    //Object getMetadataValue(string field);
107    //Hashtable getMetadata();
108    //CoreMetadata getCoreMetadata();
109    void setMetadataFiltered(bool filter);
110    bool isMetadataFiltered();
111    void setMetadataStore(MetadataStore* store);
112    //MetadataStore* getMetadataStore();
113    //Object getMetadataStoreRoot();
114    //IFormatReader[] getUnderlyingReaders();
115  };
116
117  interface IFormatWriter {
118    void setId(string id);
119    void setStoreAsRetrieve(MetadataStore* store);
120    void close();
121    void saveBytes1(ByteSeq bytes, bool last);
122    void saveBytes2(ByteSeq bytes, int series, bool lastInSeries, bool last);
123    bool canDoStacks();
124    void setMetadataRetrieve(MetadataRetrieve* r);
125    MetadataRetrieve getMetadataRetrieve();
126    void setFramesPerSecond(int rate);
127    int getFramesPerSecond();
128    StringSeq getCompressionTypes();
129    IntSeq getPixelTypes();
130    bool isSupportedType(int type);
131    void setCompression(string compress);
132    bool isThisType(string name);
133    string getFormat();
134    StringSeq getSuffixes();
135  };
136
137  interface MetadataStore {
138    MetadataStore getServant();
139    string getOMEXML();
140
141    void createRoot();
142    //void setRoot(Object root);
143    //Object getRoot();
144
145    // - Entity storage -
146
147    void setUUID(string uuid);
148#foreach ($entity in $q.entities())
149#set ($dummy = $q.setEntity($entity))
150
151    // - $entity property storage -
152#foreach ($prop in $q.props())
153#set ($dummy = $q.setProperty($prop))
154    void set$entity$prop($q.ice($q.type()) $q.var($prop), $q.argsList());
155#end##foreach $prop
156#end##foreach $entity
157  };
158
159  interface MetadataRetrieve {
160    MetadataRetrieve getServant();
161    string getOMEXML();
162
163    // - Entity counting -
164
165#foreach ($entity in $q.entities())
166#set ($dummy = $q.setEntity($entity))
167#if ($q.countable())
168    int get${entity}Count($q.argsList($q.chop()));
169#end###if countable
170#end##foreach $entity
171
172    // - Entity retrieval -
173
174    string getUUID();
175#foreach ($entity in $q.entities())
176#set ($dummy = $q.setEntity($entity))
177
178    // - $entity property retrieval -
179
180#foreach ($prop in $q.props())
181#set ($dummy = $q.setProperty($prop))
182    $q.ice($q.type()) get$entity$prop($q.argsList());
183#end##foreach $prop
184#end##foreach $entity
185  };
186};
Note: See TracBrowser for help on using the repository browser.