#include <ossimNitfRegisteredTag.h>

Inheritance diagram for ossimNitfRegisteredTag:

Public Member Functions
	ossimNitfRegisteredTag ()
	default constructor More...

	ossimNitfRegisteredTag (const std::string &tagName, ossim_uint32 tagLength)
	Constructor that takes name and size. More...

virtual	~ossimNitfRegisteredTag ()
	destructor More...

virtual std::string	getRegisterTagName () const
	This will return the name of the registered tag for this user defined header. More...

virtual const std::string &	getTagName () const
	This will return the name of the registered tag for this user defined header. More...

virtual void	setTagName (const std::string &tagName)

virtual ossim_uint32	getSizeInBytes () const
	Returns the length in bytes of the tag from the CEL or REL field. More...

virtual ossim_uint32	getTagLength () const
	Returns the length in bytes of the tag from the CEL or REL field. More...

virtual void	setTagLength (ossim_uint32 length)
	Set the tag length. More...

virtual void	parseStream (ossim::istream &in)=0
	This will allow the user defined data to parse the stream. More...

virtual void	writeStream (ossim::ostream &out)=0

virtual void	setProperty (ossimRefPtr< ossimProperty > property)

virtual ossimRefPtr< ossimProperty >	getProperty (const ossimString &name) const

virtual void	getPropertyNames (std::vector< ossimString > &propertyNames) const

virtual void	getMetadata (ossimKeywordlist &kwl, const char *prefix=0) const
	Default interface to populate keyword list with metadata. More...

virtual std::ostream &	print (std::ostream &out, const std::string &prefix=std::string()) const
	Pure virtual print method that outputs a key/value type format adding prefix to keys. More...

virtual bool	saveState (ossimKeywordlist &kwl, const ossimString &prefix) const

Public Member Functions inherited from ossimObject
	ossimObject ()

virtual	~ossimObject ()

virtual ossimObject *	dup () const

virtual ossimString	getShortName () const

virtual ossimString	getLongName () const

virtual ossimString	getDescription () const

virtual ossimString	getClassName () const

virtual RTTItypeid	getType () const

virtual bool	canCastTo (ossimObject *obj) const

virtual bool	canCastTo (const RTTItypeid &id) const

virtual bool	canCastTo (const ossimString &parentClassName) const

virtual bool	saveState (ossimKeywordlist &kwl, const char *prefix=0) const

virtual bool	loadState (const ossimKeywordlist &kwl, const char *prefix=0)

virtual std::ostream &	print (std::ostream &out) const
	Generic print method. More...

virtual bool	isEqualTo (const ossimObject &obj, ossimCompareType compareType=OSSIM_COMPARE_FULL) const

virtual void	accept (ossimVisitor &visitor)

Public Member Functions inherited from ossimReferenced
	ossimReferenced ()

	ossimReferenced (const ossimReferenced &)

ossimReferenced &	operator= (const ossimReferenced &)

void	ref () const
	increment the reference count by one, indicating that this object has another pointer which is referencing it. More...

void	unref () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...

void	unref_nodelete () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...

int	referenceCount () const

Public Member Functions inherited from ossimPropertyInterface
	ossimPropertyInterface ()

virtual	~ossimPropertyInterface ()

virtual void	setProperty (const ossimString &name, const ossimString &value)

virtual ossimString	getPropertyValueAsString (const ossimString &name) const

void	getPropertyList (std::vector< ossimRefPtr< ossimProperty > > &propertyList) const

void	setProperties (std::vector< ossimRefPtr< ossimProperty > > &propertyList)

Protected Attributes
std::string	m_tagName

ossim_uint32	m_tagLength

Additional Inherited Members
Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Detailed Description

Definition at line 26 of file ossimNitfRegisteredTag.h.

Constructor & Destructor Documentation

◆ ossimNitfRegisteredTag() [1/2]

ossimNitfRegisteredTag::ossimNitfRegisteredTag ( )

default constructor

Definition at line 22 of file ossimNitfRegisteredTag.cpp.

    : 
    ossimObject(),
    ossimPropertyInterface(),
    m_tagName(),
    m_tagLength(0)
 {}

◆ ossimNitfRegisteredTag() [2/2]

ossimNitfRegisteredTag::ossimNitfRegisteredTag	(	const std::string &	tagName,
		ossim_uint32	tagLength
	)

Constructor that takes name and size.

Definition at line 29 of file ossimNitfRegisteredTag.cpp.

    : 
    ossimObject(),
    ossimPropertyInterface(),
    m_tagName(tagName),
    m_tagLength(tagLength)
 {}

◆ ~ossimNitfRegisteredTag()

ossimNitfRegisteredTag::~ossimNitfRegisteredTag ( )

virtual

destructor

Definition at line 37 of file ossimNitfRegisteredTag.cpp.

38 {}

Member Function Documentation

◆ getMetadata()

void ossimNitfRegisteredTag::getMetadata	(	ossimKeywordlist &	kwl,
		const char *	prefix = `0`
	)		const

