Nitf::TextSegment Class Reference

represents a text segment in an NITF file More...

#include <TextSegment.h>

Inheritance diagram for Nitf::TextSegment:

Nitf::Segment

List of all members.

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
lt_uint8getTextData () const
 get the text data
lt_uint32 getTextDataLength () const
 get the text data length
LT_STATUS addMetadataLocal (LTIMetadataDatabase &db) const


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

LT_STATUS Nitf::TextSegment::initialize (  )  [virtual]

This function must be called immediately after the constructor.

Returns:
success or failure

Reimplemented from 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

LT_STATUS Nitf::TextSegment::addMetadataLocal ( LTIMetadataDatabase db  )  const [virtual]

Implements Nitf::Segment.


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

LizardTech