Rosetta
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
Classes | Typedefs | Functions
basic::datacache Namespace Reference

Classes

class  BasicDataCache
 A DataCache storing objects derived from basic::datacache::CacheableData. More...
 
class  CacheableData
 base class for data storable within a DataCache More...
 
class  CacheableString
 Wrapper for std::string. More...
 
class  CacheableStringFloatMap
 Wrapper for std::map< std::string, float > More...
 
class  CacheableStringMap
 Wrapper for a map< string, string >. More...
 
class  ConstDataMap
 general-purpose store for any kind of object with the particular copy semantics of copying by value. This is effectively a map of string pairs to (constant) pointers. The first string represents the category of the object, and the second being a name for that particular object. The guarantee with the ConstDataMap is that if an object is put into the map, it may be read from, but it will not be changed underneath you. Data stored in the ConstDataMap can safely be shared between threads. More...
 
class  DataCache
 forward declaration for DataCache More...
 
class  DataCache_CacheableData
 
class  DataMap
 general-purpose store for any reference-count derived object More...
 
class  DataMapObj
 templated class to make any data type compatible with ReferenceCounts and OPs. e.g., utility::pointer::owning_ptr< basic::datacache::DataMapObj< bool > > stop; You can then place such constructs on the basic::datacache::DataMap More...
 
class  DiagnosticData
 Wrapper for std::map<string, Real> More...
 
class  HierarchicalDataMap
 A data map designed to help create hierarchies with complicated shared data requirements. More...
 
class  WriteableCacheableData
 base class for data storable within a DataCache More...
 
class  WriteableCacheableDataCreator
 Abstract base class for a Mover factory; the Creator class is responsible for creating a particular mover class. More...
 
class  WriteableCacheableDataFactory
 
class  WriteableCacheableDataRegistrator
 This templated class will register an instance of an WriteableCacheableDataCreator (class T) with the WriteableCacheableDataFactory. It will ensure that no WriteableCacheableDataCreator is registered twice, and, centralizes this registration logic so that thread safety issues can be handled in one place. More...
 
class  WriteableCacheableMap
 Wrapper for a map< string, string >. More...
 

Typedefs

typedef
utility::pointer::shared_ptr
< BasicDataCache
BasicDataCacheOP
 BasicDataCache owning pointer. More...
 
typedef
utility::pointer::shared_ptr
< BasicDataCache const > 
BasicDataCacheCOP
 BasicDataCache const owning pointer. More...
 
typedef
utility::pointer::weak_ptr
< BasicDataCache
BasicDataCacheAP
 BasicDataCache access pointer. More...
 
typedef
utility::pointer::weak_ptr
< BasicDataCache const > 
BasicDataCacheCAP
 BasicDataCache const access pointer. More...
 
typedef
utility::pointer::shared_ptr
< CacheableData
CacheableDataOP
 
typedef
utility::pointer::shared_ptr
< CacheableData const > 
CacheableDataCOP
 
typedef
utility::pointer::weak_ptr
< CacheableData
CacheableDataAP
 
typedef
utility::pointer::weak_ptr
< CacheableData const > 
CacheableDataCAP
 
typedef
utility::pointer::shared_ptr
< CacheableString
CacheableStringOP
 
typedef
utility::pointer::shared_ptr
< CacheableString const > 
CacheableStringCOP
 
typedef
utility::pointer::weak_ptr
< CacheableString
CacheableStringAP
 
typedef
utility::pointer::weak_ptr
< CacheableString const > 
CacheableStringCAP
 
typedef
utility::pointer::shared_ptr
< CacheableStringFloatMap
CacheableStringFloatMapOP
 
typedef
utility::pointer::shared_ptr
< CacheableStringFloatMap
const > 
CacheableStringFloatMapCOP
 
typedef
utility::pointer::weak_ptr
< CacheableStringFloatMap
CacheableStringFloatMapAP
 
typedef
utility::pointer::weak_ptr
< CacheableStringFloatMap
const > 
CacheableStringFloatMapCAP
 
typedef
utility::pointer::shared_ptr
< CacheableStringMap
CacheableStringMapOP
 
typedef
utility::pointer::shared_ptr
< CacheableStringMap const > 
CacheableStringMapCOP
 
typedef
utility::pointer::weak_ptr
< CacheableStringMap
CacheableStringMapAP
 
