OSSIM - Open Source Software Image Map  Version 1.9.0 (20180803)
Public Member Functions | List of all members
ossimOverviewBuilderFactoryBase Class Referenceabstract

The base class for factory overview builder factories. More...

#include <ossimOverviewBuilderFactoryBase.h>

Inheritance diagram for ossimOverviewBuilderFactoryBase:
ossimObjectFactory ossimObject ossimReferenced ossimGdalOverviewBuilderFactory ossimKakaduOverviewBuilderFactory ossimOverviewBuilderFactory

Public Member Functions

 ossimOverviewBuilderFactoryBase ()
 default constructor hidden from use More...
 
virtual ~ossimOverviewBuilderFactoryBase ()
 virtual destructor More...
 
virtual ossimOverviewBuilderBasecreateBuilder (const ossimString &typeName) const =0
 Creates a builder from a string. More...
 
virtual void getTypeNameList (std::vector< ossimString > &typeList) const =0
 Method to populate a list of supported types for the factory. More...
 
virtual ossimObjectcreateObject (const ossimString &typeName) const
 
virtual ossimObjectcreateObject (const ossimKeywordlist &kwl, const char *prefix=0) const
 
- 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
 

Additional Inherited Members

- Protected Member Functions inherited from ossimReferenced
virtual ~ossimReferenced ()
 

Detailed Description

The base class for factory overview builder factories.

Definition at line 26 of file ossimOverviewBuilderFactoryBase.h.

Constructor & Destructor Documentation

◆ ossimOverviewBuilderFactoryBase()

ossimOverviewBuilderFactoryBase::ossimOverviewBuilderFactoryBase ( )

default constructor hidden from use

Definition at line 42 of file ossimOverviewBuilderFactoryBase.cpp.

43 {
44 }

◆ ~ossimOverviewBuilderFactoryBase()

ossimOverviewBuilderFactoryBase::~ossimOverviewBuilderFactoryBase ( )
virtual

virtual destructor

Definition at line 46 of file ossimOverviewBuilderFactoryBase.cpp.

47 {
48 }

Member Function Documentation

◆ createBuilder()

virtual ossimOverviewBuilderBase* ossimOverviewBuilderFactoryBase::createBuilder ( const ossimString typeName) const
pure virtual

Creates a builder from a string.

This should match a string from the getTypeNameList() method. Pure virtual.

Returns
Pointer to ossimOverviewBuilderBase or NULL is not found within registered factories.

Implemented in ossimKakaduOverviewBuilderFactory, ossimGdalOverviewBuilderFactory, and ossimOverviewBuilderFactory.

Referenced by createObject().

◆ createObject() [1/2]

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

Creates an object given a type name.

Implements ossimObjectFactory.

Definition at line 16 of file ossimOverviewBuilderFactoryBase.cpp.

References createBuilder().

Referenced by createObject().

17 {
18  return createBuilder(typeName);
19 }
virtual ossimOverviewBuilderBase * createBuilder(const ossimString &typeName) const =0
Creates a builder from a string.

◆ createObject() [2/2]

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

Creates and object given a keyword list.

Implements ossimObjectFactory.

Definition at line 21 of file ossimOverviewBuilderFactoryBase.cpp.

References createObject(), ossimString::empty(), ossimKeywordlist::find(), and ossimObject::loadState().

22 {
23  ossimObject* result = 0;
24  ossimString typeValue = kwl.find(prefix, "type");
25  if(!typeValue.empty())
26  {
27  result = createObject(typeValue);
28  if(result)
29  {
30  if(!result->loadState(kwl, prefix))
31  {
32  delete result;
33  result = 0;
34  }
35  }
36  }
37 
38  return result;
39 }
const char * find(const char *key) const
virtual bool loadState(const ossimKeywordlist &kwl, const char *prefix=0)
bool empty() const
Definition: ossimString.h:411
virtual ossimObject * createObject(const ossimString &typeName) const

◆ getTypeNameList()

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

Method to populate a list of supported types for the factory.

registered to this registry. Pure virtual.

Parameters
typeListList of ossimStrings to add to.

Implements ossimObjectFactory.

Implemented in ossimKakaduOverviewBuilderFactory, ossimGdalOverviewBuilderFactory, and ossimOverviewBuilderFactory.


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