Rosetta Utilities  2014.35
Public Member Functions | Private Types | List of all members
basic::datacache::BasicDataCache Class Reference

A DataCache storing objects derived from basic::datacache::CacheableData. More...

#include <BasicDataCache.hh>

Public Member Functions

 BasicDataCache ()
 default constructor More...
 
 BasicDataCache (std::size_t const n_slots)
 size constructor More...
 
 BasicDataCache (BasicDataCache const &rval)
 copy constructor More...
 
virtual ~BasicDataCache ()
 default destructor More...
 
BasicDataCacheoperator= (BasicDataCache const &rval)
 copy assignment More...
 
- Public Member Functions inherited from basic::datacache::DataCache< CacheableData >
 DataCache ()
 default constructor More...
 
 DataCache (std::size_t const n_slots)
 size constructor More...
 
 DataCache (DataCache const &src)
 copy constructor More...
 
virtual ~DataCache ()
 destructor More...
 
DataCacheoperator= (DataCache const &src)
 copy assignment More...
 
size_t size () const
 the number of slots in this cache More...
 
void resize (std::size_t const n_slots)
 resize the cache for the given number of slots More...
 
void clear ()
 clear all stored data More...
 
void clear (std::size_t const slot)
 clear the object in a selected slot More...
 
bool has (std::size_t const slot) const
 is there an object in the slot? More...
 
CacheableDataconst & get (std::size_t const slot) const
 get base class reference to the object stored in the slot More...
 
D const & get (std::size_t const slot) const
 get derived class reference to the object stored in the slot More...
 
CacheableDataget (std::size_t const slot)
 get base class reference to object stored in the slot More...
 
D & get (std::size_t const slot)
 get derived class reference to object stored in the slot More...
 
DataCOP get_const_ptr (std::size_t const slot) const
 get base class owning ptr to object stored in the slot More...
 
utility::pointer::owning_ptr
< D const > 
get_const_ptr (std::size_t const slot) const
 get derived class owning ptr to object stored in the slot More...
 
DataOP get_ptr (std::size_t const slot)
 get base class owning ptr to object stored in the slot More...
 
utility::pointer::owning_ptr< D > get_ptr (std::size_t const slot)
 get derived class owning ptr to object stored in the slot More...
 
CacheableDataconst * get_raw_const_ptr (std::size_t const slot) const
 get base class raw ptr to object stored in the slot More...
 
D const * get_raw_const_ptr (std::size_t const slot) const
 get derived class raw ptr to object stored in the slot More...
 
CacheableDataget_raw_ptr (std::size_t const slot)
 get base class raw ptr to object stored in the slot More...
 
D * get_raw_ptr (std::size_t const slot)
 get derived class raw ptr to object stored in the slot More...
 
void set (std::size_t const slot, DataOP new_data)
 store data in the given slot More...
 
- Public Member Functions inherited from utility::pointer::ReferenceCount
void ctor ()
 
virtual ~ReferenceCount ()
 Destructor. More...
 
Size ref_count () const
 Reference count. More...
 

Private Types

typedef DataCache< CacheableDataSuper
 

Additional Inherited Members

- Public Types inherited from basic::datacache::DataCache< CacheableData >
typedef
utility::pointer::owning_ptr
< CacheableData
DataOP
 
typedef
utility::pointer::owning_ptr
< CacheableDataconst > 
DataCOP
 
typedef
utility::pointer::access_ptr
< CacheableData
DataAP
 
typedef
utility::pointer::access_ptr
< CacheableDataconst > 
DataCAP
 
- Public Types inherited from utility::pointer::ReferenceCount
typedef platform::Size Size
 
typedef platform::Size size_type
 
- Protected Types inherited from basic::datacache::DataCache< CacheableData >
typedef utility::vector1< DataOPDataOPs
 
- Protected Member Functions inherited from basic::datacache::DataCache< CacheableData >
DataOPs const & data () const
 get the storage vector More...
 
DataOPsdata ()
 get the storage vector More...
 
- Protected Member Functions inherited from utility::pointer::ReferenceCount
 ReferenceCount ()
 Default constructor. More...
 
 ReferenceCount (ReferenceCount const &)
 Copy constructor. More...
 
ReferenceCountoperator= (ReferenceCount const &)
 Copy assignment. More...
 

Detailed Description

A DataCache storing objects derived from basic::datacache::CacheableData.

See DataCache base class for usage details.

Member Typedef Documentation

Constructor & Destructor Documentation

basic::datacache::BasicDataCache::BasicDataCache ( )

default constructor

basic::datacache::BasicDataCache::BasicDataCache ( std::size_t const  n_slots)

size constructor

Parameters
[in]n_typesThe number of slots for this DataCache.
basic::datacache::BasicDataCache::BasicDataCache ( BasicDataCache const &  rval)

copy constructor

basic::datacache::BasicDataCache::~BasicDataCache ( )
virtual

default destructor

Member Function Documentation

BasicDataCache & basic::datacache::BasicDataCache::operator= ( BasicDataCache const &  rval)

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