Nitf::TextSegment Class Reference
represents a text segment in an NITF file More...
#include <TextSegment.h>
Inheritance diagram for Nitf::TextSegment:
Public Member Functions | |
| TextSegment (NITFReaderManager &, LTIOStreamInf &, int segmentNumber, lt_int64 headerOffset, lt_int64 headerLength, lt_int64 dataOffset, lt_int64 dataLength) | |
| ~TextSegment () | |
| LT_STATUS | initialize () |
| initializer More... | |
| lt_uint8 * | getTextData () const |
| get the text data More... | |
| lt_uint32 | getTextDataLength () const |
| get the text data length More... | |
| LT_STATUS | addMetadataLocal (LTIMetadataDatabase &db) const |
 Public Member Functions inherited from Nitf::Segment | |
| Segment (NITFReaderManager &, LTIOStreamInf &, lt_int64 headerOffset, lt_int64 headerLength, lt_int64 dataOffset, lt_int64 dataLength, const char *code, int segmentNumber, bool doUserSubheader, bool doExtendedSubheader) | |
| virtual | ~Segment () |
| int | getSegmentNumber () const |
| const char * | getSegmentID () |
| lt_int64 | getHeaderOffset () const |
| lt_int64 | getHeaderLength () const |
| lt_int64 | getDataOffset () const |
| lt_int64 | getDataLength () const |
| const SecurityBlock * | getSecurityBlock () const |
| const SecurityMetadata * | getSecurityMetadata () const |
| returns the security information about the segment More... | |
| virtual LT_STATUS | addMetadata (LTIMetadataDatabase &) const |
| const char * | getMetadataTagPrefix () const |
| int | getNumTREs () const |
| returns the number of TREs in this segment More... | |
| const TREData * | getTRE (int index) const |
| TRE accessor. More... | |
Additional Inherited Members | |
| Protected Attributes inherited from Nitf::Segment | |
| MetadataHelper * | m_mdHelper |
| FieldReader * | m_field |
| LTIOStreamInf & | m_stream |
| const lt_int64 | m_headerOffset |
| lt_int64 | m_headerLength |
| const lt_int64 | m_dataOffset |
| const lt_int64 | m_dataLength |
| NITFReaderManager & | m_manager |
| Version | m_version |
| SecurityBlock * | m_securityBlock |
| const int | m_segmentNumber |
| const char * | m_segmentID |
Detailed Description
This class represents a text segment in an existing NITF file. To access the text segment of a file, retrieve the TextSegment from the NITFReaderManager class.
Definition at line 36 of file TextSegment.h.
Constructor & Destructor Documentation
| Nitf::TextSegment::TextSegment | ( | NITFReaderManager & | , |
| LTIOStreamInf & | , | ||
| int | segmentNumber, | ||
| lt_int64 | headerOffset, | ||
| lt_int64 | headerLength, | ||
| lt_int64 | dataOffset, | ||
| lt_int64 | dataLength | ||
| ) |
| Nitf::TextSegment::~TextSegment | ( | ) |
Member Function Documentation
|
virtual |
Implements Nitf::Segment.
| lt_uint8* Nitf::TextSegment::getTextData | ( | ) | const |
This function returns the textual data stored in the text segment.
- Returns
- the text data
| lt_uint32 Nitf::TextSegment::getTextDataLength | ( | ) | const |
This function returns the length (in bytes) of the textual data stored in the text segment.
- Returns
- the text data
|
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: