Factory for OpenJPEG image writer. More...

#include <ossimOpjWriterFactory.h>

Inheritance diagram for ossimOpjWriterFactory:

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

virtual ossimImageFileWriter *	createWriterFromExtension (const ossimString &fileExtension) const
	Creates a writer from extension like "jp2". 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 (ossimOpjWriter) 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 (ossimOpjWriter) More...

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

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

virtual void	getImageTypeList (std::vector< ossimString > &imageTypeList) const
	Adds "ossim_opj_jp2", "ossim_opj_geojp2", and "ossim_opj_gmljp2" to writer list. More...

virtual void	getImageFileWritersBySuffix (ossimImageWriterFactoryBase::ImageFileWriterList &result, const ossimString &ext) const
	Adds an ossimOpjJp2Writer instance to writer list. More...

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 ossimOpjWriterFactory *	instance ()
	static method to return instance (the only one) of this class. More...

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

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

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

Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Static Protected Attributes
static ossimOpjWriterFactory *	theInstance = NULL
	static instance of this class More...

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

Detailed Description

Factory for OpenJPEG image writer.

Definition at line 20 of file ossimOpjWriterFactory.h.

Constructor & Destructor Documentation

◆ ~ossimOpjWriterFactory()

ossimOpjWriterFactory::~ossimOpjWriterFactory ( )

virtual

virtual destructor

Definition at line 22 of file ossimOpjWriterFactory.cpp.

References theInstance.

 {
    theInstance = 0;
 }

◆ ossimOpjWriterFactory() [1/2]

ossimOpjWriterFactory::ossimOpjWriterFactory ( )

protected

hidden from use default constructor

Definition at line 143 of file ossimOpjWriterFactory.cpp.

Referenced by instance().

143 {}

◆ ossimOpjWriterFactory() [2/2]

ossimOpjWriterFactory::ossimOpjWriterFactory ( const ossimOpjWriterFactory & )

protected

hidden from use copy constructor

Definition at line 145 of file ossimOpjWriterFactory.cpp.

145 {}

Member Function Documentation

◆ createObject() [1/2]

ossimObject * ossimOpjWriterFactory::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 86 of file ossimOpjWriterFactory.cpp.

References createWriter().

 {
    return createWriter(kwl, prefix);
 }

◆ createObject() [2/2]

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

virtual

createObject that takes a class name (ossimOpjWriter)

Parameters

typeName Should be "ossimOpjReader".

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

Implements ossimObjectFactory.

Definition at line 92 of file ossimOpjWriterFactory.cpp.

References createWriter().

 {
    return createWriter(typeName);
 }

◆ createWriter() [1/2]

ossimImageFileWriter * ossimOpjWriterFactory::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 47 of file ossimOpjWriterFactory.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 * ossimOpjWriterFactory::createWriter ( const ossimString & typeName ) const

virtual

createWriter that takes a class name (ossimOpjWriter)

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 66 of file ossimOpjWriterFactory.cpp.

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

 {
    ossimRefPtr<ossimImageFileWriter> writer = 0;
    if (typeName == "ossimOpjJp2Writer")
    {
       writer = new ossimOpjJp2Writer;
    }
    else
    {
       // See if the type name is supported by the writer.
       writer = new ossimOpjJp2Writer(typeName);
       if ( writer->hasImageType(typeName) == false )
       {
          writer = 0;
       }
    }
    return writer.release();
 }

◆ createWriterFromExtension()

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

virtual

Creates a writer from extension like "jp2".

Parameters

fileExtension e.g. "jpg"

Definition at line 36 of file ossimOpjWriterFactory.cpp.

 {
    ossimOpjJp2Writer* writer = 0;
    if ( (fileExtension == "jp2") || (fileExtension == "JP2") || (fileExtension == "j2k"))
    {
       writer = new ossimOpjJp2Writer();
    }
    return writer;
 }

◆ getExtensions()

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

virtual

Adds "jp2" to list.

Parameters

extList List to add to.

Implements ossimImageWriterFactoryBase.

Definition at line 98 of file ossimOpjWriterFactory.cpp.

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

◆ getImageFileWritersByMimeType()

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

virtual

Reimplemented from ossimImageWriterFactoryBase.

Definition at line 133 of file ossimOpjWriterFactory.cpp.

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

◆ getImageFileWritersBySuffix()

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

virtual

Adds an ossimOpjJp2Writer instance to writer list.

Parameters

result	List to append to.
ext	file extension should be either "jp2" or "j2k"

Reimplemented from ossimImageWriterFactoryBase.

Definition at line 122 of file ossimOpjWriterFactory.cpp.

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

 {
    ossimString testExt = ext.downcase();
    if ( (testExt == "jp2") || (testExt == "j2k") )
    {
       result.push_back(new ossimOpjJp2Writer);
    }
 }

◆ getImageTypeList()

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

virtual

Adds "ossim_opj_jp2", "ossim_opj_geojp2", and "ossim_opj_gmljp2" to writer list.

Parameters

imageTypeList List to append to.

Implements ossimImageWriterFactoryBase.

Definition at line 110 of file ossimOpjWriterFactory.cpp.

 {
    // include both geotiff and gmljp2 headers
    imageTypeList.push_back( ossimString("ossim_opj_jp2") );
 
    // include only a geotiff header
    imageTypeList.push_back( ossimString("ossim_opj_geojp2") ); 
 
    // include only a gmljp2 header
    imageTypeList.push_back( ossimString("ossim_opj_gmljp2") ); 
 }

◆ getTypeNameList()

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

virtual

Adds "ossimOpjWriter" to list.

Parameters

typeList List to add to.

Implements ossimObjectFactory.

Definition at line 105 of file ossimOpjWriterFactory.cpp.

 {
    typeList.push_back(ossimString("ossimOpjJp2Writer"));
 }

◆ instance()

ossimOpjWriterFactory * ossimOpjWriterFactory::instance ( )

static

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

Returns: pointer to instance of this class.

Definition at line 27 of file ossimOpjWriterFactory.cpp.

References ossimOpjWriterFactory(), and theInstance.

Referenced by ossimSharedLibraryFinalize(), and ossimSharedLibraryInitialize().

 {
    if(!theInstance)
    {
       theInstance = new ossimOpjWriterFactory;
    }
    return theInstance;
 }

◆ operator=()

void ossimOpjWriterFactory::operator= ( const ossimOpjWriterFactory & )

protected

hidden from use copy constructor

Definition at line 147 of file ossimOpjWriterFactory.cpp.

147 {}

Member Data Documentation

◆ theInstance

ossimOpjWriterFactory * ossimOpjWriterFactory::theInstance = NULL

staticprotected

static instance of this class

Definition at line 115 of file ossimOpjWriterFactory.h.

Referenced by instance(), and ~ossimOpjWriterFactory().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~ossimOpjWriterFactory()

◆ ossimOpjWriterFactory() [1/2]

◆ ossimOpjWriterFactory() [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=()

Member Data Documentation

◆ theInstance