Factory for Kakadu based image writers. More...

#include <ossimKakaduWriterFactory.h>

Inheritance diagram for ossimKakaduWriterFactory:

Public Member Functions
virtual	~ossimKakaduWriterFactory ()
	virtual destructor More...

virtual ossimImageFileWriter *	createWriterFromExtension (const ossimString &fileExtension) const
	Creates a writer from extension like "ntf". More...

virtual ossimImageFileWriter *	createWriter (const ossimKeywordlist &kwl, const char *prefix=0) const
	Create that takes a keyword list and prefix. More...

virtual ossimImageFileWriter *	createWriter (const ossimString &typeName) const
	createWriter that takes a class name (ossimKakaduWriter) More...

virtual ossimObject *	createObject (const ossimKeywordlist &kwl, const char *prefix=0) const
	Creates and object given a keyword list. More...

virtual ossimObject *	createObject (const ossimString &typeName) const
	createObject that takes a class name (ossimKakaduWriter) More...

virtual void	getExtensions (std::vector< ossimString > &extList) const
	Adds "ntf" to list. More...

virtual void	getTypeNameList (std::vector< ossimString > &typeList) const
	Adds "ossimKakaduWriter" to list. More...

virtual void	getImageTypeList (std::vector< ossimString > &imageTypeList) const
	Adds "ossim_kakada_nitf_j2k" to writer list. More...

virtual void	getImageFileWritersBySuffix (ossimImageWriterFactoryBase::ImageFileWriterList &result, const ossimString &ext) const

virtual void	getImageFileWritersByMimeType (ossimImageWriterFactoryBase::ImageFileWriterList &result, const ossimString &mimeType) const

Public Member Functions inherited from ossimImageWriterFactoryBase
virtual	~ossimImageWriterFactoryBase ()

Public Member Functions inherited from ossimObjectFactory
virtual	~ossimObjectFactory ()

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

Static Public Member Functions
static ossimKakaduWriterFactory *	instance ()
	static method to return instance (the only one) of this class. More...

Protected Member Functions
	ossimKakaduWriterFactory ()
	hidden from use default constructor More...

	ossimKakaduWriterFactory (const ossimKakaduWriterFactory &)
	hidden from use copy constructor More...

void	operator= (const ossimKakaduWriterFactory &)
	hidden from use copy constructor More...

Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Additional Inherited Members
Public Types inherited from ossimImageWriterFactoryBase
typedef std::vector< ossimRefPtr< ossimImageFileWriter > >	ImageFileWriterList

Detailed Description

Factory for Kakadu based image writers.

Definition at line 23 of file ossimKakaduWriterFactory.h.

Constructor & Destructor Documentation

◆ ~ossimKakaduWriterFactory()

ossimKakaduWriterFactory::~ossimKakaduWriterFactory ( )

virtual

virtual destructor

Definition at line 24 of file ossimKakaduWriterFactory.cpp.

25 {

26 }

◆ ossimKakaduWriterFactory() [1/2]

ossimKakaduWriterFactory::ossimKakaduWriterFactory ( )

protected

hidden from use default constructor

Definition at line 164 of file ossimKakaduWriterFactory.cpp.

164 {}

◆ ossimKakaduWriterFactory() [2/2]

ossimKakaduWriterFactory::ossimKakaduWriterFactory ( const ossimKakaduWriterFactory & )

protected

hidden from use copy constructor

Definition at line 166 of file ossimKakaduWriterFactory.cpp.

166 {}

Member Function Documentation

◆ createObject() [1/2]

ossimObject * ossimKakaduWriterFactory::createObject	(	const ossimKeywordlist &	kwl,
		const char *	prefix = `0`
	)		const

virtual

Creates and object given a keyword list.

Parameters

kwl	The keyword list.
prefix	the keyword list prefix.

Returns: pointer to image writer on success, NULL on failure.

Implements ossimObjectFactory.