typedef
utility::pointer::weak_ptr
< CacheableStringMap const > 
CacheableStringMapCAP
 
typedef
utility::pointer::shared_ptr
< basic::datacache::ConstDataMap
ConstDataMapOP
 
typedef
utility::pointer::shared_ptr
< basic::datacache::ConstDataMap
const > 
ConstDataMapCOP
 
typedef
utility::pointer::shared_ptr
< DiagnosticData
DiagnosticDataOP
 
typedef
utility::pointer::shared_ptr
< DiagnosticData const > 
DiagnosticDataCOP
 
typedef
utility::pointer::weak_ptr
< DiagnosticData
DiagnosticDataAP
 
typedef
utility::pointer::weak_ptr
< DiagnosticData const > 
DiagnosticDataCAP
 
typedef
utility::pointer::shared_ptr
< HierarchicalDataMap
HierarchicalDataMapOP
 
typedef
utility::pointer::shared_ptr
< HierarchicalDataMap const > 
HierarchicalDataMapCOP
 
typedef
utility::pointer::weak_ptr
< HierarchicalDataMap
HierarchicalDataMapAP
 
typedef
utility::pointer::weak_ptr
< HierarchicalDataMap const > 
HierarchicalDataMapCAP
 
typedef
utility::pointer::shared_ptr
< WriteableCacheableData
WriteableCacheableDataOP
 
typedef
utility::pointer::shared_ptr
< WriteableCacheableData const > 
WriteeableCacheableDataCOP
 
typedef
utility::pointer::weak_ptr
< WriteableCacheableData
WriteableCacheableDataAP
 
typedef
utility::pointer::weak_ptr
< WriteableCacheableData const > 
WriteableCacheableDataCAP
 
typedef
utility::pointer::shared_ptr
< WriteableCacheableDataCreator
WriteableCacheableDataCreatorOP
 
typedef
utility::pointer::shared_ptr
< WriteableCacheableDataCreator
const > 
WriteableCacheableDataCreatorCOP
 
typedef
utility::pointer::shared_ptr
< WriteableCacheableDataFactory
WriteableCacheableDataFactoryOP
 
typedef
utility::pointer::shared_ptr
< WriteableCacheableDataFactory
const > 
WriteableCacheableDataFactoryCOP
 
typedef
utility::pointer::shared_ptr
< WriteableCacheableMap
WriteableCacheableMapOP
 
typedef
utility::pointer::shared_ptr
< WriteableCacheableMap const > 
WriteableCacheableMapCOP
 
typedef
utility::pointer::weak_ptr
< WriteableCacheableMap
WriteableCacheableMapAP
 
typedef
utility::pointer::weak_ptr
< WriteableCacheableMap const > 
WriteableCacheableMapCAP
 

Functions

static THREAD_LOCAL basic::Tracer TR ("basic.datacache.ConstDataMap")
 
static THREAD_LOCAL basic::Tracer TR ("basic.datacache.DataMap")
 
static THREAD_LOCAL basic::Tracer TR_hh ("basic.datacache.DataMap_hh")
 
template<class Ty >
utility::pointer::shared_ptr< Ty > get_set_from_datamap (std::string const &type, std::string const &name, basic::datacache::DataMap &data)
 templated function for adding or getting an item from the datamap. Automatically checks whether an item of the requested type and name exists on the datamap. If so, returns the OP for that item, if not, instantiates that item on the datamap and returns the OP for it. More...
 
static THREAD_LOCAL basic::Tracer tr ("basic.datacache.WriteableCacheableDataFactory", t_trace)
 

Typedef Documentation

BasicDataCache access pointer.

Definition at line 47 of file BasicDataCache.fwd.hh.

typedef utility::pointer::weak_ptr< BasicDataCache const > basic::datacache::BasicDataCacheCAP

BasicDataCache const access pointer.

Definition at line 51 of file BasicDataCache.fwd.hh.

typedef utility::pointer::shared_ptr< BasicDataCache const > basic::datacache::BasicDataCacheCOP

BasicDataCache const owning pointer.

Definition at line 43 of file BasicDataCache.fwd.hh.

BasicDataCache owning pointer.

Definition at line 35 of file BasicDataCache.fwd.hh.

Definition at line 37 of file CacheableData.fwd.hh.

typedef utility::pointer::weak_ptr< CacheableData const > basic::datacache::CacheableDataCAP

