SctApi::SctApiConfigCache Class Reference

This is supposed to mirror the module configuration banks on the rod. More...

#include <SctApiConfigCache.h>

Collaboration diagram for SctApi::SctApiConfigCache:

[legend]

Public Member Functions
boost::shared_ptr< ModuleBanks >	getFromMid (const UINT32 mid)
	return shared pointer to the ABCDModule structure, or null shared pointer if it dosent exist.
boost::shared_ptr< const ModuleBanks >	getFromMid (const UINT32 mid) const
void	clearMid (const UINT32 mid)
	clear a module from the cache
void	clearAll ()
	clear all modules.
void	copyAllModules (BankType from, std::list< BankType > to)
	copy from single bank to a set of banks for all modules
void	copyAllModules (BankType from, BankType to)
	copy from single bank to single bank for all modules
void	set (UINT32 mid, boost::shared_ptr< ModuleBanks > banks)
	add a module with a particular MID and bank
	SctApiConfigCache ()
	constructor.
	~SctApiConfigCache ()
	destructor
Private Attributes
std::map< UINT32, boost::shared_ptr< ModuleBanks > >	m_map
	The map itself.
boost::recursive_mutex	cache_mutex
Data Structures
class	ModuleBanks
	Class to hold different ABCDModule configurations for a particular module. More...

---

Detailed Description

This is supposed to mirror the module configuration banks on the rod.

It allows the API to check what the configuration looks like, and to only do updates of those parts which are different.

Definition at line 23 of file SctApiConfigCache.h.

---

Constructor & Destructor Documentation

SctApiConfigCache::SctApiConfigCache (   )

constructor. Definition at line 8 of file SctApiConfigCache.cxx.

SctApiConfigCache::~SctApiConfigCache (   )

destructor Definition at line 11 of file SctApiConfigCache.cxx.

---

Member Function Documentation

void SctApiConfigCache::clearAll (   )

clear all modules. Definition at line 25 of file SctApiConfigCache.cxx. References cache_mutex, and m_map.

void SctApiConfigCache::clearMid (  const UINT32  mid  )

clear a module from the cache Definition at line 19 of file SctApiConfigCache.cxx. References cache_mutex, and m_map.

void SctApiConfigCache::copyAllModules (  BankType  from, BankType  to )

copy from single bank to single bank for all modules Definition at line 45 of file SctApiConfigCache.cxx. References m_map.

void SctApiConfigCache::copyAllModules (  BankType  from, std::list< BankType >  to )

copy from single bank to a set of banks for all modules Definition at line 53 of file SctApiConfigCache.cxx.

shared_ptr< SctApi::SctApiConfigCache::ModuleBanks > SctApiConfigCache::getFromMid (  const UINT32  mid  )

return shared pointer to the ABCDModule structure, or null shared pointer if it dosent exist. Definition at line 30 of file SctApiConfigCache.cxx. References cache_mutex, and m_map. Referenced by SctApi::ScanControlRODHisto::readHistogramData().

void SctApi::SctApiConfigCache::set (  UINT32  mid, boost::shared_ptr< ModuleBanks >  banks )

add a module with a particular MID and bank

---

Field Documentation

std::map<UINT32, boost::shared_ptr<ModuleBanks> > SctApi::SctApiConfigCache::m_map [private]

The map itself. Definition at line 89 of file SctApiConfigCache.h. Referenced by clearAll(), clearMid(), copyAllModules(), and getFromMid().

---

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

• SctApiConfigCache.h
• SctApiConfigCache.cxx

---