ossim::FactoryListBase< T > Class Template Reference

#include <FactoryListBase.h>

Public Types
typedef std::vector< T >	FactoryListType
typedef std::vector< ossimString >	TypeNameList

Public Member Functions
	FactoryListBase ()
void	addFactory (T factory)
	This is for backward compatability and calls registerFactory for simple adds. More...
bool	isFactoryRegistered (T factory) const
	Public access method to determine if a factory is already registered to this list. More...
void	registerFactory (T factory, bool pushToFrontFlag=false)
	Will register a factory to the factory list. More...
void	unregisterFactory (T factory)
	Will remove the factory from the registry. More...
void	unregisterAllFactories ()
	Will remove all factories from the registry. More...
void	registerFactoryToFront (T factory)
	Inserts the factory to the front of the list. More...
void	registerFactoryBefore (T factory, T beforeThisFactory)
	Will insert the factory before the beforeThisFactory. More...

Protected Member Functions
bool	findFactory (T factory) const
	Utility to find a factory in the list. More...

Protected Attributes
ossim::RWLock	m_rwlock
FactoryListType	m_factoryList

Detailed Description

template<class T>
class ossim::FactoryListBase< T >

Definition at line 20 of file FactoryListBase.h.

Member Typedef Documentation

FactoryListType

template<class T>

typedef std::vector<T> ossim::FactoryListBase< T >::FactoryListType

Definition at line 23 of file FactoryListBase.h.

TypeNameList

template<class T>

typedef std::vector<ossimString> ossim::FactoryListBase< T >::TypeNameList

Definition at line 24 of file FactoryListBase.h.

Constructor & Destructor Documentation

FactoryListBase()

template<class T>

ossim::FactoryListBase< T >::FactoryListBase ( )

inline

Definition at line 26 of file FactoryListBase.h.

{}

Member Function Documentation

addFactory()

template<class T>

void ossim::FactoryListBase< T >::addFactory ( T  factory )

inline

This is for backward compatability and calls registerFactory for simple adds.

Definition at line 31 of file FactoryListBase.h.

        {
           registerFactory(factory);
        }

findFactory()

template<class T>

bool ossim::FactoryListBase< T >::findFactory ( T  factory ) const

inlineprotected

Utility to find a factory in the list.

Definition at line 133 of file FactoryListBase.h.

Referenced by ossim::FactoryListBase< std::shared_ptr< ossim::StateFactoryBase< std::shared_ptr< ossim::ImageHandlerState > > > >::isFactoryRegistered(), ossim::FactoryListBase< std::shared_ptr< ossim::StateFactoryBase< std::shared_ptr< ossim::ImageHandlerState > > > >::registerFactory(), ossim::FactoryListBase< std::shared_ptr< ossim::StateFactoryBase< std::shared_ptr< ossim::ImageHandlerState > > > >::registerFactoryBefore(), and ossim::FactoryListBase< std::shared_ptr< ossim::StateFactoryBase< std::shared_ptr< ossim::ImageHandlerState > > > >::registerFactoryToFront().

        {
           if(!factory) return false;
           ossim_uint32 idx = 0;
           for(const auto& testFactory:m_factoryList)
           {
              if(factory == testFactory)
              {
                return true;
              }
           }
           return false;
        }

isFactoryRegistered()

template<class T>

bool ossim::FactoryListBase< T >::isFactoryRegistered ( T  factory ) const

inline

Public access method to determine if a factory is already registered to this list.

Definition at line 40 of file FactoryListBase.h.

        {
           if(!factory) return false;
           ScopeReadLock scopedReadLock(m_rwlock);
           
           return findFactory(factory);
        }

registerFactory()

template<class T>

void ossim::FactoryListBase< T >::registerFactory ( T  factory, bool  pushToFrontFlag = false  )

inline

Will register a factory to the factory list.

Will append the passed in factory if not already registered to the list.

Definition at line 52 of file FactoryListBase.h.

Referenced by ossim::FactoryListBase< std::shared_ptr< ossim::StateFactoryBase< std::shared_ptr< ossim::ImageHandlerState > > > >::addFactory().

        {
           if(!factory) return;
           ScopeWriteLock scopedWriteLock(m_rwlock);
           if(!findFactory(factory))
           {
              if (pushToFrontFlag)
              {
                 m_factoryList.insert(m_factoryList.begin(), factory);
              }
              else
              {
                 m_factoryList.push_back(factory);
              }
           }
        }

registerFactoryBefore()

template<class T>

