gbxutilacfr Namespace Reference

ACFR utilities. More...

Classes
class	Exception
	Base class for all GbxUtilAcfr exceptions. More...
class	HardwareException
	This exception is raised when something is wrong with the hardware. More...
struct	SubsystemStatus
	Status for a single subsystem. More...
struct	ComponentStatus
	Status of a single component. More...
class	Status
	Local interface to component status. More...
class	Stoppable
	An abstract interface class representing an stoppable activity. More...
class	SubHealth
	Convenience class which allows feedback on the health of a subsystem. More...
class	SubStatus
	Convenience class which maniupulates the status of a subsystem. More...
class	Tracer
	Local and remote tracing. More...
class	TrivialStatus
	A trivial implementation of the status API which does not assemble information. More...
class	TrivialTracer
	A simple implementation of the tracer API which prints to cout. More...
Enumerations
enum	SubsystemState {   SubsystemIdle, SubsystemInitialising, SubsystemWorking, SubsystemFinalising,   SubsystemShutdown, SubsystemFault }
	Possible subsystem status values. More...
enum	SubsystemHealth { SubsystemOk, SubsystemWarning, SubsystemCritical }
	Possible subsystem status values. More...
enum	SubsystemType { SubsystemStandard, SubsystemEarlyExit, SubsystemInfrastructure }
	Subsystem type which describes common behavior models of a subsystem. More...
enum	ComponentState { CompStarting, CompOperational, CompStopping, CompFault }
	Possible component states. More...
enum	ComponentHealth { CompOk, CompWarning, CompCritical }
	Possible values of component health. More...
enum	TraceType {   InfoTrace = 0, WarningTrace, ErrorTrace, DebugTrace,   AnyTrace, NumberOfTraceTypes }
	Types of traced information. More...
enum	DestinationType {   ToDisplay = 0, ToNetwork, ToLog, ToFile,   ToAny, NumberOfDestinationTypes }
	Types of destinations for traced information. More...
Functions
std::string	toString (SubsystemState state)
	Returns string equivalent of state enumerator.
std::string	toString (SubsystemHealth health)
	Returns string equivalent of health enumerator.
std::string	toString (const SubsystemStatus &status)
	Returns human-readable string with subsystem status information.
std::string	toString (SubsystemType type)
	Returns string equivalent of subsystem type enumerator.
std::string	toString (ComponentState type)
	Returns string equivalent of component state type enumerator.
std::string	toString (ComponentHealth type)
	Returns string equivalent of component health type enumerator.
GBXUTILACFR_EXPORT std::vector < std::string >	tokenise (const std::string &str, const std::string &delimiter)
std::string	toString (TraceType type)
	Returns a string corresponding to the enum element.

---

Detailed Description

ACFR utilities.

This namespace is part of a utility library.

See also:

GbxUtilAcfr

---

Enumeration Type Documentation

enum gbxutilacfr::ComponentHealth

Possible values of component health.

Enumerator:

CompOk	All of the component's subsystems are OK.
CompWarning	At least one of the component's subsystems has encountered an abnormal but non-critical condition.
CompCritical	At least one of the component's subsystems has encountered a critical condition.

enum gbxutilacfr::ComponentState

Possible component states.

Enumerator:

CompStarting	Component is preparing to work, e.g. initialising its resources, etc.
CompOperational	Component is fully initialised and is performing its work.
CompStopping	Component is preparing to shutdown, e.g. releasing its resources, etc.
CompFault	Component is in an unrecovarable faulty state.

enum gbxutilacfr::DestinationType

Types of destinations for traced information.

Enumerator:

ToDisplay	Write to stardard display.
ToNetwork	Send over the network, details are specific to Tracer implementation.
ToLog	Write to SysLog on Unix, EventLog on windows.
ToFile	Write to a file.
ToAny	Use this index to request the maximum verbosity of a particular type among all destinations
NumberOfDestinationTypes	Number of destination types.

enum gbxutilacfr::SubsystemHealth

Possible subsystem status values.

Enumerator:

SubsystemOk	Subsystem is OK.
SubsystemWarning	Subsystem has encountered an abnormal but non-critical condition.
SubsystemCritical	Subsystem has encountered a critical condition.

enum gbxutilacfr::SubsystemState

Possible subsystem status values.

Enumerator:

SubsystemIdle	Subsystem has been created but has not started initialisation process.
SubsystemInitialising	Subsystem is preparing to work, e.g. initialising its resources, etc.
SubsystemWorking	Subsystem is fully initialised and is performing its function.
SubsystemFinalising	Subsystem is preparing to shutdown, e.g. releasing its resources, etc.
SubsystemShutdown	Subsystem is not longer functioning.
SubsystemFault	Subsystem is in an unrecovarable faulty state.

enum gbxutilacfr::SubsystemType

Subsystem type which describes common behavior models of a subsystem.

Enumerator:

SubsystemStandard	Standard model: subsystem's life cycle is equal to the life cycle of the component.
SubsystemEarlyExit	Early exit model: subsystem's life cycle is shorter than the life cycle of the component. This model is used for two common cases: subsystem performs some function and intentionally shuts down early; subsystem starts up, works, encounters a problem, shuts down, and restarts again.
SubsystemInfrastructure	Internal model. May shutdown early (same as SubsystemEarlyExit). In addition, this subsystem is not considered the "real" worker subsystem, i.e. when it is the only subsystem in existance, the component is not considered operational even if this subsystem is working.

enum gbxutilacfr::TraceType

Types of traced information.

Enumerator:

InfoTrace	Information.
WarningTrace	Warning.
ErrorTrace	Error.
DebugTrace	Debug statement.
AnyTrace	Use this index to find out the maximum verbosity among all trace types to a particular destination.
NumberOfTraceTypes	Number of trace types.

---

Function Documentation

GBXUTILACFR_EXPORT std::vector<std::string> gbxutilacfr::tokenise	(	const std::string &	str,
		const std::string &	delimiter
	)

Takes a string containing tokens separated by a delimiter Returns the vector of tokens