core/vil/file_formats/vil_nitf2.h

Go to the documentation of this file.

// vil_nitf2: Written by Rob Radtke (rob@) and Harry Voorhees (hlv@) of
// Stellar Science Ltd. Co. (stellarscience.com) for
// Air Force Research Laboratory, 2005.

#ifndef VIL_NITF2_H
#define VIL_NITF2_H

#include <vil/vil_stream.h>

// These typedefs serve to maintain the method signatures' distinction between
// input and output streams, at least until we decide that such distinction is
// no longer useful.
typedef vil_stream vil_nitf2_istream;
typedef vil_stream vil_nitf2_ostream;

// Some of the integer values stored in nitf 2.x headers can be
// larger than 2^32.  That's why we have vil_nitf2_long_long_formatter.
// We use this typedef so systems that don't have 64 bit integers 
// can still use the class.  Of course they will break if they try to
// read a header that contains a value greater than 2^32.  Fortunately,
// that is somewhat rare.
#include <vxl_config.h>
#if VXL_HAS_INT_64
typedef vxl_int_64 vil_nitf2_long;
#else
typedef vxl_int_32 vil_nitf2_long;
#endif

// Wrapper class for shared enums and static variables, to avoid circular
// dependencies among classes
//
class vil_nitf2
{
 public:
  // NITF field data types supported
  enum enum_field_type { type_undefined=0,
                         type_int, type_long_long, type_double,
                         type_char, type_string, type_binary,
                         type_location, type_date_time, 
                         type_tagged_record_sequence };

  // Controls the level of detail of logging to vcl_cout.
  // All errors are logged to vcl_cerr, irrespective of log level.
  enum enum_log_level { log_none=0, log_info, log_debug };

  // Logging level for all vil_nitf classes. This could be generalized to an
  // array, if different subsets of classes want their own logging levels.
  static enum_log_level s_log_level;
  /**
    * Call this function to flush all of the nitf2 classes statically
    * allocated memory.  Usually, you'd want to do this just before
    * your application terminates or after you're done using vil_nitf2 
    * related classes.  It's not a big deal if you call it too early (or often), 
    * the vil_nitf2 classes are smart enough to re-generate these members if
    * they are needed later
    */
  static void cleanup_static_members();
};




#define VIL_NITF2_LOG(LEVEL) \
  if (vil_nitf2::s_log_level < vil_nitf2::LEVEL) ; else vcl_cout

#endif // VIL_NITF2_H