LizardTech::Nitf::ImageSegmentMetadata Class Reference

container for Image Segment metadata More...

#include <ImageSegmentMetadata.h>

List of all members.

Public Member Functions

 ImageSegmentMetadata ()
 ImageSegmentMetadata (const ImageSegmentMetadata &)
 ~ImageSegmentMetadata ()
ImageSegmentMetadataoperator= (const ImageSegmentMetadata &)
LT_STATUS setIID1 (const char *)
 sets the IID1 field
const char * getIID1 () const
 gets the IID1 field
LT_STATUS setIDATIM (const char *)
 sets the IDATIM field
const char * getIDATIM () const
 gets the IDATIM field
LT_STATUS setTGTID (const char *)
 sets the TGTID field
const char * getTGTID () const
 gets the TGTID field
LT_STATUS setIID2 (const char *)
 sets the IID2 field
const char * getIID2 () const
 gets the IID2 field
LT_STATUS setISORCE (const char *)
 sets the ISORCE field
const char * getISORCE () const
 gets the ISORCE field
LT_STATUS setNICOM (int count)
 sets the number of ICOM fields (NICOM)
LT_STATUS setICOM (int index, const char *data)
 sets an ICOM field
int getNICOM () const
 gets the number of ICOM fields
const char * getICOM (int index) const
 gets an ICOM field

Detailed Description

This class is a container for all the image segment-level metadata for an existing NITF file. It is used with the various NITF image manager, reader, and writer classes.

For details on the length, formatting, etc, of each field, consult the 2500C NITF specification.

Usage Notes:

Definition at line 38 of file ImageSegmentMetadata.h.


Constructor & Destructor Documentation

LizardTech::Nitf::ImageSegmentMetadata::ImageSegmentMetadata (  ) 
LizardTech::Nitf::ImageSegmentMetadata::ImageSegmentMetadata ( const ImageSegmentMetadata  ) 
LizardTech::Nitf::ImageSegmentMetadata::~ImageSegmentMetadata (  ) 

Member Function Documentation

const char* LizardTech::Nitf::ImageSegmentMetadata::getICOM ( int  index  )  const

This function gets an ICOM field.

Parameters:
index the index of the ICOM field to access
Returns:
the ICOM data string
const char* LizardTech::Nitf::ImageSegmentMetadata::getIDATIM (  )  const
const char* LizardTech::Nitf::ImageSegmentMetadata::getIID1 (  )  const
const char* LizardTech::Nitf::ImageSegmentMetadata::getIID2 (  )  const
const char* LizardTech::Nitf::ImageSegmentMetadata::getISORCE (  )  const
int LizardTech::Nitf::ImageSegmentMetadata::getNICOM (  )  const
const char* LizardTech::Nitf::ImageSegmentMetadata::getTGTID (  )  const
ImageSegmentMetadata& LizardTech::Nitf::ImageSegmentMetadata::operator= ( const ImageSegmentMetadata  ) 
LT_STATUS LizardTech::Nitf::ImageSegmentMetadata::setICOM ( int  index,
const char *  data 
)

This function sets an ICOM field.

Parameters:
index the number of ICOM feild to record
data the data contents of the COM field
Returns:
success or failure status code
LT_STATUS LizardTech::Nitf::ImageSegmentMetadata::setIDATIM ( const char *   ) 
LT_STATUS LizardTech::Nitf::ImageSegmentMetadata::setIID1 ( const char *   ) 
LT_STATUS LizardTech::Nitf::ImageSegmentMetadata::setIID2 ( const char *   ) 
LT_STATUS LizardTech::Nitf::ImageSegmentMetadata::setISORCE ( const char *   ) 
LT_STATUS LizardTech::Nitf::ImageSegmentMetadata::setNICOM ( int  count  ) 

This function sets the number of ICOM fields.

Parameters:
count the number of ICOM fields to add
Returns:
success or failure status code
LT_STATUS LizardTech::Nitf::ImageSegmentMetadata::setTGTID ( const char *   ) 

The documentation for this class was generated from the following file:

LizardTech