scarab Namespace Reference

Classes
class	authentication
class	base_registrar
class	base_registrar< XBaseType, void >
class	cancelable
class	concurrent_queue
class	config_decorator
	Adds the ability to create options and subcommands that are tied to a main_app's master config. More...
class	configurator
class	destroyer
struct	dig_calib_params
struct	do_a_thing
class	error
class	factory
class	factory< XBaseType, void >
struct	get_or_set
struct	is_unique
struct	is_unique_impl
struct	is_unique_impl< T, FirstType >
class	logger
class	main_app
	Primary application class. More...
class	map_deref_iterator
class	nonoption_parser
class	param
class	param_array
class	param_input_codec
class	param_input_json
	Convert JSON to Param. More...
class	param_input_yaml
	Convert YAML to Param. More...
class	param_node
class	param_output_codec
class	param_output_json
	Convert Param to JSON. More...
class	param_output_yaml
	Convert Param to YAML. More...
class	param_translator
class	param_value
class	parsable
class	parser
class	registrar
class	registrar< XBaseType, XDerivedType, void >
class	signal_handler
struct	simple_parser
class	singleton
struct	type_list
struct	unique_append_impl
struct	unique_append_impl< T, type_list< ListItems... > >
struct	unique_append_impl< T, type_list<> >
class	version
class	version_ifc
class	version_semantic
class	version_wrapper

Typedefs
typedef CLI::App	app
typedef std::deque< std::unique_ptr< param > >	param_array_contents
typedef boost::indirect_iterator< param_array_contents::iterator, param >	param_array_iterator
typedef boost::indirect_iterator< param_array_contents::const_iterator, const param >	param_array_const_iterator
typedef std::unique_ptr< param >	param_ptr_t
typedef std::map< std::string, std::unique_ptr< param > >	param_node_contents
typedef map_deref_iterator< std::string, param, param_node_contents::iterator >	param_node_iterator
typedef map_deref_iterator< std::string, const param, param_node_contents::const_iterator >	param_node_const_iterator
typedef fs::path	path
template<typename T , typename List >
using	unique_append = typename unique_append_impl< T, List >::type

Functions
	LOGGER (mtlog,"authentication")
	LOGGER (applog,"application")
	LOGGER (slog,"configurator")
	LOGGER (dlog,"parsable")
const string &	EndColor ()
const string &	FatalColor ()
const string &	ErrorColor ()
const string &	WarnColor ()
const string &	InfoColor ()
const string &	ProgColor ()
const string &	DebugColor ()
const string &	TraceColor ()
const string &	OtherColor ()
	LOGGER (dlog,"param")
	REGISTER_PARAM_INPUT_CODEC (param_input_json,"json")
	REGISTER_PARAM_OUTPUT_CODEC (param_output_json,"json")
	LOGGER (dlog_param_json,"param_json")
	LOGGER (slog,"param_yaml")
	REGISTER_PARAM_INPUT_CODEC (param_input_yaml,"yaml")
	REGISTER_PARAM_OUTPUT_CODEC (param_output_yaml,"yaml")
SCARAB_API std::ostream &	operator<< (std::ostream &out, const param_array &a_value)
SCARAB_API std::ostream &	operator<< (std::ostream &out, const param &a_value)
SCARAB_API std::ostream &	operator<< (std::ostream &out, const param_node &a_value)
SCARAB_API std::ostream &	operator<< (std::ostream &out, const param_value &a_value)
template<>
std::string	param_value::as< std::string > () const
template<>
scarab::path	param_value::as< scarab::path > () const
int	throw_exception ()
int	foo2 ()
int	foo1 ()
	LOGGER (slog,"cancelable")
	LOGGER (slog_cq,"concurrent_queue")
void	get_calib_params (unsigned n_bits, unsigned data_type_size, double v_offset, double v_range, bool bits_r_aligned, dig_calib_params *params)
void	get_calib_params2 (unsigned n_bits, unsigned data_type_size, double v_offset, double v_range, double dac_gain, bool bits_r_aligned, dig_calib_params *params)
template<typename dig_type , typename an_type >
an_type	d2a (dig_type dig, const struct dig_calib_params *params)
template<typename an_type , typename dig_type >
dig_type	a2d (an_type analog, const struct dig_calib_params *params)
	LOGGER (slog_fact,"factory")
template<typename x_key , typename x_value >
const x_value &	at (const std::map< x_key, x_value > &a_map, const x_key &a_key, const x_value &a_default)
path	expand_path (const string &a_path)
	LOGGER (slog,"signal_handler")
void	terminate ()
std::string	get_formatted_now ()
std::string	demangle (const char *a_name)
template<class x_type >
std::string	type (const x_type &a_param)
	LOGGER (slog,"scarab_version")

Variables
char	date_time_format [] = "%Y-%m-%dT%H:%M:%SZ"

Detailed Description

The standard scarab namespace.

Typedef Documentation

typedef CLI::App app

Definition at line 18 of file application.hh.

typedef boost::indirect_iterator< param_array_contents::const_iterator, const param > param_array_const_iterator

Definition at line 29 of file param_array.hh.

typedef std::deque< std::unique_ptr< param > > param_array_contents

Definition at line 24 of file param_array.hh.

typedef boost::indirect_iterator< param_array_contents::iterator, param > param_array_iterator

Definition at line 28 of file param_array.hh.