Definition at line 106 of file ossimKakaduWriterFactory.cpp.

References createWriter().

 {
    return createWriter(kwl, prefix);
 }

◆ createObject() [2/2]

ossimObject * ossimKakaduWriterFactory::createObject ( const ossimString & typeName ) const

virtual

createObject that takes a class name (ossimKakaduWriter)

Parameters

typeName Should be "ossimKakaduReader".

Returns: pointer to image writer on success, NULL on failure.

Implements ossimObjectFactory.

Definition at line 112 of file ossimKakaduWriterFactory.cpp.

References createWriter().

 {
    return createWriter(typeName);
 }

◆ createWriter() [1/2]

ossimImageFileWriter * ossimKakaduWriterFactory::createWriter	(	const ossimKeywordlist &	kwl,
		const char *	prefix = `0`
	)		const

virtual

Create that takes a keyword list and prefix.

Parameters

kwl	The keyword list.
prefix	the keyword list prefix.

Returns: pointer to image handler on success, NULL on failure.

Implements ossimImageWriterFactoryBase.

Definition at line 55 of file ossimKakaduWriterFactory.cpp.

References ossimKeywordlist::find(), ossimImageFileWriter::loadState(), ossimRefPtr< T >::release(), ossimKeywordNames::TYPE_KW, and ossimRefPtr< T >::valid().

Referenced by createObject().

 {
    ossimRefPtr<ossimImageFileWriter> writer = 0;
    const char* type = kwl.find(prefix, ossimKeywordNames::TYPE_KW);
    if (type)
    {
       writer = createWriter(ossimString(type));
       if (writer.valid())
       {
          if (writer->loadState(kwl, prefix) == false)
          {
             writer = 0;
          }
       }
    }
    return writer.release();
 }

◆ createWriter() [2/2]

ossimImageFileWriter * ossimKakaduWriterFactory::createWriter ( const ossimString & typeName ) const

virtual

createWriter that takes a class name (ossimKakaduWriter)

Parameters

kwl	The keyword list.
prefix	the keyword list prefix.

Returns: pointer to image writer on success, NULL on failure.

Implements ossimImageWriterFactoryBase.

Definition at line 74 of file ossimKakaduWriterFactory.cpp.

References ossimImageFileWriter::hasImageType(), and ossimRefPtr< T >::release().

 {
    ossimRefPtr<ossimImageFileWriter> writer = 0;
    if ( (typeName == "ossim_kakadu_nitf_j2k") ||
         ( typeName == "ossimKakaduNitfWriter") )
    {
       writer = new ossimKakaduNitfWriter;
    }
    else if ( (typeName == "ossim_kakadu_jp2") ||
              (typeName == "ossimKakaduJp2Writer") )
    {
       writer = new ossimKakaduJp2Writer;
    }
    else
    {
       // See if the type name is supported by the writer.
 
       //---
       // Note: Will not do ossimKakaduNitfWriter here as user may want a
       // non-licensed solution.
       //---
 
       writer = new ossimKakaduJp2Writer;
       if ( writer->hasImageType(typeName) == false )
       {
          writer = 0;
       }
    }
    return writer.release();
 }

◆ createWriterFromExtension()

ossimImageFileWriter * ossimKakaduWriterFactory::createWriterFromExtension ( const ossimString & fileExtension ) const

virtual

Creates a writer from extension like "ntf".

Parameters

fileExtension "ntf"

Definition at line 34 of file ossimKakaduWriterFactory.cpp.

 {
    ossimImageFileWriter* writer = 0;
 
 #if 0 /* Can't use as we don't know if the user wants a compressed nitf. */
    if( (fileExtension == "ntf") || (fileExtension == "nitf") )
    {
       writer = new ossimKakaduNitfWriter;
    }
 #endif
 
    if(fileExtension == "jp2")
    {
       writer = new ossimKakaduJp2Writer;
    }
 
    return writer;
 }

◆ getExtensions()

