represents the file header properties of a NITF file More...
#include <FileHeader.h>
Public Member Functions | |
| FileHeader (NITFReaderManager &, LTIOStreamInf &, lt_int64 fileSize) | |
| ~FileHeader () | |
| LT_STATUS | initialize () |
| initializer | |
| Version | getVersion () const |
| returns the version of the file | |
| LT_STATUS | createSegments (ImageSegment **&imageSegments, lt_uint32 &numImageSegments, GraphicSegment **&graphicSegments, lt_uint32 &numGraphicSegments, LabelSegment **&labelSegments, lt_uint32 &numLabelSegments, TextSegment **&textSegments, lt_uint32 &numTextSegments, DataSegment **&dataSegments, lt_uint32 &numDataSegments, ReservedSegment **&resSegments, lt_uint32 &numResSegments) |
| LT_STATUS | addMetadataLocal (LTIMetadataDatabase &db) const |
| const lt_uint8 * | getFBKGC () const |
| returns the background pixel for the overall file | |
| const FileMetadata * | getFileMetadata () const |
| returns the object holding the file metadata | |
Detailed Description
This class represents the file header properties of an NITF file. To access the file header of a file, retrieve the FileHeader from the NITFReaderManager class. The actual properties are available from the FileMetadata class obtained from this object.
Definition at line 41 of file FileHeader.h.
Constructor & Destructor Documentation
| Nitf::FileHeader::FileHeader | ( | NITFReaderManager & | , |
| LTIOStreamInf & | , | ||
| lt_int64 | fileSize | ||
| ) |
Member Function Documentation
| LT_STATUS Nitf::FileHeader::addMetadataLocal | ( | LTIMetadataDatabase & | db | ) | const [virtual] |
Implements Nitf::Segment.
| LT_STATUS Nitf::FileHeader::createSegments | ( | ImageSegment **& | imageSegments, |
| lt_uint32 & | numImageSegments, | ||
| GraphicSegment **& | graphicSegments, | ||
| lt_uint32 & | numGraphicSegments, | ||
| LabelSegment **& | labelSegments, | ||
| lt_uint32 & | numLabelSegments, | ||
| TextSegment **& | textSegments, | ||
| lt_uint32 & | numTextSegments, | ||
| DataSegment **& | dataSegments, | ||
| lt_uint32 & | numDataSegments, | ||
| ReservedSegment **& | resSegments, | ||
| lt_uint32 & | numResSegments | ||
| ) |
| const lt_uint8* Nitf::FileHeader::getFBKGC | ( | ) | const |
This function returns the background pixel, as stored in the the FBKGC field. It consists of three values (R, G, B) with a range of 0 to 255.
- Returns:
- the RGB pixel values
| const FileMetadata* Nitf::FileHeader::getFileMetadata | ( | ) | const |
This function returns an object holding the basic file metadata.
- Returns:
- the file metadata object
| Version Nitf::FileHeader::getVersion | ( | ) | const |
This function returns the version NITF specifcation the file conforms to.
- Returns:
- the version of the file
| LT_STATUS Nitf::FileHeader::initialize | ( | ) | [virtual] |
This function must be called immediately after the constructor.
- Returns:
- success or failure
Reimplemented from Nitf::Segment.
The documentation for this class was generated from the following file: