Rosetta
Classes | Typedefs | Functions | Variables
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...
 
struct  ResRotPair
 
struct  ResRotPairHasher
 
class  CacheableResRotPairFloatMap
 Wrapper for std::map< uint64_t, MathMatrix<float> > More...
 
class  CacheableString
 Wrapper for std::string. More...
 
class  CacheableStringFloatMap
 Wrapper for std::map< std::string, float > More...
 
class  CacheableStringIntegerMap
 Wrapper for std::map< std::string, integer > More...
 
class  CacheableStringMap
 Wrapper for a map< string, string >. More...
 
class  CacheableUint64MathMatrixFloatMap
 Wrapper for std::map< uint64_t, MathMatrix<float> > 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 VirtualBase 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  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  WriteableCacheableDataFactory
 
class  WriteableCacheableMap
 Wrapper for a map< string, string >. More...
 

Typedefs

typedef utility::pointer::shared_ptr< BasicDataCacheBasicDataCacheOP
 BasicDataCache owning pointer. More...
 
typedef utility::pointer::shared_ptr< BasicDataCache const > BasicDataCacheCOP
 BasicDataCache const owning pointer. More...
 
typedef utility::pointer::weak_ptr< BasicDataCacheBasicDataCacheAP
 BasicDataCache access pointer. More...
 
typedef utility::pointer::weak_ptr< BasicDataCache const > BasicDataCacheCAP
 BasicDataCache const access pointer. More...
 
typedef utility::pointer::shared_ptr< CacheableDataCacheableDataOP
 
typedef utility::pointer::shared_ptr< CacheableData const > CacheableDataCOP
 
typedef utility::pointer::weak_ptr< CacheableDataCacheableDataAP
 
typedef utility::pointer::weak_ptr< CacheableData const > CacheableDataCAP
 
typedef utility::pointer::shared_ptr< CacheableResRotPairFloatMapCacheableResRotPairFloatMapOP
 
typedef utility::pointer::shared_ptr< CacheableResRotPairFloatMap const > CacheableResRotPairFloatMapCOP
 
typedef utility::pointer::weak_ptr< CacheableResRotPairFloatMapCacheableResRotPairFloatMapAP
 
typedef utility::pointer::weak_ptr< CacheableResRotPairFloatMap const > CacheableResRotPairFloatMapCAP
 
typedef utility::pointer::shared_ptr< CacheableStringCacheableStringOP
 
typedef utility::pointer::shared_ptr< CacheableString const > CacheableStringCOP
 
typedef utility::pointer::weak_ptr< CacheableStringCacheableStringAP
 
typedef utility::pointer::weak_ptr< CacheableString const > CacheableStringCAP
 
typedef utility::pointer::shared_ptr< CacheableStringFloatMapCacheableStringFloatMapOP
 
typedef utility::pointer::shared_ptr< CacheableStringFloatMap const > CacheableStringFloatMapCOP
 
typedef utility::pointer::weak_ptr< CacheableStringFloatMapCacheableStringFloatMapAP
 
typedef utility::pointer::weak_ptr< CacheableStringFloatMap const > CacheableStringFloatMapCAP
 
typedef utility::pointer::shared_ptr< CacheableStringIntegerMapCacheableStringIntegerMapOP
 
typedef utility::pointer::shared_ptr< CacheableStringIntegerMap const > CacheableStringIntegerMapCOP
 
typedef utility::pointer::weak_ptr< CacheableStringIntegerMapCacheableStringIntegerMapAP
 
typedef utility::pointer::weak_ptr< CacheableStringIntegerMap const > CacheableStringIntegerMapCAP
 
typedef utility::pointer::shared_ptr< CacheableStringMapCacheableStringMapOP
 
typedef utility::pointer::shared_ptr< CacheableStringMap const > CacheableStringMapCOP
 
typedef utility::pointer::weak_ptr< CacheableStringMapCacheableStringMapAP
 
typedef utility::pointer::weak_ptr< CacheableStringMap const > CacheableStringMapCAP
 
typedef utility::pointer::shared_ptr< CacheableUint64MathMatrixFloatMapCacheableUint64MathMatrixFloatMapOP
 
typedef utility::pointer::shared_ptr< CacheableUint64MathMatrixFloatMap const > CacheableUint64MathMatrixFloatMapCOP
 
typedef utility::pointer::weak_ptr< CacheableUint64MathMatrixFloatMapCacheableUint64MathMatrixFloatMapAP
 
typedef utility::pointer::weak_ptr< CacheableUint64MathMatrixFloatMap const > CacheableUint64MathMatrixFloatMapCAP
 
typedef utility::pointer::shared_ptr< basic::datacache::ConstDataMapConstDataMapOP
 
typedef utility::pointer::shared_ptr< basic::datacache::ConstDataMap const > ConstDataMapCOP
 
typedef utility::pointer::shared_ptr< DiagnosticDataDiagnosticDataOP
 
typedef utility::pointer::shared_ptr< DiagnosticData const > DiagnosticDataCOP
 
typedef utility::pointer::weak_ptr< DiagnosticDataDiagnosticDataAP
 
typedef utility::pointer::weak_ptr< DiagnosticData const > DiagnosticDataCAP
 
typedef utility::pointer::shared_ptr< HierarchicalDataMapHierarchicalDataMapOP
 
typedef utility::pointer::shared_ptr< HierarchicalDataMap const > HierarchicalDataMapCOP
 
typedef utility::pointer::weak_ptr< HierarchicalDataMapHierarchicalDataMapAP
 
typedef utility::pointer::weak_ptr< HierarchicalDataMap const > HierarchicalDataMapCAP
 
typedef utility::pointer::shared_ptr< WriteableCacheableDataWriteableCacheableDataOP
 
typedef utility::pointer::shared_ptr< WriteableCacheableData const > WriteeableCacheableDataCOP
 
typedef utility::pointer::weak_ptr< WriteableCacheableDataWriteableCacheableDataAP
 
typedef utility::pointer::weak_ptr< WriteableCacheableData const > WriteableCacheableDataCAP
 
typedef utility::pointer::shared_ptr< WriteableCacheableDataCreatorWriteableCacheableDataCreatorOP
 
typedef utility::pointer::shared_ptr< WriteableCacheableDataCreator const > WriteableCacheableDataCreatorCOP
 
typedef utility::pointer::shared_ptr< WriteableCacheableDataFactoryWriteableCacheableDataFactoryOP
 
typedef utility::pointer::shared_ptr< WriteableCacheableDataFactory const > WriteableCacheableDataFactoryCOP
 
typedef utility::pointer::shared_ptr< WriteableCacheableMapWriteableCacheableMapOP
 
typedef utility::pointer::shared_ptr< WriteableCacheableMap const > WriteableCacheableMapCOP
 
typedef utility::pointer::weak_ptr< WriteableCacheableMapWriteableCacheableMapAP
 
typedef utility::pointer::weak_ptr< WriteableCacheableMap const > WriteableCacheableMapCAP
 

Functions

template<class T >
utility::pointer::shared_ptr< Tget_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...
 

Variables

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

Typedef Documentation

◆ BasicDataCacheAP

typedef utility::pointer::weak_ptr< BasicDataCache > basic::datacache::BasicDataCacheAP

BasicDataCache access pointer.

◆ BasicDataCacheCAP

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

BasicDataCache const access pointer.

◆ BasicDataCacheCOP

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

BasicDataCache const owning pointer.

◆ BasicDataCacheOP

typedef utility::pointer::shared_ptr< BasicDataCache > basic::datacache::BasicDataCacheOP

BasicDataCache owning pointer.

◆ CacheableDataAP

typedef utility::pointer::weak_ptr< CacheableData > basic::datacache::CacheableDataAP

◆ CacheableDataCAP

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

◆ CacheableDataCOP

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

◆ CacheableDataOP

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

◆ CacheableResRotPairFloatMapAP

◆ CacheableResRotPairFloatMapCAP

◆ CacheableResRotPairFloatMapCOP

◆ CacheableResRotPairFloatMapOP

◆ CacheableStringAP

typedef utility::pointer::weak_ptr< CacheableString > basic::datacache::CacheableStringAP

◆ CacheableStringCAP

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

◆ CacheableStringCOP

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

◆ CacheableStringFloatMapAP

◆ CacheableStringFloatMapCAP

typedef utility::pointer::weak_ptr< CacheableStringFloatMap const > basic::datacache::CacheableStringFloatMapCAP

◆ CacheableStringFloatMapCOP

typedef utility::pointer::shared_ptr< CacheableStringFloatMap const > basic::datacache::CacheableStringFloatMapCOP

◆ CacheableStringFloatMapOP

◆ CacheableStringIntegerMapAP

◆ CacheableStringIntegerMapCAP

◆ CacheableStringIntegerMapCOP

typedef utility::pointer::shared_ptr< CacheableStringIntegerMap const > basic::datacache::CacheableStringIntegerMapCOP

◆ CacheableStringIntegerMapOP

◆ CacheableStringMapAP

