Nitf::FileHeader Class Reference

Represents the NITF file header. More...

#include <NitfFileHeader.h>

Inheritance diagram for Nitf::FileHeader:

List of all members.

Public Member Functions

FileHeader (const std::string &fileVersion)

bool importMetadata (const ossimPropertyInterface *pHeader, RasterDataDescriptor *pDescriptor)

std::string getMetadataPath () const

FactoryResource< DynamicObject > createDefaultsDynamicObject (const RasterDataDescriptor *pDescriptor)

Static Protected Member Functions

static bool importClassificationString (const ossimPropertyInterface *pPropertyInterface, RasterDataDescriptor *pDescriptor, DynamicObject *pDynObj, const std::string &appName, const std::string &ossimName)

static bool exportClassificationString (const RasterDataDescriptor *pDescriptor, const DataVariant &prop, ossimContainerProperty *pProperties, const std::string &appName, const std::string &ossimName)

static bool importClassificationDate (const ossimPropertyInterface *pPropertyInterface, RasterDataDescriptor *pDescriptor, DynamicObject *pDynObj, const std::string &appName, const std::string &ossimName)

static bool exportClassificationDate (const RasterDataDescriptor *pDescriptor, const DataVariant &prop, ossimContainerProperty *pProperties, const std::string &appName, const std::string &ossimName)

static bool exportOSTAID (const RasterDataDescriptor *pDescriptor, const DataVariant &prop, ossimContainerProperty *pProperties, const std::string &appName, const std::string &ossimName)

static bool exportONAME (const RasterDataDescriptor *pDescriptor, const DataVariant &prop, ossimContainerProperty *pProperties, const std::string &appName, const std::string &ossimName)

static bool exportOPHONE (const RasterDataDescriptor *pDescriptor, const DataVariant &prop, ossimContainerProperty *pProperties, const std::string &appName, const std::string &ossimName)

Detailed Description

Represents the NITF file header.

Definition at line 31 of file NitfFileHeader.h.

Constructor & Destructor Documentation

Nitf::FileHeader::FileHeader ( const std::string & fileVersion )

Constructs the FileHeader.

Parameters:

fileVersion

Either Nitf::VERSION_02_00 or Nitf::VERSION_02_10.

Member Function Documentation

bool Nitf::FileHeader::importMetadata	(	const ossimPropertyInterface *	pHeader,
		RasterDataDescriptor *	pDescriptor
	)

Adds NITF File Header Metadata to the DynamicObject.

Parameters:

	pHeader	The source of the metadata.
	pDescriptor	The destination for the metadata.

Returns:: True on success, false otherwise.

std::string Nitf::FileHeader::getMetadataPath ( ) const [virtual]

Returns the metadata location.

Returns:: The name to place and retrieve the main metadata DynamicObject for this header.

Implements Nitf::Header.

FactoryResource<DynamicObject> Nitf::FileHeader::createDefaultsDynamicObject ( const RasterDataDescriptor * pDescriptor ) [virtual]

Create defaults to export from the given DataDescriptor.

Parameters:

pDescriptor

Descriptor which will be exported. May be needed to create defaults.

Returns:: The defaults DynamicObject, wrapped in a FactoryResource to prevent leaks.

Implements Nitf::Header.

static bool Nitf::FileHeader::importClassificationString	(	const ossimPropertyInterface *	pPropertyInterface,
		RasterDataDescriptor *	pDescriptor,
		DynamicObject *	pDynObj,
		const std::string &	appName,
		const std::string &	ossimName
	)			`[static, protected]`

Generic function to import most metadata.

This function is templated on type to import to the DynamicObject.

Parameters:

	pPropertyInterface	OSSIM property interface to import from.
	pDescriptor	Descriptor to import to.
	pDynObj	DynamicObject to import to.
	appName	The name which is used internally.
	ossimName	The name which OSSIM uses to access the property.

Returns:: True if the metadata was successfully imported, false otherwise.

This function is specialized for importing classification strings.

static bool Nitf::FileHeader::exportClassificationString	(	const RasterDataDescriptor *	pDescriptor,
		const DataVariant &	prop,
		ossimContainerProperty *	pProperties,
		const std::string &	appName,
		const std::string &	ossimName
	)			`[static, protected]`

Generic function to export most metadata.

This function is templated on type stored in the DynamicObject.

Parameters:

	pDescriptor	Descriptor to export from.
	prop	DataVariant with stored metadata.
	pProperties	ossimContainerProperty to export the metadata to.
	appName	The name which is used internally.
	ossimName	The name which OSSIM uses to access the property.

Returns:: True if the metadata was successfully exported, false otherwise.

This function is specialized for exporting classification strings.

static bool Nitf::FileHeader::importClassificationDate	(	const ossimPropertyInterface *	pPropertyInterface,
		RasterDataDescriptor *	pDescriptor,
		DynamicObject *	pDynObj,
		const std::string &	appName,
		const std::string &	ossimName
	)			`[static, protected]`

