ora::UniqueRef< T > Class Template Reference

#include <UniqueRef.h>

Public Member Functions
void *	address () const
template<class C >
UniqueRef< T > &	cast (const UniqueRef< C > &)
template<class C >
ora::UniqueRef< T > &	cast (const UniqueRef< C > &aPtr)
T *	get () const
bool	isLoaded () const
boost::shared_ptr< IPtrLoader > &	loader () const
	operator bool () const
bool	operator! () const
template<class C >
bool	operator!= (const UniqueRef< C > &aPtr) const
T &	operator* () const
T *	operator-> () const
UniqueRef< T > &	operator= (T *)
UniqueRef< T > &	operator= (const UniqueRef< T > &)
template<class C >
UniqueRef< T > &	operator= (const UniqueRef< C > &)
template<class C >
ora::UniqueRef< T > &	operator= (const UniqueRef< C > &aPtr)
template<class C >
bool	operator== (const UniqueRef< C > &aPtr) const
void	reset ()
boost::shared_ptr< T > &	share () const
const std::type_info *	typeInfo () const
	UniqueRef ()
	UniqueRef (T *anObject)
	UniqueRef (const UniqueRef< T > &)
template<class C >
	UniqueRef (const UniqueRef< C > &)
virtual	~UniqueRef ()

Private Member Functions
T *	ptr (bool throw_flag) const

Private Attributes
bool	m_isLoaded
boost::shared_ptr< IPtrLoader >	m_loader
boost::shared_ptr< T >	m_ptr

Detailed Description

template<typename T>
class ora::UniqueRef< T >

Templated class for the persistency of associated objects. Same features as Ptr (lazy loading) + support of polymorhism .

Definition at line 13 of file UniqueRef.h.

Constructor & Destructor Documentation

template<class T >

ora::UniqueRef< T >::UniqueRef

(

)

Definition at line 114 of file UniqueRef.h.

                                              :
  m_ptr(),m_loader(),m_isLoaded(false) {}

template<class T >

ora::UniqueRef< T >::UniqueRef ( T *  anObject )

explicit

Definition at line 117 of file UniqueRef.h.

                                                         :
  m_ptr(anObject),m_loader(),m_isLoaded(true) {}

template<class T >

ora::UniqueRef< T >::UniqueRef

(

const UniqueRef< T > &

aPtr

)

Definition at line 120 of file UniqueRef.h.

                                                                      :
  m_ptr(aPtr.m_ptr),m_loader(aPtr.m_loader),m_isLoaded(false){
}

template<class T >

template<class C >

ora::UniqueRef< T >::UniqueRef

(

const UniqueRef< C > &

aPtr

)

Definition at line 125 of file UniqueRef.h.

References assert(), EnergyCorrector::c, funct::C, and tree::t.

                                                                      :
  m_ptr(aPtr.share()),m_loader(aPtr.loader()),m_isLoaded(aPtr.isLoaded()) {
  // compile-time type checking
  C* c = 0; T* t(c); assert(t==0);
}

template<class T >

ora::UniqueRef< T >::~UniqueRef ( )

virtual

Definition at line 131 of file UniqueRef.h.

                                               {
}

Member Function Documentation

template<class T >

void * ora::UniqueRef< T >::address

(

)

const

Definition at line 184 of file UniqueRef.h.

Referenced by ora::UniqueRef< T >::operator==().

                                                         {
  return m_ptr.get();  
}

template<typename T>

template<class C >

UniqueRef<T>& ora::UniqueRef< T >::cast

(

const UniqueRef< C > &

)

template<typename T>

template<class C >

ora::UniqueRef<T>& ora::UniqueRef< T >::cast

(

const UniqueRef< C > &

aPtr

)

Definition at line 159 of file UniqueRef.h.

References ora::UniqueRef< T >::isLoaded(), ora::UniqueRef< T >::loader(), reset(), and ora::UniqueRef< T >::share().

                                                                                                    {
  reset();
  m_loader = aPtr.loader();
  m_ptr = boost::dynamic_pointer_cast(aPtr.share());
  m_isLoaded = aPtr.isLoaded();
  return *this;  
}

template<class T >

T * ora::UniqueRef< T >::get

(

)

const

Definition at line 175 of file UniqueRef.h.

Referenced by Options.Options::__getitem__(), betterConfigParser.BetterConfigParser::__updateDict(), rrapi.RRApi::columns(), rrapi.RRApi::count(), rrapi.RRApi::data(), betterConfigParser.BetterConfigParser::getCompares(), betterConfigParser.BetterConfigParser::getGeneral(), betterConfigParser.BetterConfigParser::getResultingSection(), rrapi.RRApi::report(), rrapi.RRApi::reports(), rrapi.RRApi::tables(), rrapi.RRApi::tags(), rrapi.RRApi::templates(), and rrapi.RRApi::workspaces().

                                                  {
  return ptr(false);  
}

template<typename T>

bool ora::UniqueRef< T >::isLoaded ( ) const

inline

Definition at line 89 of file UniqueRef.h.

References ora::UniqueRef< T >::m_isLoaded.

Referenced by ora::UniqueRef< T >::cast(), core.AutoHandle.AutoHandle::Load(), ora::UniqueRef< T >::operator=(), and core.AutoHandle.AutoHandle::product().

                          {
      return m_isLoaded;
    }

template<typename T>

boost::shared_ptr<IPtrLoader>& ora::UniqueRef< T >::loader ( ) const

inline

Definition at line 84 of file UniqueRef.h.

References ora::UniqueRef< T >::m_loader.

Referenced by ora::UniqueRef< T >::cast(), and ora::UniqueRef< T >::operator=().

                                                {
      return m_loader;
    }