typedef map_deref_iterator< std::string, const param, param_node_contents::const_iterator > param_node_const_iterator

Definition at line 66 of file param_node.hh.

typedef std::map< std::string, std::unique_ptr< param > > param_node_contents

Definition at line 63 of file param_node.hh.

typedef map_deref_iterator< std::string, param, param_node_contents::iterator > param_node_iterator

Definition at line 65 of file param_node.hh.

typedef std::unique_ptr< param > param_ptr_t

Definition at line 23 of file param_base.hh.

typedef fs::path path

Definition at line 25 of file path.hh.

using unique_append = typename unique_append_impl< T, List >::type

Definition at line 68 of file unique_typelist.hh.

Function Documentation

dig_type scarab::a2d	(	an_type	analog,
		const struct dig_calib_params *	params
	)

Definition at line 53 of file digital.hh.

const x_value& scarab::at	(	const std::map< x_key, x_value > &	a_map,
		const x_key &	a_key,
		const x_value &	a_default
	)

Definition at line 16 of file map_at_default.hh.

an_type scarab::d2a	(	dig_type	dig,
		const struct dig_calib_params *	params
	)

Definition at line 44 of file digital.hh.

const string& scarab::DebugColor

(

)

Definition at line 42 of file logger.cc.

std::string demangle

(

const char *

a_name

)

Definition at line 58 of file typename.cc.

const string& scarab::EndColor

(

)

Definition at line 36 of file logger.cc.

const string& scarab::ErrorColor

(

)

Definition at line 38 of file logger.cc.

path expand_path

(

const string &

a_path

)

Definition at line 19 of file path.cc.

const string& scarab::FatalColor

(

)

Definition at line 37 of file logger.cc.

int scarab::foo1

(

)

Definition at line 30 of file test_terminate.cc.

int scarab::foo2

(

)

Definition at line 24 of file test_terminate.cc.

void get_calib_params	(	unsigned	n_bits,
		unsigned	data_type_size,
		double	v_offset,
		double	v_range,
		bool	bits_r_aligned,
		dig_calib_params *	params
	)

Definition at line 18 of file digital.cc.

void get_calib_params2	(	unsigned	n_bits,
		unsigned	data_type_size,
		double	v_offset,
		double	v_range,
		double	dac_gain,
		bool	bits_r_aligned,
		dig_calib_params *	params
	)

Definition at line 32 of file digital.cc.

std::string get_formatted_now

(

)

Definition at line 21 of file time.cc.

const string& scarab::InfoColor

(

)

Definition at line 40 of file logger.cc.

scarab::LOGGER	(	dlog	,
		"parsable"
	)

scarab::LOGGER	(	slog	,
		"cancelable"
	)

scarab::LOGGER	(	slog	,
		"signal_handler"
	)

scarab::LOGGER	(	applog	,
		"application"
	)

scarab::LOGGER	(	mtlog	,
		"authentication"
	)

scarab::LOGGER	(	slog_fact	,
		"factory"
	)

scarab::LOGGER	(	slog	,
		"param_yaml"
	)

scarab::LOGGER	(	slog_cq	,
		"concurrent_queue"
	)

scarab::LOGGER	(	dlog	,
		"param"
	)

scarab::LOGGER	(	dlog_param_json	,
		"param_json"
	)

scarab::LOGGER	(	slog	,
		"scarab_version"
	)

scarab::LOGGER	(	slog	,
		"configurator"
	)

SCARAB_API std::ostream & operator<<	(	std::ostream &	out,
		const param &	a_value
	)

Definition at line 60 of file param_base.cc.

SCARAB_API std::ostream & operator<<	(	std::ostream &	out,
		const param_node &	a_value
	)

Definition at line 144 of file param_node.cc.

SCARAB_API std::ostream & operator<<	(	std::ostream &	out,
		const param_value &	a_value
	)

Definition at line 165 of file param_value.cc.

SCARAB_API std::ostream & operator<<	(	std::ostream &	out,
		const param_array &	a_value
	)

Definition at line 167 of file param_array.cc.

const string& scarab::OtherColor

(

)

Definition at line 44 of file logger.cc.

scarab::path scarab::param_value::as< scarab::path > ( ) const

inline

Definition at line 395 of file param_value.hh.

std::string scarab::param_value::as< std::string > ( ) const

inline

Definition at line 389 of file param_value.hh.

const string& scarab::ProgColor

(

)

Definition at line 41 of file logger.cc.

scarab::REGISTER_PARAM_INPUT_CODEC	(	param_input_yaml	,
		"yaml"
	)

scarab::REGISTER_PARAM_INPUT_CODEC	(	param_input_json	,
		"json"
	)

scarab::REGISTER_PARAM_OUTPUT_CODEC	(	param_output_yaml	,
		"yaml"
	)

scarab::REGISTER_PARAM_OUTPUT_CODEC	(	param_output_json	,
		"json"
	)

void terminate

(

)

Definition at line 32 of file terminate.cc.

int scarab::throw_exception

(

)

Definition at line 17 of file test_terminate.cc.

const string& scarab::TraceColor

(

)

Definition at line 43 of file logger.cc.

std::string scarab::type

(

const x_type &

a_param

)

Definition at line 22 of file typename.hh.

const string& scarab::WarnColor

(

)

Definition at line 39 of file logger.cc.

Variable Documentation

char date_time_format = "%Y-%m-%dT%H:%M:%SZ"

Definition at line 19 of file time.cc.