virtual

Default interface to populate keyword list with metadata.

expample: country_code: US This implementation does nothing. Derived classes should implement as they see fit.

Parameters

kwl	Keywordlist to populate with metadata.
prefix	Optional prefix to put in front of key, like: "image1.".

Definition at line 85 of file ossimNitfRegisteredTag.cpp.

87 {

88 }

◆ getProperty()

ossimRefPtr< ossimProperty > ossimNitfRegisteredTag::getProperty ( const ossimString & name ) const

virtual

Reimplemented from ossimPropertyInterface.

Reimplemented in ossimNitfRpcBase, ossimNitfIchipbTag, ossimNitfPiaimcTag, ossimNitfUse00aTag, and ossimNitfStdidcTag.

Definition at line 76 of file ossimNitfRegisteredTag.cpp.

 {
    return 0;
 }

◆ getPropertyNames()

void ossimNitfRegisteredTag::getPropertyNames ( std::vector< ossimString > & propertyNames ) const

virtual

Reimplemented from ossimPropertyInterface.

Reimplemented in ossimNitfRpcBase, ossimNitfIchipbTag, ossimNitfPiaimcTag, ossimNitfUse00aTag, and ossimNitfStdidcTag.

Definition at line 81 of file ossimNitfRegisteredTag.cpp.

Referenced by ossimNitfStdidcTag::getPropertyNames(), ossimNitfUse00aTag::getPropertyNames(), ossimNitfPiaimcTag::getPropertyNames(), and ossimNitfIchipbTag::getPropertyNames().

82 {

83 }

◆ getRegisterTagName()

std::string ossimNitfRegisteredTag::getRegisterTagName ( ) const

virtual

This will return the name of the registered tag for this user defined header.

Note: Deprecated - Use getTagName()

Definition at line 40 of file ossimNitfRegisteredTag.cpp.

References m_tagName.

Referenced by ossimNitfProjectionParameterTag::print(), and ossimNitfTagInformation::setTagData().

 {
    // Deprecated:
    return m_tagName;
 }

◆ getSizeInBytes()

ossim_uint32 ossimNitfRegisteredTag::getSizeInBytes ( ) const

virtual

Returns the length in bytes of the tag from the CEL or REL field.

Note: Depricated use: getTagLength()

The entire TRE length is 11 plus this(the size of the CEL or REL field).

Returns: Length of REDATA or CEDATA.

Reimplemented in ossimNitfHistoaTag, ossimNitfJ2klraTag, and ossimNitfProjectionParameterTag.

Definition at line 56 of file ossimNitfRegisteredTag.cpp.

References getTagLength().

Referenced by ossimNitfRsmpcaTag::print(), ossimNitfEngrdaTag::print(), ossimNitfRsmecaTag::print(), ossimNitfRpcBase::print(), and ossimNitfTagInformation::setTagData().

 {
    // Deprecated:
    return getTagLength();
 }

◆ getTagLength()

ossim_uint32 ossimNitfRegisteredTag::getTagLength ( ) const

virtual

Returns the length in bytes of the tag from the CEL or REL field.

The entire TRE length is 11 plus this(the size of the CEL or REL field).

Returns: Length of REDATA or CEDATA.

Definition at line 62 of file ossimNitfRegisteredTag.cpp.

References m_tagLength.

 {
    return m_tagLength;
 }

◆ getTagName()

const std::string & ossimNitfRegisteredTag::getTagName ( ) const

virtual

This will return the name of the registered tag for this user defined header.

Definition at line 46 of file ossimNitfRegisteredTag.cpp.

References m_tagName.

 {
    return m_tagName;
 }

◆ parseStream()

virtual void ossimNitfRegisteredTag::parseStream ( ossim::istream & in )

pure virtual

This will allow the user defined data to parse the stream.

Implemented in ossimNitfAcftbTag, ossimNitfAimidbTag, ossimNitfBlockaTag, ossimNitfGeolobTag, and ossimNitfCsccgaTag.

Referenced by ossimNitfTagInformation::parseStream().

◆ print()

std::ostream & ossimNitfRegisteredTag::print	(	std::ostream &	out,
		const std::string &	prefix = `std::string()`
	)		const

virtual

Pure virtual print method that outputs a key/value type format adding prefix to keys.

Reimplemented in ossimNitfHistoaTag, ossimNitfRpcBase, ossimNitfUse00aTag, ossimNitfStdidcTag, ossimNitfIchipbTag, ossimNitfRsmecaTag, ossimNitfAcftbTag, ossimNitfPiaimcTag, ossimNitfJ2klraTag, ossimRpfHeader, ossimNitfBlockaTag, ossimNitfAimidbTag, ossimNitfSensraTag, ossimNitfMstgtaTag, ossimNitfEngrdaTag, ossimNitfGeolobTag, ossimNitfUnknownTag, ossimNitfCsccgaTag, ossimNitfExoptaTag, ossimNitfCscrnaTag, ossimNitfCsdidaTag, ossimNitfCsexraTag, ossimNitfRsmpiaTag, ossimNitfRsmidaTag, ossimNitfStreobTag, ossimNitfGeoPositioningTag, ossimNitfRsmpcaTag, ossimNitfCsproaTag, ossimNitfEmbeddedRpfDes, and ossimNitfProjectionParameterTag.