void ossim::FactoryListBase< T >::registerFactoryBefore ( T  factory, T  beforeThisFactory  )

inline

Will insert the factory before the beforeThisFactory.

If not found it will do a simple append.

Definition at line 110 of file FactoryListBase.h.

        {
          ScopeWriteLock scopedWriteLock(m_rwlock);

           if(!findFactory(factory))
           {
              ossim_uint32 idx = 0;
              for(idx = 0; idx < m_factoryList.size(); ++idx)
              {
                 if(beforeThisFactory == m_factoryList[idx])
                 {
                    m_factoryList.insert(m_factoryList.begin() + idx, factory);
                    return;
                 }
              }
              m_factoryList.push_back(factory);
           }
        }

registerFactoryToFront()

template<class T>

void ossim::FactoryListBase< T >::registerFactoryToFront ( T  factory )

inline

Inserts the factory to the front of the list.

Definition at line 97 of file FactoryListBase.h.

        {
          ScopeWriteLock scopedWriteLock(m_rwlock);
          if(!findFactory(factory))
          {
            m_factoryList.insert(m_factoryList.begin(), factory);
          }
        }

unregisterAllFactories()

template<class T>

void ossim::FactoryListBase< T >::unregisterAllFactories ( )

inline

Will remove all factories from the registry.

Definition at line 88 of file FactoryListBase.h.

        {
          ScopeWriteLock scopedWriteLock(m_rwlock);
          m_factoryList.clear();
        }

unregisterFactory()

template<class T>

void ossim::FactoryListBase< T >::unregisterFactory ( T  factory )

inline

Will remove the factory from the registry.

Definition at line 71 of file FactoryListBase.h.

        {
          ScopeWriteLock scopedWriteLock(m_rwlock);
          ossim_uint32 idx = 0;
          for(idx = 0; idx < m_factoryList.size(); ++idx)
          {
            if(factory == m_factoryList[idx])
            {
               m_factoryList.erase(m_factoryList.begin() + idx);
               return;
            }
          }
        }

Member Data Documentation

m_factoryList

template<class T>

FactoryListType ossim::FactoryListBase< T >::m_factoryList

protected

Definition at line 148 of file FactoryListBase.h.

Referenced by ossim::FactoryListBase< std::shared_ptr< ossim::StateFactoryBase< std::shared_ptr< ossim::ImageHandlerState > > > >::findFactory(), ossim::FactoryListBase< std::shared_ptr< ossim::StateFactoryBase< std::shared_ptr< ossim::ImageHandlerState > > > >::registerFactory(), ossim::FactoryListBase< std::shared_ptr< ossim::StateFactoryBase< std::shared_ptr< ossim::ImageHandlerState > > > >::registerFactoryBefore(), ossim::FactoryListBase< std::shared_ptr< ossim::StateFactoryBase< std::shared_ptr< ossim::ImageHandlerState > > > >::registerFactoryToFront(), ossim::FactoryListBase< std::shared_ptr< ossim::StateFactoryBase< std::shared_ptr< ossim::ImageHandlerState > > > >::unregisterAllFactories(), and ossim::FactoryListBase< std::shared_ptr< ossim::StateFactoryBase< std::shared_ptr< ossim::ImageHandlerState > > > >::unregisterFactory().

m_rwlock

template<class T>

ossim::RWLock ossim::FactoryListBase< T >::m_rwlock

mutableprotected

Definition at line 147 of file FactoryListBase.h.

Referenced by ossim::FactoryListBase< std::shared_ptr< ossim::StateFactoryBase< std::shared_ptr< ossim::ImageHandlerState > > > >::isFactoryRegistered(), ossim::FactoryListBase< std::shared_ptr< ossim::StateFactoryBase< std::shared_ptr< ossim::ImageHandlerState > > > >::registerFactory(), ossim::FactoryListBase< std::shared_ptr< ossim::StateFactoryBase< std::shared_ptr< ossim::ImageHandlerState > > > >::registerFactoryBefore(), ossim::FactoryListBase< std::shared_ptr< ossim::StateFactoryBase< std::shared_ptr< ossim::ImageHandlerState > > > >::registerFactoryToFront(), ossim::FactoryListBase< std::shared_ptr< ossim::StateFactoryBase< std::shared_ptr< ossim::ImageHandlerState > > > >::unregisterAllFactories(), and ossim::FactoryListBase< std::shared_ptr< ossim::StateFactoryBase< std::shared_ptr< ossim::ImageHandlerState > > > >::unregisterFactory().

---

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

• FactoryListBase.h