OSSIM - Open Source Software Image Map  Version 1.9.0 (20180803)
ImageOptionsFileDescriptor.h
Go to the documentation of this file.
1 //----------------------------------------------------------------------------
2 //
3 // "Copyright Centre National d'Etudes Spatiales"
4 //
5 // License: LGPL
6 //
7 // See LICENSE.txt file in the top level directory for more details.
8 //
9 //----------------------------------------------------------------------------
10 // $Id$
11 
12 #ifndef ImageOptionsFileDescriptor_h
13 #define ImageOptionsFileDescriptor_h
14 
15 #include <iostream>
16 
19 
20 namespace ossimplugins
21 {
30 {
31 public:
36 
41 
46 
55 
60 
65  {
66  return new ImageOptionsFileDescriptor();
67  };
68 
73  {
74  return new ImageOptionsFileDescriptor(*this);
75  };
76 
80  void Read(std::istream& is)
81  {
82  is>>*this;
83  };
84 
88  void Write(std::ostream& os)
89  {
90  os<<*this;
91  };
92 
96  void set_nlin(int inNbLines)
97  {
98  _nlin = inNbLines;
99  };
103  std::string get_ascii_flag()
104  {
105  return _ascii_flag;
106  };
107 
111  std::string get_format_doc()
112  {
113  return _format_doc;
114  };
118  std::string get_format_rev()
119  {
120  return _format_rev;
121  };
125  std::string get_design_rev()
126  {
127  return _design_rev;
128  };
132  std::string get_software_id()
133  {
134  return _software_id;
135  };
140  {
141  return _file_num;
142  };
146  std::string get_file_name()
147  {
148  return _file_name;
149  };
153  std::string get_rec_seq()
154  {
155  return _rec_seq;
156  };
161  {
162  return _seq_loc;
163  };
168  {
169  return _seq_len;
170  };
174  std::string get_rec_code()
175  {
176  return _rec_code;
177  };
182  {
183  return _code_loc;
184  };
189  {
190  return _code_len;
191  };
195  std::string get_rec_len()
196  {
197  return _rec_len;
198  };
203  {
204  return _rlen_loc;
205  };
210  {
211  return _rlen_len;
212  };
213 
218  {
219  return _n_dataset;
220  };
225  {
226  return _l_dataset;
227  };
228 
232  int get_nbit()
233  {
234  return _nbit;
235  };
239  int get_nsamp()
240  {
241  return _nsamp;
242  };
246  int get_nbyte()
247  {
248  return _nbyte;
249  };
253  std::string get_justify()
254  {
255  return _justify;
256  };
260  int get_nchn()
261  {
262  return _nchn;
263  };
267  int get_nlin()
268  {
269  return _nlin;
270  };
274  int get_nleft()
275  {
276  return _nleft;
277  };
281  int get_ngrp()
282  {
283  return _ngrp;
284  };
289  {
290  return _nright;
291  };
295  int get_ntop()
296  {
297  return _ntop;
298  };
302  int get_nbott()
303  {
304  return _nbott;
305  };
309  std::string get_intleav()
310  {
311  return _intleav;
312  };
317  {
318  return _nrec_lin;
319  };
324  {
325  return _nrec_chn;
326  };
331  {
332  return _n_prefix;
333  };
337  int get_n_sar()
338  {
339  return _n_sar;
340  };
345  {
346  return _n_suffix;
347  };
348 
352  std::string get_lin_loc()
353  {
354  return _lin_loc;
355  };
359  std::string get_chn_loc()
360  {
361  return _chn_loc;
362  };
366  std::string get_tim_loc()
367  {
368  return _tim_loc;
369  };
373  std::string get_left_loc()
374  {
375  return _left_loc;
376  };
380  std::string get_right_loc()
381  {
382  return _right_loc;
383  };
387  std::string get_pad_ind()
388  {
389  return _pad_ind;
390  };
391 
395  std::string get_qual_loc()
396  {
397  return _qual_loc;
398  };
402  std::string get_cali_loc()
403  {
404  return _cali_loc;
405  };
409  std::string get_gain_loc()
410  {
411  return _gain_loc;
412  };
416  std::string get_bias_loc()
417  {
418  return _bias_loc;
419  };
423  std::string get_type_id()
424  {
425  return _type_id;
426  };
430  std::string get_type_code()
431  {
432  return _type_code;
433  };
438  {
439  return _left_fill;
440  };
445  {
446  return _right_fill;
447  };
452  {
453  return _pix_rng;
454  };
455 
456 protected:
460  std::string _ascii_flag;
461 
465  std::string _format_doc;
469  std::string _format_rev;
473  std::string _design_rev;
477  std::string _software_id;
485  std::string _file_name;
489  std::string _rec_seq;
493  int _seq_loc;
497  int _seq_len;
501  std::string _rec_code;
513  std::string _rec_len;
522 
523 
532 
536  int _nbit;
540  int _nsamp;
544  int _nbyte;
548  std::string _justify;
552  int _nchn;
556  int _nlin;
560  int _nleft;
564  int _ngrp;
568  int _nright;
572  int _ntop;
576  int _nbott;
580  std::string _intleav;
596  int _n_sar;
601 
605  std::string _lin_loc;
609  std::string _chn_loc;
613  std::string _tim_loc;
617  std::string _left_loc;
621  std::string _right_loc;
625  std::string _pad_ind;
626 
630  std::string _qual_loc;
634  std::string _cali_loc;
638  std::string _gain_loc;
642  std::string _bias_loc;
646  std::string _type_id;
650  std::string _type_code;
662  int _pix_rng;
663 
664 private:
665 };
666 }
667 #endif
RadarSatRecord * Instanciate()
This function is able to create a new instance of the class.
std::string get_rec_code()
Record code/location flag
std::string get_format_rev()
Format document revision
std::string _rec_len
Record length/location flag
int _nrec_lin
Number of physical records per line
std::string get_intleav()
Interleave indicator
friend std::ostream & operator<<(std::ostream &os, const ImageOptionsFileDescriptor &data)
This function writes the ImageOptionsFileDescriptor in a stream.
ImageOptionsFileDescriptor & operator=(const ImageOptionsFileDescriptor &rhs)
Copy operator.
void set_nlin(int inNbLines)
Set the number of lines per data set.
int get_n_suffix()
Number of bytes of suffix data per record
std::string get_qual_loc()
Quality code locator
std::string get_design_rev()
File design revision
std::string get_type_id()
Data type identifier
int _n_sar
Number of bytes of SAR data (or pixel data) per record
friend std::istream & operator>>(std::istream &is, ImageOptionsFileDescriptor &data)
This function reads a ImageOptionsFileDescriptor from a stream.
std::string get_bias_loc()
Bias value locator
std::string get_chn_loc()
Channel number locator
int get_n_sar()
Number of bytes of SAR data (or pixel data) per record
std::string get_format_doc()
Format control document
std::string get_right_loc()
Right fill locator
std::string _justify
Sample justification and order
int _n_suffix
Number of bytes of suffix data per record
int get_n_dataset()
Number of SAR data records
std::string get_justify()
Sample justification and order
This class is the base class of all the record classes.
std::string _design_rev
File design revision
std::string get_gain_loc()
Gain value locator
int get_nleft()
Left border pixels per line
std::string _rec_code
Record code/location flag
void Read(std::istream &is)
Reads the class data from a stream.
std::string _rec_seq
Record sequence/location flag
int get_nrec_chn()
Number of physical records per multi-channel line in this file
std::string get_rec_seq()
Record sequence/location flag
std::string _format_doc
Format control document
int get_n_prefix()
Number of bytes of prefix data per record
int get_nrec_lin()
Number of physical records per line
int get_right_fill()
Number of right fill bits
std::string get_cali_loc()
Calibration info locator
int get_nright()
Right border pixels per line
This class is able to read an Image options file descriptor record.
std::string _cali_loc
Calibration info locator
std::basic_istream< char > istream
Base class for char input streams.
Definition: ossimIosFwd.h:20
RadarSatRecord * Clone()
This function is able to create a new instance of the class initialised with the data of the calling ...
int get_ngrp()
Groups per line per channel
std::string get_software_id()
Software identifier
int _n_prefix
Number of bytes of prefix data per record
std::string _chn_loc
Channel number locator
int get_pix_rng()
Maximum data range of pixel
int _nrec_chn
Number of physical records per multi-channel line in this file
void Write(std::ostream &os)
Writes the class to a stream.
std::string get_rec_len()
Record length/location flag
std::string get_pad_ind()
Pad pixel indicator
std::string _format_rev
Format document revision
std::basic_ostream< char > ostream
Base class for char output streams.
Definition: ossimIosFwd.h:23
std::string get_lin_loc()
Line number locator