ossimImageMetaDataWriterRegistry Class Reference

#include <ossimImageMetaDataWriterRegistry.h>

Inheritance diagram for ossimImageMetaDataWriterRegistry:

Public Member Functions
	~ossimImageMetaDataWriterRegistry ()
void	registerFactory (ossimImageMetaDataWriterFactoryBase *factory)
void	unregisterFactory (ossimImageMetaDataWriterFactoryBase *factory)
bool	findFactory (ossimImageMetaDataWriterFactoryBase *factory) const
virtual ossimObject *	createObject (const ossimString &typeName) const
	Creates an object given a type name. More...
virtual ossimObject *	createObject (const ossimKeywordlist &kwl, const char *prefix=0) const
	Creates and object given a keyword list. More...
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
	Initializes list with meta data types from all registered metadata factories. 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 ossimImageMetaDataWriterRegistry *	instance ()

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

Protected Attributes
std::vector< ossimImageMetaDataWriterFactoryBase * >	theFactoryList

Detailed Description

Definition at line 15 of file ossimImageMetaDataWriterRegistry.h.

Constructor & Destructor Documentation

~ossimImageMetaDataWriterRegistry()

ossimImageMetaDataWriterRegistry::~ossimImageMetaDataWriterRegistry

(

)

Definition at line 24 of file ossimImageMetaDataWriterRegistry.cpp.

References ossimObjectFactoryRegistry::instance(), and ossimFactoryListInterface< T, NativeType >::unregisterFactory().

{
   ossimObjectFactoryRegistry::instance()->unregisterFactory(this);
}

ossimImageMetaDataWriterRegistry() [1/2]

ossimImageMetaDataWriterRegistry::ossimImageMetaDataWriterRegistry ( )

protected

Definition at line 18 of file ossimImageMetaDataWriterRegistry.cpp.

References ossimObjectFactoryRegistry::instance(), ossimImageMetaDataWriterFactory::instance(), registerFactory(), and ossimFactoryListInterface< T, NativeType >::registerFactory().

{
   registerFactory(ossimImageMetaDataWriterFactory::instance());
   ossimObjectFactoryRegistry::instance()->registerFactory(this);
}

ossimImageMetaDataWriterRegistry() [2/2]

ossimImageMetaDataWriterRegistry::ossimImageMetaDataWriterRegistry ( const ossimImageMetaDataWriterRegistry &  rhs )

protected

Definition at line 153 of file ossimImageMetaDataWriterRegistry.cpp.

{
}

Member Function Documentation

createObject() [1/2]

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

virtual

Creates an object given a type name.

Implements ossimObjectFactory.

Definition at line 67 of file ossimImageMetaDataWriterRegistry.cpp.

References theFactoryList.

{
   ossimObject* result = NULL;
   std::vector<ossimImageMetaDataWriterFactoryBase*>::const_iterator factory;
   
   factory = theFactoryList.begin();
   while((factory != theFactoryList.end()) && !result)
   {
      result = (*factory)->createObject(typeName);
      ++factory;
   }
   
   return result;
}

createObject() [2/2]

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

virtual

Creates and object given a keyword list.

Implements ossimObjectFactory.

Definition at line 83 of file ossimImageMetaDataWriterRegistry.cpp.

References theFactoryList.

{
   ossimObject* result = NULL;
   std::vector<ossimImageMetaDataWriterFactoryBase*>::const_iterator factory;

   factory = theFactoryList.begin();
   while((factory != theFactoryList.end()) && !result)
   {
     result = (*factory)->createObject(kwl, prefix);
     ++factory;
   }
   return result;
}

createWriter()

ossimRefPtr< ossimMetadataFileWriter > ossimImageMetaDataWriterRegistry::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 100 of file ossimImageMetaDataWriterRegistry.cpp.

References theFactoryList.

{
   ossimRefPtr<ossimMetadataFileWriter> result = NULL;
   
   std::vector<ossimImageMetaDataWriterFactoryBase*>::const_iterator factory;
   factory = theFactoryList.begin();
   while((factory != theFactoryList.end()) && !result)
   {
     result = (*factory)->createWriter(type);
     ++factory;
   }
   return result;
}

