ossimImageMetaDataWriterFactory Class Reference

#include <ossimImageMetaDataWriterFactory.h>

Inheritance diagram for ossimImageMetaDataWriterFactory:

Public Member Functions
	~ossimImageMetaDataWriterFactory ()
virtual ossimObject *	createObject (const ossimString &typeName) const
virtual ossimObject *	createObject (const ossimKeywordlist &kwl, const char *prefix=0) const
virtual ossimRefPtr< ossimMetadataFileWriter >	createWriter (const ossimString &type) const
	Creates a writer from either a class name or a string representing the meta data type like "tiff_world_file". More...
virtual void	getTypeNameList (std::vector< ossimString > &typeList) const
	This should return the type name of all objects in all factories. More...
virtual void	getMetadatatypeList (std::vector< ossimString > &metadatatypeList) const
	Satisfies pure virtual from ossimImageMetaDataWriterFactoryBase. More...
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 ossimImageMetaDataWriterFactory *	instance ()

Protected Member Functions
	ossimImageMetaDataWriterFactory ()
	ossimImageMetaDataWriterFactory (const ossimImageMetaDataWriterFactory &rhs)
const ossimImageMetaDataWriterFactory &	operator= (const ossimImageMetaDataWriterFactory &rhs)
Protected Member Functions inherited from ossimImageMetaDataWriterFactoryBase
	ossimImageMetaDataWriterFactoryBase ()
	ossimImageMetaDataWriterFactoryBase (const ossimImageMetaDataWriterFactoryBase &)
const ossimImageMetaDataWriterFactoryBase &	operator= (const ossimImageMetaDataWriterFactoryBase &)
Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Static Protected Attributes
static ossimImageMetaDataWriterFactory *	theInstance = NULL

Detailed Description

Definition at line 21 of file ossimImageMetaDataWriterFactory.h.

Constructor & Destructor Documentation

~ossimImageMetaDataWriterFactory()

ossimImageMetaDataWriterFactory::~ossimImageMetaDataWriterFactory

(

)

Definition at line 33 of file ossimImageMetaDataWriterFactory.cpp.

References theInstance.

{
   theInstance = NULL;
}

ossimImageMetaDataWriterFactory() [1/2]

ossimImageMetaDataWriterFactory::ossimImageMetaDataWriterFactory ( )

protected

Definition at line 28 of file ossimImageMetaDataWriterFactory.cpp.

References theInstance.

Referenced by instance().

{
   theInstance = this;
}

ossimImageMetaDataWriterFactory() [2/2]

ossimImageMetaDataWriterFactory::ossimImageMetaDataWriterFactory ( const ossimImageMetaDataWriterFactory &  rhs )

protected

Definition at line 205 of file ossimImageMetaDataWriterFactory.cpp.

{
}

Member Function Documentation

createObject() [1/2]

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

virtual

Creates an object given a type name.

Implements ossimObjectFactory.

Definition at line 48 of file ossimImageMetaDataWriterFactory.cpp.

References STATIC_TYPE_NAME.

Referenced by createObject().

{
   // Use the type name to instantiate the class.
   ossimObject* result = (ossimObject*)NULL;
   
   if(STATIC_TYPE_NAME(ossimEnviHeaderFileWriter) == typeName)
   {
     result = new ossimEnviHeaderFileWriter;
   }
   if(STATIC_TYPE_NAME(ossimERSFileWriter) == typeName)
   {
     result = new ossimERSFileWriter;
   }
   else if(STATIC_TYPE_NAME(ossimFgdcFileWriter) == typeName)
   {
     result = new ossimFgdcFileWriter;
   }
   else if(STATIC_TYPE_NAME(ossimGeomFileWriter) == typeName)
   {
     result = new ossimGeomFileWriter;
   }
   else if(STATIC_TYPE_NAME(ossimReadmeFileWriter) == typeName)
   {
     result = new ossimReadmeFileWriter;
   }
   //---
   // Special case for backwards compatibility. ossimJpegWorldFileWriter and
   // ossimTiffWorldFileWriter same; hence, moved to ossimWorldFileWriter.
   //---
   else if( (STATIC_TYPE_NAME(ossimWorldFileWriter)  == typeName) ||
            (ossimString("ossimJpegWorldFileWriter") == typeName) ||
            (ossimString("ossimTiffWorldFileWriter") == typeName) )
   {
     result = new ossimWorldFileWriter;
   }

   return result;
}

createObject() [2/2]

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

virtual

Creates and object given a keyword list.

Implements ossimObjectFactory.

Definition at line 88 of file ossimImageMetaDataWriterFactory.cpp.

References createObject(), ossimKeywordlist::find(), ossimObject::loadState(), and ossimKeywordNames::TYPE_KW.

{
   //---
   // Check the type keyword found in kwl.  Use the create by class name
   // above and then call load state.
   //---
   ossimObject* result = (ossimObject*)NULL;

   const char* type = kwl.find(prefix, ossimKeywordNames::TYPE_KW);

   if(type)
   {
      result = createObject(ossimString(type));
      if(result)
      {
         result->loadState(kwl, prefix);
      }
   }
   
   return result;
}

createWriter()

ossimRefPtr< ossimMetadataFileWriter > ossimImageMetaDataWriterFactory::createWriter ( const ossimString &  type ) const

virtual

Creates a writer from either a class name or a string representing the meta data type like "tiff_world_file".

Returns

ossimRefPtr<ossimMetadataFileWriter>

