register_maps_types.h File Reference

Header defining types stored within the parameter to register mappings. More...

#include <stdint.h>
#include <map>
#include <string>
#include <vector>

Include dependency graph for register_maps_types.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	RegisterLocation
	Structure holding a location in the registers. More...
struct	Parameter
	A parameter for the HGC ROC includes one or more register locations and a default value defined in the manual. More...
struct	DirectAccessParameter
	A direct access parameter is used to directly configure the HGCROC I2C connection in a fast but simplified manner. More...
class	NoCopyMap< Key, Val >
	forward declare register map LUT types More...

Typedefs
using	Page = NoCopyMap<std::string, Parameter>
	type for hold sets of parameters by name
using	PageLUT = NoCopyMap<std::string, const Page&>
	type for holding a set of abstract pages just associating names with specific sets of parameters
using	ParameterLUT = NoCopyMap<std::string, std::pair<int, const Page&>>
	type for a LUT that holds concrete pages with their address and Page parameters
using	DirectAccessParameterLUT = NoCopyMap<std::string, DirectAccessParameter>
	direct access parameters LUT

Detailed Description

Header defining types stored within the parameter to register mappings.

The specific maps written into the headers corresponding to the names of the HGCROC type/versions rely on this header to join them together into a coherent interface for the compiler and to include the necessary headers they rely upon.