OSSIM - Open Source Software Image Map  Version 1.9.0 (20180803)
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Attributes | List of all members
ossimPngWriterFactory Class Reference

Factory for PNG image writer. More...

#include <ossimPngWriterFactory.h>

Inheritance diagram for ossimPngWriterFactory:
ossimImageWriterFactoryBase ossimObjectFactory ossimObject ossimReferenced

Public Member Functions

virtual ~ossimPngWriterFactory ()
 virtual destructor More...
 
virtual ossimImageFileWritercreateWriterFromExtension (const ossimString &fileExtension) const
 Creates a writer from extension like "png". More...
 
virtual ossimImageFileWritercreateWriter (const ossimKeywordlist &kwl, const char *prefix=0) const
 Create that takes a keyword list and prefix. More...
 
virtual ossimImageFileWritercreateWriter (const ossimString &typeName) const
 createWriter that takes a class name (ossimPngWriter) More...
 
virtual ossimObjectcreateObject (const ossimKeywordlist &kwl, const char *prefix=0) const
 Creates and object given a keyword list. More...
 
virtual ossimObjectcreateObject (const ossimString &typeName) const
 createObject that takes a class name (ossimPngWriter) More...
 
virtual void getExtensions (std::vector< ossimString > &extList) const
 Adds "png" to list. More...
 
virtual void getTypeNameList (std::vector< ossimString > &typeList) const
 Adds "ossimPngWriter" to list. More...
 
virtual void getImageTypeList (std::vector< ossimString > &imageTypeList) const
 Adds "ossim_png" 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 ossimObjectdup () 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 &)
 
