Nitf::TrePlugInResource Class Reference

This is a Resource class for TRE parser plug-ins. More...

#include <NitfMetadataParsing.h>

Inheritance diagram for Nitf::TrePlugInResource:

List of all members.

Public Member Functions
	TrePlugInResource (std::string plugInName)
	TrePlugInResource ()
bool	parseTag (const ossimNitfRegisteredTag &input, DynamicObject &output, RasterDataDescriptor &descriptor, std::string &errorMessage) const
bool	writeTag (const DynamicObject &input, const ossim_uint32 &ownerIndex, const ossimString &tagType, ossimNitfWriter &writer, std::string &errorMessage) const
bool	exportMetadata (const RasterDataDescriptor &descriptor, const RasterFileDescriptor &exportDescriptor, ossimNitfWriter &writer, std::string &errorMessage) const

---

Detailed Description

This is a Resource class for TRE parser plug-ins.

See also:

TreParserShell

Definition at line 43 of file NitfMetadataParsing.h.

---

Constructor & Destructor Documentation

Nitf::TrePlugInResource::TrePlugInResource

(

std::string

plugInName

)

Construct an object to represent a TRE parser.

Parameters:

plugInName

The name of the plug-in to construct.

Definition at line 52 of file NitfMetadataParsing.h.

Nitf::TrePlugInResource::TrePlugInResource

(

)

Destruct the TRE parser plug-in.

Definition at line 58 of file NitfMetadataParsing.h.

---

Member Function Documentation

bool Nitf::TrePlugInResource::parseTag	(	const ossimNitfRegisteredTag &	input,
		DynamicObject &	output,
		RasterDataDescriptor &	descriptor,
		std::string &	errorMessage
	)			const

Parse a TRE and store it in a DynamicObject and RasterDataDescriptor.

Parameters:

	input	The ossimNitfRegisteredTag to read from.
	output	The DynamicObject to write to.
	descriptor	The RasterDataDescriptor which should be updated.
	errorMessage	If this is modified by the function, it will be displayed to the user as a warning that imported TREs might be incomplete, missing, etc.

Returns:

True on success, false otherwise.

bool Nitf::TrePlugInResource::writeTag	(	const DynamicObject &	input,
		const ossim_uint32 &	ownerIndex,
		const ossimString &	tagType,
		ossimNitfWriter &	writer,
		std::string &	errorMessage
	)			const

Parse a TRE from a DynamicObject and store it in writer.

Parameters:

	input	The DynamicObject to read from.
	ownerIndex	The index of the owner in writer.
	tagType	The type of tag in writer.
	writer	The ossimNitfWriter to write to.
	errorMessage	Message that exported TREs might be incomplete, missing, etc.

Returns:

True on success or if the TRE was excluded from export, false otherwise.

bool Nitf::TrePlugInResource::exportMetadata	(	const RasterDataDescriptor &	descriptor,
		const RasterFileDescriptor &	exportDescriptor,
		ossimNitfWriter &	writer,
		std::string &	errorMessage
	)			const

Exports TRE metadata.

Parameters:

	descriptor	The RasterDataDescriptor to read from.
	exportDescriptor	The RasterDataDescriptor to write to.
	writer	The ossimNitfWriter to write to.
	errorMessage	Message that exported TREs might be incomplete, missing, etc.

Returns:

True on success or if the TRE was excluded from export, false otherwise.