Factory for Kml SuperOverlay reader. More...

#include <ossimKmlSuperOverlayReaderFactory.h>

Inheritance diagram for ossimKmlSuperOverlayReaderFactory:

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

virtual ossimImageHandler *	open (const ossimFilename &fileName, bool openOverview=true) const
	open that takes a file name. More...

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

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

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

virtual void	getTypeNameList (std::vector< ossimString > &typeList) const
	Adds ossimKmlSuperOverlayReader to the typeList. More...

virtual void	getSupportedExtensions (ossimImageHandlerFactoryBase::UniqueStringList &extensionList) const
	Method to add supported extension to the list, like "kml" or "kmz". More...

Public Member Functions inherited from ossimImageHandlerFactoryBase
virtual ossimRefPtr< ossimImageHandler >	open (std::shared_ptr< ossim::istream > &str, const std::string &connectionString, bool openOverview=true) const
	Open method that takes a stream. More...

virtual ossimRefPtr< ossimImageHandler >	open (std::shared_ptr< ossim::ImageHandlerState > state) const

virtual ossimRefPtr< ossimImageHandler >	openOverview (const ossimFilename &file) const
	Open overview that takes a file name. More...

virtual ossimRefPtr< ossimImageHandler >	openOverview (std::shared_ptr< ossim::istream > &str, const ossimString &connectionString) const
	Open method that takes a stream. More...

virtual void	getImageHandlersBySuffix (ImageHandlerList &result, const ossimString &ext) const

virtual void	getImageHandlersByMimeType (ImageHandlerList &result, const ossimString &mimeType) const

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

Protected Member Functions
bool	hasExcludedExtension (const ossimFilename &file) const
	Method to weed out extensions that this plugin knows it does not support. More...

	ossimKmlSuperOverlayReaderFactory ()
	hidden from use default constructor More...

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

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

Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Static Protected Attributes
static ossimKmlSuperOverlayReaderFactory *	theInstance = 0
	static instance of this class More...

Additional Inherited Members
Public Types inherited from ossimImageHandlerFactoryBase
typedef UniqueList< ossimString >	UniqueStringList

typedef std::vector< ossimRefPtr< ossimImageHandler > >	ImageHandlerList

Detailed Description

Factory for Kml SuperOverlay reader.

Definition at line 21 of file ossimKmlSuperOverlayReaderFactory.h.

Constructor & Destructor Documentation

◆ ~ossimKmlSuperOverlayReaderFactory()

ossimKmlSuperOverlayReaderFactory::~ossimKmlSuperOverlayReaderFactory ( )

virtual

virtual destructor

Definition at line 31 of file ossimKmlSuperOverlayReaderFactory.cpp.

References theInstance.

 {
    theInstance = 0;
 }

◆ ossimKmlSuperOverlayReaderFactory() [1/2]

ossimKmlSuperOverlayReaderFactory::ossimKmlSuperOverlayReaderFactory ( )

protected

hidden from use default constructor

Definition at line 148 of file ossimKmlSuperOverlayReaderFactory.cpp.

Referenced by instance().

148 {}

◆ ossimKmlSuperOverlayReaderFactory() [2/2]

ossimKmlSuperOverlayReaderFactory::ossimKmlSuperOverlayReaderFactory ( const ossimKmlSuperOverlayReaderFactory & )

protected

hidden from use copy constructor

Definition at line 150 of file ossimKmlSuperOverlayReaderFactory.cpp.

150 {}

Member Function Documentation

◆ createObject() [1/2]

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

virtual

createObject that takes a class name (ossimKmlSuperOverlayReader)

Parameters

typeName Should be "ossimKmlSuperOverlayReader".

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

Implements ossimObjectFactory.

Definition at line 104 of file ossimKmlSuperOverlayReaderFactory.cpp.

References ossimRefPtr< T >::release().

 {
    ossimRefPtr<ossimObject> result = 0;
    if(typeName == "ossimKmlSuperOverlayReader")
    {
       result = new ossimKmlSuperOverlayReader;
    }
 
    return result.release();
 }

◆ createObject() [2/2]

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

virtual

Creates and object given 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 ossimObjectFactory.

Definition at line 116 of file ossimKmlSuperOverlayReaderFactory.cpp.

References open().

 {
    return this->open(kwl, prefix);
 }

◆ getSupportedExtensions()

void ossimKmlSuperOverlayReaderFactory::getSupportedExtensions ( ossimImageHandlerFactoryBase::UniqueStringList & extensionList ) const

virtual

Method to add supported extension to the list, like "kml" or "kmz".

Parameters

extensionList The list to add to.

Implements ossimImageHandlerFactoryBase.

Definition at line 129 of file ossimKmlSuperOverlayReaderFactory.cpp.

