Namespaces
	fits

	op

Classes
struct	ActionEvent
	Event related to an action being requested or performed. More...

struct	AsyncOperations
	Async operations. More...

class	DaqController
	Controls the execution of single data acquisition that ultimately result in a set of FITS keywords and/or FITS files. More...

class	DaqControllerImpl
	Implements `daq::DaqController` More...

struct	DaqControllerMock
	Mock version of daq::DaqController. More...

class	DaqOperationAborted
	Started operation was aborted. More...

class	DaqOperationTimeout
	Started operation timed out. More...

struct	DaqProperties
	Structure carrying properties needed to start a DataAcquisition. More...

struct	DaqReplyMock

class	DaqSourceError
	Represents error in single source. More...

class	DaqSourceErrors
	Exception thrown to carry reply errors. More...

struct	DaqStatusMock

struct	DaqStopReplyMock

struct	DpPart
	Provides information of the location and origin of a FITS file or keywords produced by a data acquisition. More...

struct	ErrorEvent

struct	EventLog
	Represents a collection of events. More...

class	EventLogObserverLogger
	A simple daq::ObservableEventLog observer that logs observed events to provided logger. More...

class	FitsController
	Create FITS file containing keywords from OCM for the Data Acquisition. More...

class	FitsControllerImpl

struct	FitsControllerMock
	Mock version of daq::FitsController. More...

struct	GenericEvent
	Represents a generic event if a more specific event is not usable. More...

class	Manager
	Manager owns DaqController and FitsController (active data acquisitions) instances and multiplexes requests to them. More...

class	ManagerImpl
	Implements `daq::Manager`. More...

struct	MetaDaqAsyncMock

class	MetaSource
	Keeps relevant state to be able to communicate with a primary data source. More...

class	ObservableEventLog
	Stores data acquisition status and allows subscription to status changes. More...

class	ObservableStatus
	Stores data acquisition status and allows subscription to status changes. More...

class	PendingReplies
	Simple class that allows you to keep track of how many replies are pending. More...

class	PrimSource
	Keeps relevant state to be able to communicate with a primary data source. More...

struct	RecCmdsAsyncMock

struct	RecStatusMock

class	ReplyToken
	Token representing a not-yet-received reply. More...

struct	Result
	Utility class that represents a result and an error. More...

struct	Result< void >

struct	Source
	Simple class that holds the source and associated state. More...

struct	Status
	Non observable status object that keeps stores status of data acquisition. More...

class	StatusSignal
	Observes any status. More...

class	TestSource
	Test fixture for source tests. More...

struct	UserActionEvent
	Event directly related to user action, such as a command to do something. More...

Typedefs
using	DpParts = std::vector< DpPart >

using	SourceVariant = std::variant< PrimSource, MetaSource >

Enumerations
enum	ErrorPolicy { ErrorPolicy::Strict = 0, ErrorPolicy::Tolerant }
	Error policy supported by certain operations. More...

enum	State { State::NotStarted = 0, State::Starting = 1, State::Acquiring = 2, State::Stopping = 3, State::Stopped = 4, State::Aborting = 100, State::Aborted = 101 }
	Observable states of the data acquisition process. More...

Functions
std::ostream &	operator<< (std::ostream &os, DaqController const &daq)

std::ostream &	operator<< (std::ostream &os, State state)
	Prints state string representation to os. More...

std::ostream &	operator<< (std::ostream &os, DpPart const &part) noexcept

std::ostream &	operator<< (std::ostream &os, ErrorPolicy policy)

std::ostream &	operator<< (std::ostream &os, GenericEvent const &s)

std::ostream &	operator<< (std::ostream &os, ErrorEvent const &s)

std::ostream &	operator<< (std::ostream &os, FitsController const &ctl)
	Print status information to provided ostream. More...

std::string	MakeDaqIdCandidate (char const *instrument_id, unsigned jitter=0)
	Creates a DAQ id candidate that may or may not be unique. More...

bool	IsFinalState (State state) noexcept
	Query whether state is in a final state. More...

bool	IsSubsequentState (State state, State after) noexcept
	Compares states and returns whether state occurs after after. More...

std::ostream &	operator<< (std::ostream &os, Status const &s)