ossimReferencedoperator= (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 ossimPngWriterFactoryinstance ()
 static method to return instance (the only one) of this class. More...
 

Protected Member Functions

 ossimPngWriterFactory ()
 hidden from use default constructor More...
 
 ossimPngWriterFactory (const ossimPngWriterFactory &)
 hidden from use copy constructor More...
 
void operator= (const ossimPngWriterFactory &)
 hidden from use copy constructor More...
 
- Protected Member Functions inherited from ossimReferenced
virtual ~ossimReferenced ()
 

Static Protected Attributes

static ossimPngWriterFactorytheInstance = 0
 static instance of this class More...
 

Additional Inherited Members

- Public Types inherited from ossimImageWriterFactoryBase
typedef std::vector< ossimRefPtr< ossimImageFileWriter > > ImageFileWriterList
 

Detailed Description

Factory for PNG image writer.

Definition at line 20 of file ossimPngWriterFactory.h.

Constructor & Destructor Documentation

◆ ~ossimPngWriterFactory()

ossimPngWriterFactory::~ossimPngWriterFactory ( )
virtual

virtual destructor

Definition at line 23 of file ossimPngWriterFactory.cpp.

References theInstance.

24 {
25  theInstance = 0;
26 }
static ossimPngWriterFactory * theInstance
static instance of this class

◆ ossimPngWriterFactory() [1/2]

ossimPngWriterFactory::ossimPngWriterFactory ( )
protected

hidden from use default constructor

Definition at line 138 of file ossimPngWriterFactory.cpp.

Referenced by instance().

138 {}

◆ ossimPngWriterFactory() [2/2]

ossimPngWriterFactory::ossimPngWriterFactory ( const ossimPngWriterFactory )
protected

hidden from use copy constructor

Definition at line 140 of file ossimPngWriterFactory.cpp.

140 {}

Member Function Documentation

◆ createObject() [1/2]

ossimObject * ossimPngWriterFactory::createObject ( const ossimKeywordlist kwl,
const char *  prefix = 0 
) const
virtual

Creates and object given a keyword list.

Parameters
kwlThe keyword list.
prefixthe keyword list prefix.
Returns
pointer to image writer on success, NULL on failure.

Implements ossimObjectFactory.

Definition at line 88 of file ossimPngWriterFactory.cpp.

References createWriter().

90 {
91  return createWriter(kwl, prefix);
92 }
virtual ossimImageFileWriter * createWriter(const ossimKeywordlist &kwl, const char *prefix=0) const
Create that takes a keyword list and prefix.

◆ createObject() [2/2]

ossimObject * ossimPngWriterFactory::createObject ( const ossimString typeName) const
virtual

createObject that takes a class name (ossimPngWriter)

Parameters
typeNameShould be "ossimPngReader".
Returns
pointer to image writer on success, NULL on failure.

Implements ossimObjectFactory.

Definition at line 94 of file ossimPngWriterFactory.cpp.

References createWriter().

96 {
97  return createWriter(typeName);
98 }
virtual ossimImageFileWriter * createWriter(const ossimKeywordlist &kwl, const char *prefix=0) const
Create that takes a keyword list and prefix.

◆ createWriter() [1/2]

ossimImageFileWriter * ossimPngWriterFactory::createWriter ( const ossimKeywordlist kwl,
const char *  prefix = 0 
) const
virtual

Create that takes a keyword list and prefix.

Parameters
kwlThe keyword list.
prefixthe keyword list prefix.
Returns
pointer to image handler on success, NULL on failure.

Implements ossimImageWriterFactoryBase.

Definition at line 49 of file ossimPngWriterFactory.cpp.

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

Referenced by createObject().

51 {
53  const char* type = kwl.find(prefix, ossimKeywordNames::TYPE_KW);
54  if (type)
55  {
56  writer = createWriter(ossimString(type));
57  if ( writer.valid() )
58  {
59  if (writer->loadState(kwl, prefix) == false)
60  {
61  writer = 0;
62  }
63  }
64  }
65  return writer.release();
66 }
bool valid() const
Definition: ossimRefPtr.h:75
const char * find(const char *key) const
virtual bool loadState(const ossimKeywordlist &kwl, const char *prefix=0)
static const char * TYPE_KW
T * release()
Definition: ossimRefPtr.h:93
virtual ossimImageFileWriter * createWriter(const ossimKeywordlist &kwl, const char *prefix=0) const
Create that takes a keyword list and prefix.

◆ createWriter() [2/2]

ossimImageFileWriter * ossimPngWriterFactory::createWriter ( const ossimString typeName) const
virtual

createWriter that takes a class name (ossimPngWriter)

Parameters
kwlThe keyword list.
prefixthe keyword list prefix.
Returns
pointer to image writer on success, NULL on failure.

Implements ossimImageWriterFactoryBase.

Definition at line 68 of file ossimPngWriterFactory.cpp.

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

70 {
72  if (typeName == "ossimPngWriter")
73  {
74  writer = new ossimPngWriter;
75  }
76  else
77  {
78  // See if the type name is supported by the writer.
79  writer = new ossimPngWriter;
80  if ( writer->hasImageType(typeName) == false )
81  {
82  writer = 0;
83  }
84  }
85  return writer.release();
86 }
T * release()
Definition: ossimRefPtr.h:93
virtual bool hasImageType(const ossimString &imageType) const
bool hasImageType(const ossimString& imageType) const

◆ createWriterFromExtension()

ossimImageFileWriter * ossimPngWriterFactory::createWriterFromExtension ( const ossimString fileExtension) const
virtual

Creates a writer from extension like "png".

Parameters
fileExtension"png"

Definition at line 37 of file ossimPngWriterFactory.cpp.

References ossimRefPtr< T >::release().

39 {
40  ossimRefPtr<ossimPngWriter> writer = 0;
41  if ( (fileExtension == "png") || (fileExtension == ".png") )
42  {
43  writer = new ossimPngWriter;
44  }
45  return writer.release();
46 }
T * release()
Definition: ossimRefPtr.h:93

◆ getExtensions()

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

Adds "png" to list.

Parameters
extListList to add to.

Implements ossimImageWriterFactoryBase.

Definition at line 100 of file ossimPngWriterFactory.cpp.

102 {
103  result.push_back("png");
104 }

◆ getImageFileWritersByMimeType()

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

Reimplemented from ossimImageWriterFactoryBase.

Definition at line 128 of file ossimPngWriterFactory.cpp.

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

130 {
131  ossimString testMime = mimeType.downcase();
132  if(testMime == "image/png")
133  {
134  result.push_back(new ossimPngWriter);
135  }
136 }
void push_back(char c)
Equivalent to insert(end(), c).
Definition: ossimString.h:905
static ossimString downcase(const ossimString &aString)
Definition: ossimString.cpp:48

◆ getImageFileWritersBySuffix()

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

Reimplemented from ossimImageWriterFactoryBase.

Definition at line 118 of file ossimPngWriterFactory.cpp.

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

120 {
121  ossimString testExt = ext.downcase();
122  if(testExt == "png")
123  {
124  result.push_back(new ossimPngWriter);
125  }
126 }
void push_back(char c)
Equivalent to insert(end(), c).
Definition: ossimString.h:905
static ossimString downcase(const ossimString &aString)
Definition: ossimString.cpp:48

◆ getImageTypeList()

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

Adds "ossim_png" to writer list.

Parameters
imageTypeListList to append to.

Implements ossimImageWriterFactoryBase.

Definition at line 111 of file ossimPngWriterFactory.cpp.

References ossimPngWriter::getImageTypeList().

112 {
114  writer->getImageTypeList(imageTypeList);
115  writer = 0;
116 }
virtual void getImageTypeList(std::vector< ossimString > &imageTypeList) const
void getImageTypeList(std::vector<ossimString>& imageTypeList)const

◆ getTypeNameList()

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

Adds "ossimPngWriter" to list.

Parameters
typeListList to add to.

Implements ossimObjectFactory.

Definition at line 106 of file ossimPngWriterFactory.cpp.

107 {
108  typeList.push_back(ossimString("ossimPngWriter"));
109 }

◆ instance()

ossimPngWriterFactory * ossimPngWriterFactory::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 ossimPngWriterFactory.cpp.

References ossimPngWriterFactory(), and theInstance.

Referenced by ossimSharedLibraryFinalize().

29 {
30  if(!theInstance)
31  {
33  }
34  return theInstance;
35 }
static ossimPngWriterFactory * theInstance
static instance of this class
ossimPngWriterFactory()
hidden from use default constructor

◆ operator=()

void ossimPngWriterFactory::operator= ( const ossimPngWriterFactory )
protected

hidden from use copy constructor

Definition at line 142 of file ossimPngWriterFactory.cpp.

142 {}

Member Data Documentation

◆ theInstance

ossimPngWriterFactory * ossimPngWriterFactory::theInstance = 0
staticprotected

static instance of this class

Definition at line 107 of file ossimPngWriterFactory.h.

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


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