Generic function to import most metadata.

This function is templated on type to import to the DynamicObject.

Parameters:

	pPropertyInterface	OSSIM property interface to import from.
	pDescriptor	Descriptor to import to.
	pDynObj	DynamicObject to import to.
	appName	The name which is used internally.
	ossimName	The name which OSSIM uses to access the property.

Returns:: True if the metadata was successfully imported, false otherwise.

This function is specialized for importing classification dates and times.

static bool Nitf::FileHeader::exportClassificationDate	(	const RasterDataDescriptor *	pDescriptor,
		const DataVariant &	prop,
		ossimContainerProperty *	pProperties,
		const std::string &	appName,
		const std::string &	ossimName
	)			`[static, protected]`

Generic function to export most metadata.

This function is templated on type stored in the DynamicObject.

Parameters:

	pDescriptor	Descriptor to export from.
	prop	DataVariant with stored metadata.
	pProperties	ossimContainerProperty to export the metadata to.
	appName	The name which is used internally.
	ossimName	The name which OSSIM uses to access the property.

Returns:: True if the metadata was successfully exported, false otherwise.

This function is specialized for exporting classification dates and times.

static bool Nitf::FileHeader::exportOSTAID	(	const RasterDataDescriptor *	pDescriptor,
		const DataVariant &	prop,
		ossimContainerProperty *	pProperties,
		const std::string &	appName,
		const std::string &	ossimName
	)			`[static, protected]`

Generic function to export most metadata.

This function is templated on type stored in the DynamicObject.

Parameters:

	pDescriptor	Descriptor to export from.
	prop	DataVariant with stored metadata.
	pProperties	ossimContainerProperty to export the metadata to.
	appName	The name which is used internally.
	ossimName	The name which OSSIM uses to access the property.

Returns:: True if the metadata was successfully exported, false otherwise.

This function is specialized for exporting Originating STAtion ID.

static bool Nitf::FileHeader::exportONAME	(	const RasterDataDescriptor *	pDescriptor,
		const DataVariant &	prop,
		ossimContainerProperty *	pProperties,
		const std::string &	appName,
		const std::string &	ossimName
	)			`[static, protected]`

Generic function to export most metadata.

This function is templated on type stored in the DynamicObject.

Parameters:

	pDescriptor	Descriptor to export from.
	prop	DataVariant with stored metadata.
	pProperties	ossimContainerProperty to export the metadata to.
	appName	The name which is used internally.
	ossimName	The name which OSSIM uses to access the property.

Returns:: True if the metadata was successfully exported, false otherwise.

This function is specialized for exporting the originator's name.

static bool Nitf::FileHeader::exportOPHONE	(	const RasterDataDescriptor *	pDescriptor,
		const DataVariant &	prop,
		ossimContainerProperty *	pProperties,
		const std::string &	appName,
		const std::string &	ossimName
	)			`[static, protected]`

Generic function to export most metadata.

This function is templated on type stored in the DynamicObject.

Parameters:

	pDescriptor	Descriptor to export from.
	prop	DataVariant with stored metadata.
	pProperties	ossimContainerProperty to export the metadata to.
	appName	The name which is used internally.
	ossimName	The name which OSSIM uses to access the property.

Returns:: True if the metadata was successfully exported, false otherwise.

This function is specialized for exporting the originator's phone number.


Public Member Functions
	FileHeader (const std::string &fileVersion)
bool	importMetadata (const ossimPropertyInterface pHeader, RasterDataDescriptor pDescriptor)
std::string	getMetadataPath () const
FactoryResource< DynamicObject >	createDefaultsDynamicObject (const RasterDataDescriptor *pDescriptor)
Static Protected Member Functions
static bool	importClassificationString (const ossimPropertyInterface pPropertyInterface, RasterDataDescriptor pDescriptor, DynamicObject *pDynObj, const std::string &appName, const std::string &ossimName)
static bool	exportClassificationString (const RasterDataDescriptor pDescriptor, const DataVariant &prop, ossimContainerProperty pProperties, const std::string &appName, const std::string &ossimName)
static bool	importClassificationDate (const ossimPropertyInterface pPropertyInterface, RasterDataDescriptor pDescriptor, DynamicObject *pDynObj, const std::string &appName, const std::string &ossimName)
static bool	exportClassificationDate (const RasterDataDescriptor pDescriptor, const DataVariant &prop, ossimContainerProperty pProperties, const std::string &appName, const std::string &ossimName)
static bool	exportOSTAID (const RasterDataDescriptor pDescriptor, const DataVariant &prop, ossimContainerProperty pProperties, const std::string &appName, const std::string &ossimName)
static bool	exportONAME (const RasterDataDescriptor pDescriptor, const DataVariant &prop, ossimContainerProperty pProperties, const std::string &appName, const std::string &ossimName)
static bool	exportOPHONE (const RasterDataDescriptor pDescriptor, const DataVariant &prop, ossimContainerProperty pProperties, const std::string &appName, const std::string &ossimName)