typedef utility::pointer::weak_ptr< CacheableStringMap > basic::datacache::CacheableStringMapAP

◆ CacheableStringMapCAP

typedef utility::pointer::weak_ptr< CacheableStringMap const > basic::datacache::CacheableStringMapCAP

◆ CacheableStringMapCOP

typedef utility::pointer::shared_ptr< CacheableStringMap const > basic::datacache::CacheableStringMapCOP

◆ CacheableStringMapOP

typedef utility::pointer::shared_ptr< CacheableStringMap > basic::datacache::CacheableStringMapOP

◆ CacheableStringOP

typedef utility::pointer::shared_ptr< CacheableString > basic::datacache::CacheableStringOP

◆ CacheableUint64MathMatrixFloatMapAP

◆ CacheableUint64MathMatrixFloatMapCAP

◆ CacheableUint64MathMatrixFloatMapCOP

◆ CacheableUint64MathMatrixFloatMapOP

◆ ConstDataMapCOP

typedef utility::pointer::shared_ptr< basic::datacache::ConstDataMap const > basic::datacache::ConstDataMapCOP

◆ ConstDataMapOP

typedef utility::pointer::shared_ptr< basic::datacache::ConstDataMap > basic::datacache::ConstDataMapOP

◆ DiagnosticDataAP

typedef utility::pointer::weak_ptr< DiagnosticData > basic::datacache::DiagnosticDataAP

◆ DiagnosticDataCAP

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

◆ DiagnosticDataCOP

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

◆ DiagnosticDataOP

typedef utility::pointer::shared_ptr< DiagnosticData > basic::datacache::DiagnosticDataOP

◆ HierarchicalDataMapAP

typedef utility::pointer::weak_ptr< HierarchicalDataMap > basic::datacache::HierarchicalDataMapAP

◆ HierarchicalDataMapCAP

typedef utility::pointer::weak_ptr< HierarchicalDataMap const > basic::datacache::HierarchicalDataMapCAP

◆ HierarchicalDataMapCOP

typedef utility::pointer::shared_ptr< HierarchicalDataMap const > basic::datacache::HierarchicalDataMapCOP

◆ HierarchicalDataMapOP

typedef utility::pointer::shared_ptr< HierarchicalDataMap > basic::datacache::HierarchicalDataMapOP

◆ WriteableCacheableDataAP

◆ WriteableCacheableDataCAP

typedef utility::pointer::weak_ptr< WriteableCacheableData const > basic::datacache::WriteableCacheableDataCAP

◆ WriteableCacheableDataCreatorCOP

◆ WriteableCacheableDataCreatorOP

◆ WriteableCacheableDataFactoryCOP

◆ WriteableCacheableDataFactoryOP

◆ WriteableCacheableDataOP

typedef utility::pointer::shared_ptr< WriteableCacheableData > basic::datacache::WriteableCacheableDataOP

◆ WriteableCacheableMapAP

◆ WriteableCacheableMapCAP

typedef utility::pointer::weak_ptr< WriteableCacheableMap const > basic::datacache::WriteableCacheableMapCAP

◆ WriteableCacheableMapCOP

typedef utility::pointer::shared_ptr< WriteableCacheableMap const > basic::datacache::WriteableCacheableMapCOP

◆ WriteableCacheableMapOP

typedef utility::pointer::shared_ptr< WriteableCacheableMap > basic::datacache::WriteableCacheableMapOP

◆ WriteeableCacheableDataCOP

typedef utility::pointer::shared_ptr< WriteableCacheableData const > basic::datacache::WriteeableCacheableDataCOP

Function Documentation

◆ get_set_from_datamap()

template<class T >
utility::pointer::shared_ptr< T > 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.

References data, pyrosetta.distributed.cluster.exceptions::T, and TR_hh.

Variable Documentation

◆ TR [1/2]

basic::Tracer basic::datacache::TR("basic.datacache.ConstDataMap") ( "basic.datacache.ConstDataMap"  )
static

◆ TR [2/2]

basic::Tracer basic::datacache::TR("basic.datacache.DataMap") ( "basic.datacache.DataMap"  )
static

◆ tr

basic::Tracer basic::datacache::tr("basic.datacache.WriteableCacheableDataFactory", t_trace) ( "basic.datacache.WriteableCacheableDataFactory"  ,
t_trace   
)
static

◆ TR_hh

basic::Tracer basic::datacache::TR_hh("basic.datacache.DataMap_hh") ( "basic.datacache.DataMap_hh"  )
static

Referenced by get_set_from_datamap().