#include <ossimNitfRegisteredDes.h>

Inheritance diagram for ossimNitfRegisteredDes:

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

	ossimNitfRegisteredDes (const std::string &desName, ossim_uint32 desLength)
	Constructor that takes name and size. More...

virtual	~ossimNitfRegisteredDes ()
	destructor More...

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

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

virtual void	setDesName (const std::string &desName)

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

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

virtual void	setDesLength (ossim_uint32 length)
	Set the des length. More...

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

virtual void	writeStream (std::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_desName

ossim_uint32	m_desLength

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

Detailed Description

Definition at line 24 of file ossimNitfRegisteredDes.h.

Constructor & Destructor Documentation

◆ ossimNitfRegisteredDes() [1/2]

ossimNitfRegisteredDes::ossimNitfRegisteredDes ( )

default constructor

Definition at line 22 of file ossimNitfRegisteredDes.cpp.

    : 
    ossimObject(),
    ossimPropertyInterface(),
    m_desName(),
    m_desLength(0)
 {}

◆ ossimNitfRegisteredDes() [2/2]

ossimNitfRegisteredDes::ossimNitfRegisteredDes	(	const std::string &	desName,
		ossim_uint32	desLength
	)

Constructor that takes name and size.

Definition at line 29 of file ossimNitfRegisteredDes.cpp.

    : 
    ossimObject(),
    ossimPropertyInterface(),
    m_desName(desName),
    m_desLength(desLength)
 {}

◆ ~ossimNitfRegisteredDes()

ossimNitfRegisteredDes::~ossimNitfRegisteredDes ( )

virtual

destructor

Definition at line 37 of file ossimNitfRegisteredDes.cpp.

38 {}

Member Function Documentation

◆ getDesLength()

ossim_uint32 ossimNitfRegisteredDes::getDesLength ( ) const

virtual

Returns the length in bytes of the des 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 ossimNitfRegisteredDes.cpp.

References m_desLength.

Referenced by getSizeInBytes(), and ossimNitfDesInformation::parseStream().

 {
    return m_desLength;
 }

◆ getDesName()

const std::string & ossimNitfRegisteredDes::getDesName ( ) const

virtual

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

Definition at line 46 of file ossimNitfRegisteredDes.cpp.

References m_desName.

Referenced by ossimNitfDesInformation::parseStream(), and ossimNitfXmlDataContentDes::print().

 {
    return m_desName;
 }

◆ getMetadata()

void ossimNitfRegisteredDes::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 ossimNitfRegisteredDes.cpp.

87 {

88 }

◆ getProperty()

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

virtual

Reimplemented from ossimPropertyInterface.

Definition at line 76 of file ossimNitfRegisteredDes.cpp.

 {
    return 0;
 }

◆ getPropertyNames()

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

virtual

Reimplemented from ossimPropertyInterface.

Definition at line 81 of file ossimNitfRegisteredDes.cpp.

82 {

83 }

◆ getRegisterDesName()

std::string ossimNitfRegisteredDes::getRegisterDesName ( ) const

virtual

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

Note: Deprecated - Use getDesName()

Definition at line 40 of file ossimNitfRegisteredDes.cpp.

References m_desName.

 {
    // Deprecated:
    return m_desName;
 }

◆ getSizeInBytes()

ossim_uint32 ossimNitfRegisteredDes::getSizeInBytes ( ) const

virtual

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

Note: Depricated use: getDesLength()

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 56 of file ossimNitfRegisteredDes.cpp.

References getDesLength().

Referenced by ossimNitfXmlDataContentDes::parseStream().

 {
    // Deprecated:
    return getDesLength();
 }

◆ parseStream()

virtual void ossimNitfRegisteredDes::parseStream ( std::istream & in )

pure virtual

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

Implemented in ossimNitfXmlDataContentDes.

Referenced by ossimNitfDesInformation::parseStream().

◆ print()

std::ostream & ossimNitfRegisteredDes::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 ossimNitfXmlDataContentDes.

Definition at line 90 of file ossimNitfRegisteredDes.cpp.

Referenced by ossimNitfDesInformation::print(), and saveState().

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

◆ saveState()

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

virtual

Definition at line 97 of file ossimNitfRegisteredDes.cpp.

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

 {
    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;
 }

◆ setDesLength()

void ossimNitfRegisteredDes::setDesLength ( ossim_uint32 length )

virtual

Set the des length.

Parameters

length Length of des.

Definition at line 67 of file ossimNitfRegisteredDes.cpp.

References m_desLength.

Referenced by ossimNitfDesInformation::parseStream().

 {
    m_desLength = length;
 }

◆ setDesName()

void ossimNitfRegisteredDes::setDesName ( const std::string & desName )

virtual

Parameters

desName Name of des.

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

Definition at line 51 of file ossimNitfRegisteredDes.cpp.

References m_desName.

 {
    m_desName = desName;
 }

◆ setProperty()

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

virtual

Reimplemented from ossimPropertyInterface.

Definition at line 72 of file ossimNitfRegisteredDes.cpp.

73 {

74 }

◆ writeStream()

virtual void ossimNitfRegisteredDes::writeStream ( std::ostream & out )

pure virtual

Implemented in ossimNitfXmlDataContentDes.

Member Data Documentation

◆ m_desLength

ossim_uint32 ossimNitfRegisteredDes::m_desLength

protected

Definition at line 119 of file ossimNitfRegisteredDes.h.

Referenced by getDesLength(), and setDesLength().

◆ m_desName

std::string ossimNitfRegisteredDes::m_desName

protected

Definition at line 118 of file ossimNitfRegisteredDes.h.

Referenced by getDesName(), getRegisterDesName(), and setDesName().

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ossimNitfRegisteredDes() [1/2]

◆ ossimNitfRegisteredDes() [2/2]

◆ ~ossimNitfRegisteredDes()

Member Function Documentation

◆ getDesLength()

◆ getDesName()

◆ getMetadata()

◆ getProperty()

◆ getPropertyNames()

◆ getRegisterDesName()

◆ getSizeInBytes()

◆ parseStream()

◆ print()

◆ saveState()

◆ setDesLength()

◆ setDesName()

◆ setProperty()

◆ writeStream()

Member Data Documentation

◆ m_desLength

◆ m_desName