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	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 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 < CacheableStringIntegerMap >	CacheableStringIntegerMapOP

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

typedef utility::pointer::weak_ptr < CacheableStringIntegerMap >	CacheableStringIntegerMapAP

typedef utility::pointer::weak_ptr < CacheableStringIntegerMap const >	CacheableStringIntegerMapCAP

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 < CacheableUint64MathMatrixFloatMap >	CacheableUint64MathMatrixFloatMapOP

typedef utility::pointer::shared_ptr < CacheableUint64MathMatrixFloatMap const >	CacheableUint64MathMatrixFloatMapCOP

typedef utility::pointer::weak_ptr < CacheableUint64MathMatrixFloatMap >	CacheableUint64MathMatrixFloatMapAP

typedef utility::pointer::weak_ptr < CacheableUint64MathMatrixFloatMap const >	CacheableUint64MathMatrixFloatMapCAP

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

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

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

BasicDataCache access pointer.

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

BasicDataCache const access pointer.

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

BasicDataCache const owning pointer.

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

BasicDataCache owning pointer.

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

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

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

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

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

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

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

typedef utility::pointer::weak_ptr< CacheableStringFloatMap > basic::datacache::CacheableStringFloatMapAP

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

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

typedef utility::pointer::shared_ptr< CacheableStringFloatMap > basic::datacache::CacheableStringFloatMapOP

typedef utility::pointer::weak_ptr< CacheableStringIntegerMap > basic::datacache::CacheableStringIntegerMapAP

typedef utility::pointer::weak_ptr< CacheableStringIntegerMap const > basic::datacache::CacheableStringIntegerMapCAP

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

typedef utility::pointer::shared_ptr< CacheableStringIntegerMap > basic::datacache::CacheableStringIntegerMapOP

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

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

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

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

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

typedef utility::pointer::weak_ptr< CacheableUint64MathMatrixFloatMap > basic::datacache::CacheableUint64MathMatrixFloatMapAP

typedef utility::pointer::weak_ptr< CacheableUint64MathMatrixFloatMap const > basic::datacache::CacheableUint64MathMatrixFloatMapCAP

typedef utility::pointer::shared_ptr< CacheableUint64MathMatrixFloatMap const > basic::datacache::CacheableUint64MathMatrixFloatMapCOP

typedef utility::pointer::shared_ptr< CacheableUint64MathMatrixFloatMap > basic::datacache::CacheableUint64MathMatrixFloatMapOP

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

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

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

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

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

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

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

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

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

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

typedef utility::pointer::weak_ptr< WriteableCacheableData > basic::datacache::WriteableCacheableDataAP

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

typedef utility::pointer::shared_ptr< WriteableCacheableDataCreator const > basic::datacache::WriteableCacheableDataCreatorCOP

typedef utility::pointer::shared_ptr< WriteableCacheableDataCreator > basic::datacache::WriteableCacheableDataCreatorOP

typedef utility::pointer::shared_ptr< WriteableCacheableDataFactory const > basic::datacache::WriteableCacheableDataFactoryCOP

typedef utility::pointer::shared_ptr< WriteableCacheableDataFactory > basic::datacache::WriteableCacheableDataFactoryOP

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

typedef utility::pointer::weak_ptr< WriteableCacheableMap > basic::datacache::WriteableCacheableMapAP

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

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

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

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

Function Documentation

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 basic::datacache::DataMap::add(), basic::datacache::DataMap::get_ptr(), basic::datacache::DataMap::has(), name, test.T007_TracerIO::T, TR_hh, and DRRAFTER::type.