template<class T >

ora::UniqueRef< T >::operator bool

(

)

const

Definition at line 194 of file UniqueRef.h.

                                                        {
  return ptr(false);
}

template<class T >

bool ora::UniqueRef< T >::operator!

(

)

const

Definition at line 198 of file UniqueRef.h.

                                                         {
  return ptr(false)==0;
}

template<typename T>

template<class C >

bool ora::UniqueRef< T >::operator!= ( const UniqueRef< C > &  aPtr ) const

inline

Definition at line 74 of file UniqueRef.h.

References ora::UniqueRef< T >::operator==().

                                                    {
      return !(this->operator==(aPtr));     
    }

template<class T >

T & ora::UniqueRef< T >::operator*

(

)

const

Definition at line 171 of file UniqueRef.h.

                                                       {
  return *ptr(true);
}

template<class T >

T * ora::UniqueRef< T >::operator->

(

)

const

Definition at line 167 of file UniqueRef.h.

                                                        {
  return ptr(true);
}

template<class T >

ora::UniqueRef< T > & ora::UniqueRef< T >::operator=

(

T *

aPtr

)

Definition at line 134 of file UniqueRef.h.

References reset().

                                                                      {
  reset();
  m_ptr.reset(aPtr);
  m_isLoaded = true;
  return *this;
}

template<class T >

ora::UniqueRef< T > & ora::UniqueRef< T >::operator=

(

const UniqueRef< T > &

aPtr

)

Definition at line 141 of file UniqueRef.h.

References ora::UniqueRef< T >::m_isLoaded, ora::UniqueRef< T >::m_loader, ora::UniqueRef< T >::m_ptr, and reset().

                                                                                      {
  reset();
  m_loader = aPtr.m_loader;
  m_ptr = aPtr.m_ptr;
  m_isLoaded = aPtr.m_isLoaded;
  return *this;  
}

template<typename T>

template<class C >

UniqueRef<T>& ora::UniqueRef< T >::operator=

(

const UniqueRef< C > &

)

template<typename T>

template<class C >

ora::UniqueRef<T>& ora::UniqueRef< T >::operator=

(

const UniqueRef< C > &

aPtr

)

Definition at line 150 of file UniqueRef.h.

References assert(), EnergyCorrector::c, funct::C, ora::UniqueRef< T >::isLoaded(), ora::UniqueRef< T >::loader(), reset(), ora::UniqueRef< T >::share(), and tree::t.

                                                                                      {
  C* c = 0; T* t(c); assert(t==0);
  reset();
  m_loader = aPtr.loader();
  m_ptr = aPtr.share();
  m_isLoaded = aPtr.isLoaded();
  return *this;  
}

template<typename T>

template<class C >

bool ora::UniqueRef< T >::operator== ( const UniqueRef< C > &  aPtr ) const

inline

Definition at line 70 of file UniqueRef.h.

References ora::UniqueRef< T >::address(), funct::C, and ora::UniqueRef< T >::m_ptr.

Referenced by ora::UniqueRef< T >::operator!=().

                                                    {
      return m_ptr == static_cast<C*>(aPtr.address());
    }

template<class T >

T * ora::UniqueRef< T >::ptr ( bool  throw_flag ) const

private

Definition at line 208 of file UniqueRef.h.

References ora::throwException().

                                                               {
  if(!m_ptr.get()){
    if(!m_loader.get()){
      if(throwFlag) throwException("Loader is not installed.",
                                   "UniqueRef::ptr()");
    }
    if(!m_isLoaded && m_loader.get()){
      m_ptr.reset( static_cast<T*>(m_loader->load()));
      m_isLoaded = true;
    }
  }
  if(!m_ptr.get()){
    if(throwFlag) throwException("Underlying pointer is null.",
                                 "UniqueRef::ptr()");    
  }
  return m_ptr.get();
}

template<class T >

void ora::UniqueRef< T >::reset

(

void

)

Definition at line 202 of file UniqueRef.h.

Referenced by MatrixReader.MatrixReader::__init__(), and MatrixReader.MatrixReader::showRaw().

                                              {
  m_ptr.reset();
  m_loader.reset();
  m_isLoaded = false;
}

template<class T >

boost::shared_ptr< T > & ora::UniqueRef< T >::share ( ) const

inline

Definition at line 180 of file UniqueRef.h.

Referenced by ora::UniqueRef< T >::cast(), and ora::UniqueRef< T >::operator=().

                                                        {
  return m_ptr;
}

template<class T >

const std::type_info * ora::UniqueRef< T >::typeInfo

(

)

const

Definition at line 188 of file UniqueRef.h.

References run_regression::ret.

                                                                        {
  const std::type_info* ret = 0;
  if(m_ptr) ret = &typeid(*m_ptr);
  return ret;
}

Member Data Documentation

template<typename T>

bool ora::UniqueRef< T >::m_isLoaded

mutableprivate

Definition at line 107 of file UniqueRef.h.

Referenced by ora::UniqueRef< T >::isLoaded(), and ora::UniqueRef< T >::operator=().

template<typename T>

boost::shared_ptr<IPtrLoader> ora::UniqueRef< T >::m_loader

mutableprivate

Definition at line 104 of file UniqueRef.h.

Referenced by ora::UniqueRef< T >::loader(), and ora::UniqueRef< T >::operator=().

template<typename T>

boost::shared_ptr<T> ora::UniqueRef< T >::m_ptr

mutableprivate

Definition at line 101 of file UniqueRef.h.

Referenced by ora::UniqueRef< T >::operator=(), and ora::UniqueRef< T >::operator==().