std::ostream &	operator<< (std::ostream &os, ObservableStatus const &s)

	TEST_F (TestSource, Constructors)

	TEST_F (TestSource, Accessors)

	TEST_F (TestSource, PrimSourceConstructionFailsIfRrClientIsInvalid)

	TEST_F (TestSource, PrimSourceConstructionFailsIfNameIsEmpty)

	TEST_F (TestSource, MetaSourceConstructionFailsIfRrClientIsInvalid)

	TEST_F (TestSource, MetaSourceConstructionFailsIfNameIsEmpty)

Class Documentation

◆ daq::Result

struct daq::Result

template<class T = void, class ErrorType = bool>
struct daq::Result< T, ErrorType >

Utility class that represents a result and an error.

Definition at line 17 of file utility.hpp.

Class Members
ErrorType	error
T	result

◆ daq::Result< void >

struct daq::Result< void >

Definition at line 23 of file utility.hpp.

Class Members
bool	error

Typedef Documentation

◆ DpParts

using daq::DpParts = typedef std::vector<DpPart>

Definition at line 49 of file dpPart.hpp.

◆ SourceVariant

using daq::SourceVariant = typedef std::variant<PrimSource, MetaSource>

Definition at line 177 of file source.hpp.

Enumeration Type Documentation

◆ ErrorPolicy

enum daq::ErrorPolicy

strong

Error policy supported by certain operations.

Fatal for any policy refers to the operation is aborted and reported as failed (typically using exceptions).

Enumerator
Strict	Any error is considered fatal and may lead to the operation being aborted.
Tolerant	Errors that can be ignored with partial completion of a command will be tolerated and is reported as successful.

Definition at line 25 of file error.hpp.

Function Documentation

◆ operator<<() [1/7]

std::ostream & daq::operator<<	(	std::ostream &	os,
		DaqController const &	daq
	)

Definition at line 49 of file daqController.cpp.

◆ operator<<() [2/7]

std::ostream & daq::operator<<	(	std::ostream &	os,
		DpPart const &	part
	)

noexcept

Definition at line 6 of file dpPart.cpp.

◆ operator<<() [3/7]

std::ostream & daq::operator<<	(	std::ostream &	os,
		ErrorEvent const &	s
	)

Definition at line 48 of file eventLog.cpp.

◆ operator<<() [4/7]

std::ostream & daq::operator<<	(	std::ostream &	os,
		ErrorPolicy	policy
	)

Definition at line 17 of file error.cpp.

◆ operator<<() [5/7]

std::ostream & daq::operator<<	(	std::ostream &	os,
		GenericEvent const &	s
	)

Definition at line 42 of file eventLog.cpp.

◆ operator<<() [6/7]

std::ostream & daq::operator<<	(	std::ostream &	os,
		ObservableStatus const &	s
	)

Definition at line 129 of file status.cpp.

◆ operator<<() [7/7]

std::ostream & daq::operator<<	(	std::ostream &	os,
		Status const &	s
	)

Definition at line 38 of file status.cpp.

◆ TEST_F() [1/6]

daq::TEST_F	(	TestSource	,
		Accessors
	)

Definition at line 51 of file testSource.cpp.

◆ TEST_F() [2/6]

daq::TEST_F	(	TestSource	,
		Constructors
	)

Definition at line 34 of file testSource.cpp.

◆ TEST_F() [3/6]

daq::TEST_F	(	TestSource	,
		MetaSourceConstructionFailsIfNameIsEmpty
	)

Definition at line 77 of file testSource.cpp.

◆ TEST_F() [4/6]

daq::TEST_F	(	TestSource	,
		MetaSourceConstructionFailsIfRrClientIsInvalid
	)

Definition at line 73 of file testSource.cpp.

◆ TEST_F() [5/6]

daq::TEST_F	(	TestSource	,
		PrimSourceConstructionFailsIfNameIsEmpty
	)

Definition at line 68 of file testSource.cpp.

◆ TEST_F() [6/6]

daq::TEST_F	(	TestSource	,
		PrimSourceConstructionFailsIfRrClientIsInvalid
	)

Definition at line 64 of file testSource.cpp.

Namespaces

Classes

Typedefs

Enumerations

Functions