void ossimKakaduWriterFactory::getExtensions ( std::vector< ossimString > & extList ) const

virtual

Adds "ntf" to list.

Parameters

extList List to add to.

Implements ossimImageWriterFactoryBase.

Definition at line 118 of file ossimKakaduWriterFactory.cpp.

 {
    result.push_back("jp2");
    result.push_back("ntf");
 }

◆ getImageFileWritersByMimeType()

void ossimKakaduWriterFactory::getImageFileWritersByMimeType	(	ossimImageWriterFactoryBase::ImageFileWriterList &	result,
		const ossimString &	mimeType
	)		const

virtual

Reimplemented from ossimImageWriterFactoryBase.

Definition at line 155 of file ossimKakaduWriterFactory.cpp.

 {
    if(mimeType == "image/jp2")
    {
       result.push_back(new ossimKakaduJp2Writer);
    }
 }

◆ getImageFileWritersBySuffix()

void ossimKakaduWriterFactory::getImageFileWritersBySuffix	(	ossimImageWriterFactoryBase::ImageFileWriterList &	result,
		const ossimString &	ext
	)		const

virtual

Reimplemented from ossimImageWriterFactoryBase.

Definition at line 140 of file ossimKakaduWriterFactory.cpp.

References ossimString::downcase(), and ossimString::push_back().

 {
    ossimString testExt = ext.downcase();
    if(testExt == "jp2")
    {
       result.push_back(new ossimKakaduJp2Writer);
    }
    else if(testExt == "ntf")
    {
       result.push_back(new ossimKakaduNitfWriter);
    }
 }

◆ getImageTypeList()

void ossimKakaduWriterFactory::getImageTypeList ( std::vector< ossimString > & imageTypeList ) const

virtual

Adds "ossim_kakada_nitf_j2k" to writer list.

Parameters

imageTypeList List to append to.

Implements ossimImageWriterFactoryBase.

Definition at line 134 of file ossimKakaduWriterFactory.cpp.

 {
    imageTypeList.push_back( ossimString("ossim_kakadu_nitf_j2k") );
    imageTypeList.push_back( ossimString("ossim_kakadu_jp2") );
 }

◆ getTypeNameList()

void ossimKakaduWriterFactory::getTypeNameList ( std::vector< ossimString > & typeList ) const

virtual

Adds "ossimKakaduWriter" to list.

Parameters

typeList List to add to.

Implements ossimObjectFactory.

Definition at line 125 of file ossimKakaduWriterFactory.cpp.

 {
    typeList.push_back(ossimString("ossimKakaduNitfWriter"));
    typeList.push_back(ossimString("ossimKakaduJp2Writer"));
 }

◆ instance()

ossimKakaduWriterFactory * ossimKakaduWriterFactory::instance ( )

static

static method to return instance (the only one) of this class.

Returns: pointer to instance of this class.

Definition at line 28 of file ossimKakaduWriterFactory.cpp.

Referenced by ossimSharedLibraryFinalize(), and ossimSharedLibraryInitialize().

 {
    static ossimKakaduWriterFactory inst;
    return &inst;
 }

◆ operator=()

void ossimKakaduWriterFactory::operator= ( const ossimKakaduWriterFactory & )

protected

hidden from use copy constructor

Definition at line 168 of file ossimKakaduWriterFactory.cpp.

168 {}

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~ossimKakaduWriterFactory()

◆ ossimKakaduWriterFactory() [1/2]

◆ ossimKakaduWriterFactory() [2/2]

Member Function Documentation

◆ createObject() [1/2]

◆ createObject() [2/2]

◆ createWriter() [1/2]

◆ createWriter() [2/2]

◆ createWriterFromExtension()

◆ getExtensions()

◆ getImageFileWritersByMimeType()

◆ getImageFileWritersBySuffix()

◆ getImageTypeList()

◆ getTypeNameList()

◆ instance()

◆ operator=()