findFactory()

bool ossimImageMetaDataWriterRegistry::findFactory

(

ossimImageMetaDataWriterFactoryBase *

factory

)

const

Definition at line 58 of file ossimImageMetaDataWriterRegistry.cpp.

References theFactoryList.

Referenced by registerFactory().

{
   return (std::find(theFactoryList.begin(),
                     theFactoryList.end(),
                     factory)!=theFactoryList.end());
}

getMetadatatypeList()

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

virtual

Initializes list with meta data types from all registered metadata factories.

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

Parameters

metadatatypeList

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

Note

Since this is the master registry for all meta data factories this method starts by clearing the metadatatypeList.

Implements ossimImageMetaDataWriterFactoryBase.

Definition at line 134 of file ossimImageMetaDataWriterRegistry.cpp.

References theFactoryList.

{
   //---
   // Since this is the master registry for all meta data writer factories
   // we will start with a cleared list.
   //---
   metadatatypeList.clear();
   
   std::vector<ossimImageMetaDataWriterFactoryBase*>::const_iterator iter =
      theFactoryList.begin();
   
   while(iter != theFactoryList.end())
   {
      (*iter)->getMetadatatypeList(metadatatypeList);
      ++iter;
   } 
}

getTypeNameList()

void ossimImageMetaDataWriterRegistry::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 114 of file ossimImageMetaDataWriterRegistry.cpp.

References theFactoryList.

{
   std::vector<ossimString> result;
   std::vector<ossimImageMetaDataWriterFactoryBase*>::const_iterator iter =
      theFactoryList.begin();

   while(iter != theFactoryList.end())
   {
      result.clear();
      (*iter)->getTypeNameList(result);

      // now append to the end of the typeList.
      typeList.insert(typeList.end(),
                      result.begin(),
                      result.end());
      ++iter;
   }
}

instance()

ossimImageMetaDataWriterRegistry * ossimImageMetaDataWriterRegistry::instance ( )

static

Definition at line 29 of file ossimImageMetaDataWriterRegistry.cpp.

Referenced by ossimInit::initializeDefaultFactories(), and ossimImageMetaDataWriterRegistryGetInstance().

{
   static ossimImageMetaDataWriterRegistry sharedInstance;

   return &sharedInstance;
}

operator=()

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

protected

Definition at line 159 of file ossimImageMetaDataWriterRegistry.cpp.

{
   return *this;
}

registerFactory()

void ossimImageMetaDataWriterRegistry::registerFactory

(

ossimImageMetaDataWriterFactoryBase *

factory

)

Definition at line 36 of file ossimImageMetaDataWriterRegistry.cpp.

References findFactory(), and theFactoryList.

Referenced by ossimImageMetaDataWriterRegistry().

{
   if(factory&&!findFactory(factory))
   {
      theFactoryList.push_back(factory);
   }
}

unregisterFactory()

void ossimImageMetaDataWriterRegistry::unregisterFactory

(

ossimImageMetaDataWriterFactoryBase *

factory

)

Definition at line 45 of file ossimImageMetaDataWriterRegistry.cpp.

References theFactoryList.

{
   std::vector<ossimImageMetaDataWriterFactoryBase*>::iterator iter =
      std::find(theFactoryList.begin(),
                theFactoryList.end(),
                factory);
   if(iter != theFactoryList.end())
   {
      theFactoryList.erase(iter);
   }
}

Member Data Documentation

theFactoryList

std::vector<ossimImageMetaDataWriterFactoryBase*> ossimImageMetaDataWriterRegistry::theFactoryList

protected

Definition at line 90 of file ossimImageMetaDataWriterRegistry.h.

Referenced by createObject(), createWriter(), findFactory(), getMetadatatypeList(), getTypeNameList(), registerFactory(), and unregisterFactory().

---

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

• ossimImageMetaDataWriterRegistry.h
• ossimImageMetaDataWriterRegistry.cpp