Definition at line 38 of file CacheableData.fwd.hh.

typedef utility::pointer::shared_ptr< CacheableData const > basic::datacache::CacheableDataCOP

Definition at line 36 of file CacheableData.fwd.hh.

typedef utility::pointer::shared_ptr< CacheableData > basic::datacache::CacheableDataOP

Definition at line 34 of file CacheableData.fwd.hh.

Definition at line 38 of file CacheableString.fwd.hh.

typedef utility::pointer::weak_ptr< CacheableString const > basic::datacache::CacheableStringCAP

Definition at line 39 of file CacheableString.fwd.hh.

typedef utility::pointer::shared_ptr< CacheableString const > basic::datacache::CacheableStringCOP

Definition at line 37 of file CacheableString.fwd.hh.

Definition at line 38 of file CacheableStringFloatMap.fwd.hh.

Definition at line 39 of file CacheableStringFloatMap.fwd.hh.

Definition at line 37 of file CacheableStringFloatMap.fwd.hh.

Definition at line 35 of file CacheableStringFloatMap.fwd.hh.

Definition at line 38 of file CacheableStringMap.fwd.hh.

Definition at line 39 of file CacheableStringMap.fwd.hh.

Definition at line 37 of file CacheableStringMap.fwd.hh.

Definition at line 35 of file CacheableStringMap.fwd.hh.

Definition at line 35 of file CacheableString.fwd.hh.

Definition at line 27 of file ConstDataMap.fwd.hh.

Definition at line 24 of file ConstDataMap.fwd.hh.

Definition at line 38 of file DiagnosticData.fwd.hh.

typedef utility::pointer::weak_ptr< DiagnosticData const > basic::datacache::DiagnosticDataCAP

Definition at line 39 of file DiagnosticData.fwd.hh.

typedef utility::pointer::shared_ptr< DiagnosticData const > basic::datacache::DiagnosticDataCOP

Definition at line 37 of file DiagnosticData.fwd.hh.

Definition at line 35 of file DiagnosticData.fwd.hh.

Definition at line 22 of file HierarchicalDataMap.fwd.hh.

Definition at line 23 of file HierarchicalDataMap.fwd.hh.

Definition at line 21 of file HierarchicalDataMap.fwd.hh.

Definition at line 18 of file HierarchicalDataMap.fwd.hh.

Definition at line 37 of file WriteableCacheableData.fwd.hh.

Definition at line 38 of file WriteableCacheableData.fwd.hh.

Definition at line 42 of file WriteableCacheableDataCreator.hh.

Definition at line 41 of file WriteableCacheableDataCreator.hh.

Definition at line 25 of file WriteableCacheableDataFactory.fwd.hh.

Definition at line 22 of file WriteableCacheableDataFactory.fwd.hh.

Definition at line 34 of file WriteableCacheableData.fwd.hh.

Definition at line 38 of file WriteableCacheableMap.fwd.hh.

Definition at line 39 of file WriteableCacheableMap.fwd.hh.

Definition at line 37 of file WriteableCacheableMap.fwd.hh.

Definition at line 35 of file WriteableCacheableMap.fwd.hh.

Definition at line 36 of file WriteableCacheableData.fwd.hh.

Function Documentation

template<class Ty >
utility::pointer::shared_ptr< Ty > basic::datacache::get_set_from_datamap ( std::string const &  type,
std::string const &  name,
basic::datacache::DataMap data 
)

templated function for adding or getting an item from the datamap. Automatically checks whether an item of the requested type and name exists on the datamap. If so, returns the OP for that item, if not, instantiates that item on the datamap and returns the OP for it.

Definition at line 144 of file DataMap.hh.

References basic::datacache::DataMap::add(), basic::datacache::DataMap::get_ptr(), basic::datacache::DataMap::has(), name, and TR_hh().

static THREAD_LOCAL basic::Tracer basic::datacache::TR ( "basic.datacache.DataMap"  )
static
static THREAD_LOCAL basic::Tracer basic::datacache::tr ( "basic.datacache.WriteableCacheableDataFactory"  ,
t_trace   
)
static
static THREAD_LOCAL basic::Tracer basic::datacache::TR ( "basic.datacache.ConstDataMap"  )
static
static THREAD_LOCAL basic::Tracer basic::datacache::TR_hh ( "basic.datacache.DataMap_hh"  )
static

Referenced by get_set_from_datamap().