Definition at line 90 of file ossimNitfRegisteredTag.cpp.

Referenced by ossimNitfImageHeader::printTags(), ossimNitfFileHeader::printTags(), and saveState().

 {
    // return print(out);
    return out;
 }

◆ saveState()

bool ossimNitfRegisteredTag::saveState	(	ossimKeywordlist &	kwl,
		const ossimString &	prefix
	)		const

virtual

Definition at line 97 of file ossimNitfRegisteredTag.cpp.

References ossimKeywordlist::add(), ossimKeywordlist::parseStream(), and print().

Referenced by ossimNitfImageHeader::saveState(), and ossimNitfFileHeader::saveState().

 {
    bool result = false;
    // by default we will use the already implemented print method as backup
    //
    std::ostringstream out;
    
    print(out);
    
    ossimKeywordlist kwlTemp;
    
    std::istringstream in(out.str());
    if(kwlTemp.parseStream(in))
    {
       result = true;
       kwl.add(prefix, kwlTemp);
    }
    
    return result;
 }

◆ setProperty()

void ossimNitfRegisteredTag::setProperty ( ossimRefPtr< ossimProperty > property )

virtual

Reimplemented from ossimPropertyInterface.

Reimplemented in ossimNitfRpcBase, ossimNitfIchipbTag, ossimNitfPiaimcTag, ossimNitfUse00aTag, and ossimNitfStdidcTag.

Definition at line 72 of file ossimNitfRegisteredTag.cpp.

Referenced by ossimNitfStdidcTag::setProperty(), ossimNitfUse00aTag::setProperty(), ossimNitfPiaimcTag::setProperty(), and ossimNitfIchipbTag::setProperty().

73 {

74 }

◆ setTagLength()

void ossimNitfRegisteredTag::setTagLength ( ossim_uint32 length )

virtual

Set the tag length.

Parameters

length Length of tag.

Reimplemented in ossimNitfUnknownTag.

Definition at line 67 of file ossimNitfRegisteredTag.cpp.

References m_tagLength.

Referenced by ossimNitfProjectionParameterTag::clearFields(), ossimNitfJ2klraTag::clearFields(), ossimNitfHistoaTag::clearFields(), ossimNitfRpcBase::ossimNitfRpcBase(), ossimNitfProjectionParameterTag::parseStream(), ossimNitfTagInformation::parseStream(), ossimNitfJ2klraTag::parseStream(), and ossimNitfHistoaTag::parseStream().

 {
    m_tagLength = length;
 }

◆ setTagName()

void ossimNitfRegisteredTag::setTagName ( const std::string & tagName )

virtual

Parameters

tagName Name of tag.

Note: Users should set tag name as this is an unknown tag.

Definition at line 51 of file ossimNitfRegisteredTag.cpp.

References m_tagName.

Referenced by ossimNitfRpcATag::ossimNitfRpcATag(), ossimNitfRpcBTag::ossimNitfRpcBTag(), and ossimNitfTagInformation::parseStream().

 {
    m_tagName = tagName;
 }

◆ writeStream()

virtual void ossimNitfRegisteredTag::writeStream ( ossim::ostream & out )

pure virtual

Implemented in ossimNitfAcftbTag, ossimNitfBlockaTag, ossimNitfAimidbTag, ossimNitfGeolobTag, and ossimNitfCsccgaTag.

Referenced by ossimNitfTagInformation::writeStream().

Member Data Documentation

◆ m_tagLength

ossim_uint32 ossimNitfRegisteredTag::m_tagLength

protected

Definition at line 121 of file ossimNitfRegisteredTag.h.

Referenced by getTagLength(), ossimNitfUnknownTag::parseStream(), ossimNitfUnknownTag::setTagLength(), setTagLength(), ossimNitfUnknownTag::tagDataIsAscii(), ossimNitfUnknownTag::tagDataIsXml(), and ossimNitfUnknownTag::writeStream().

◆ m_tagName

std::string ossimNitfRegisteredTag::m_tagName

protected

Definition at line 120 of file ossimNitfRegisteredTag.h.

Referenced by getRegisterTagName(), getTagName(), and setTagName().

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ossimNitfRegisteredTag() [1/2]

◆ ossimNitfRegisteredTag() [2/2]

◆ ~ossimNitfRegisteredTag()

Member Function Documentation

◆ getMetadata()

◆ getProperty()

◆ getPropertyNames()

◆ getRegisterTagName()

◆ getSizeInBytes()

◆ getTagLength()

◆ getTagName()

◆ parseStream()

◆ print()

◆ saveState()

◆ setProperty()

◆ setTagLength()

◆ setTagName()

◆ writeStream()

Member Data Documentation

◆ m_tagLength

◆ m_tagName