Note

Return can have a null pointer if type is not found in a factory so the caller should always check the pointer like: ossimRefPtr<ossimMetadataFileWriter> mw = ossimImageMetaDataWriterRegistry::instance("ossim_readme"); if (!mw.valid()) { // not in factory }

Implements ossimImageMetaDataWriterFactoryBase.

Definition at line 112 of file ossimImageMetaDataWriterFactory.cpp.

References ossimObject::getClassName(), and ossimMetadataFileWriter::hasMetadataType().

{
   ossimRefPtr<ossimMetadataFileWriter> writer;
   
   writer = new ossimEnviHeaderFileWriter;
   if ( (writer->getClassName() == type) ||
        (writer->hasMetadataType(type)) )
   {
      return writer;
   }

   writer = new ossimERSFileWriter;
   if ( (writer->getClassName() == type) ||
        (writer->hasMetadataType(type)) )
   {
      return writer;
   }

  writer = new ossimFgdcFileWriter;
   if ( (writer->getClassName() == type) ||
        (writer->hasMetadataType(type)) )
   {
      return writer;
   }

   writer = new ossimGeomFileWriter;
   if ( (writer->getClassName() == type) ||
        (writer->hasMetadataType(type)) )
   {
      return writer;
   }
   
   writer = new ossimReadmeFileWriter;
   if ( (writer->getClassName() == type) ||
        (writer->hasMetadataType(type)) )
   {
      return writer;
   }

   //---
   // Special case for backwards compatibility. ossimJpegWorldFileWriter and
   // ossimTiffWorldFileWriter same; hence, moved to ossimWorldFileWriter.
   //---
   writer = new ossimWorldFileWriter;
   if ( (writer->getClassName() == type) ||
        (writer->hasMetadataType(type))  ||
        (ossimString("ossimJpegWorldFileWriter") == type) ||
        (ossimString("ossimTiffWorldFileWriter") == type) )
   {
      return writer;
   }

   // Not in factory.
   writer = NULL;
   return writer;
}

getMetadatatypeList()

void ossimImageMetaDataWriterFactory::getMetadatatypeList ( std::vector< ossimString > &  metadatatypeList ) const

virtual

Satisfies pure virtual from ossimImageMetaDataWriterFactoryBase.

Appends the meta data writers types from each of the supported meta data writers in this factor to the "metadatatypeList".

This is the actual metadata type name like: ossim_geometry envi_header tiff_world_file jpeg_world_file

Parameters

metadatatypeList

stl::vector<ossimString> List to append to.

Implements ossimImageMetaDataWriterFactoryBase.

Definition at line 181 of file ossimImageMetaDataWriterFactory.cpp.

References ossimMetadataFileWriter::getMetadatatypeList().

{
   ossimRefPtr<ossimMetadataFileWriter> writer;

   writer = new ossimEnviHeaderFileWriter;
   writer->getMetadatatypeList(metadatatypeList);

   writer = new ossimERSFileWriter;
   writer->getMetadatatypeList(metadatatypeList);

   writer = new ossimFgdcFileWriter;
   writer->getMetadatatypeList(metadatatypeList);
   
   writer = new ossimGeomFileWriter;
   writer->getMetadatatypeList(metadatatypeList);

   writer = new ossimReadmeFileWriter;
   writer->getMetadatatypeList(metadatatypeList);

   writer = new ossimWorldFileWriter;
   writer->getMetadatatypeList(metadatatypeList);
}

getTypeNameList()

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

virtual

This should return the type name of all objects in all factories.

This is the name used to construct the objects dynamially and this name must be unique.

Implements ossimObjectFactory.

Definition at line 169 of file ossimImageMetaDataWriterFactory.cpp.

References STATIC_TYPE_NAME.

{
   // add each object's RTTI name here
   typeList.push_back(STATIC_TYPE_NAME(ossimEnviHeaderFileWriter));
   typeList.push_back(STATIC_TYPE_NAME(ossimERSFileWriter));   
   typeList.push_back(STATIC_TYPE_NAME(ossimFgdcFileWriter));
   typeList.push_back(STATIC_TYPE_NAME(ossimGeomFileWriter));
   typeList.push_back(STATIC_TYPE_NAME(ossimReadmeFileWriter));   
   typeList.push_back(STATIC_TYPE_NAME(ossimWorldFileWriter));
}

instance()

ossimImageMetaDataWriterFactory * ossimImageMetaDataWriterFactory::instance ( )

static

Definition at line 38 of file ossimImageMetaDataWriterFactory.cpp.

References ossimImageMetaDataWriterFactory(), and theInstance.

Referenced by ossimImageMetaDataWriterRegistry::ossimImageMetaDataWriterRegistry().

{
   if(!theInstance)
   {
      theInstance = new ossimImageMetaDataWriterFactory;
   }

   return theInstance;
}

operator=()

const ossimImageMetaDataWriterFactory & ossimImageMetaDataWriterFactory::operator= ( const ossimImageMetaDataWriterFactory &  rhs )

protected

Definition at line 211 of file ossimImageMetaDataWriterFactory.cpp.

{
   return *this;
}

Member Data Documentation

theInstance

ossimImageMetaDataWriterFactory * ossimImageMetaDataWriterFactory::theInstance = NULL

staticprotected

Definition at line 75 of file ossimImageMetaDataWriterFactory.h.

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

---

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

• ossimImageMetaDataWriterFactory.h
• ossimImageMetaDataWriterFactory.cpp