References ossimImageHandlerFactoryBase::UniqueList< T >::push_back().

 {
    extensionList.push_back(ossimString("kml"));
    extensionList.push_back(ossimString("kmz"));
 }

◆ getTypeNameList()

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

virtual

Adds ossimKmlSuperOverlayReader to the typeList.

Parameters

typeList List to add to.

Implements ossimObjectFactory.

Definition at line 123 of file ossimKmlSuperOverlayReaderFactory.cpp.

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

◆ hasExcludedExtension()

bool ossimKmlSuperOverlayReaderFactory::hasExcludedExtension ( const ossimFilename & file ) const

protected

Method to weed out extensions that this plugin knows it does not support.

This is to avoid a costly open on say a tiff or jpeg that is not handled by this plugin.

Returns: true if extension, false if not.

Definition at line 136 of file ossimKmlSuperOverlayReaderFactory.cpp.

References ossimString::downcase(), and ossimFilename::ext().

 {
    bool result = true;
    ossimString ext = file.ext().downcase();
    if (ext == "kml" || ext == "kmz") //only include the file with .kml or .kmz extension and exclude any other files
    {
       result = false;
    }
    return result;
 }

◆ instance()

ossimKmlSuperOverlayReaderFactory * ossimKmlSuperOverlayReaderFactory::instance ( )

static

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

Returns: pointer to instance of this class.

Definition at line 36 of file ossimKmlSuperOverlayReaderFactory.cpp.

References ossimKmlSuperOverlayReaderFactory(), and theInstance.

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

◆ open() [1/2]

ossimImageHandler * ossimKmlSuperOverlayReaderFactory::open	(	const ossimFilename &	fileName,
		bool	openOverview = `true`
	)		const

virtual

open that takes a file name.

Parameters

file	The file to open.

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

Implements ossimImageHandlerFactoryBase.

Definition at line 45 of file ossimKmlSuperOverlayReaderFactory.cpp.

Referenced by createObject().

 {
    if(traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG)
          << "ossimKmlSuperOverlayReaderFactory::open(filename) DEBUG: entered..."
          << "\ntrying ossimKakaduNitfReader"
          << std::endl;
    }
 
    ossimRefPtr<ossimImageHandler> reader = 0;
 
    if ( hasExcludedExtension(fileName) == false )
    {
       reader = new ossimKmlSuperOverlayReader;
       if(reader->open(fileName) == false)
       {
          reader = 0;
       }
    }
 
    if(traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG)
          << "ossimKmlSuperOverlayReaderFactory::open(filename) DEBUG: leaving..."
          << std::endl;
    }
 
    return reader.release();
 }

◆ open() [2/2]

ossimImageHandler * ossimKmlSuperOverlayReaderFactory::open	(	const ossimKeywordlist &	kwl,
		const char *	prefix = `0`
	)		const

virtual

open 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 ossimImageHandlerFactoryBase.

Definition at line 77 of file ossimKmlSuperOverlayReaderFactory.cpp.

 {
    if(traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG)
          << "ossimKmlSuperOverlayReaderFactory::open(kwl, prefix) DEBUG: entered..."
          << "Trying ossimKakaduNitfReader"
          << std::endl;
    }
 
    ossimRefPtr<ossimImageHandler> reader = new ossimKmlSuperOverlayReader;
    if(reader->loadState(kwl, prefix) == false)
    {
       reader = 0;
    }
 
    if(traceDebug())
    {
       ossimNotify(ossimNotifyLevel_DEBUG)
          << "ossimKmlSuperOverlayReaderFactory::open(kwl, prefix) DEBUG: leaving..."
          << std::endl;
    }
 
    return reader.release();
 }

◆ operator=()

void ossimKmlSuperOverlayReaderFactory::operator= ( const ossimKmlSuperOverlayReaderFactory & )

protected

hidden from use copy constructor

Definition at line 152 of file ossimKmlSuperOverlayReaderFactory.cpp.

152 {}

Member Data Documentation

◆ theInstance

ossimKmlSuperOverlayReaderFactory * ossimKmlSuperOverlayReaderFactory::theInstance = 0

staticprotected

static instance of this class

Definition at line 101 of file ossimKmlSuperOverlayReaderFactory.h.

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

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

◆ ~ossimKmlSuperOverlayReaderFactory()

◆ ossimKmlSuperOverlayReaderFactory() [1/2]

◆ ossimKmlSuperOverlayReaderFactory() [2/2]

Member Function Documentation

◆ createObject() [1/2]

◆ createObject() [2/2]

◆ getSupportedExtensions()

◆ getTypeNameList()

◆ hasExcludedExtension()

◆ instance()

◆ open() [1/2]

◆ open() [2/2]

◆ operator=()

Member Data Documentation

◆ theInstance