ifw-daq  1.0.0
IFW Data Acquisition modules
Classes | Functions
ocmif Namespace Reference

Classes

struct  AwaitDaqReplyFake
 
struct  DaqReplyFake
 
struct  DaqReplyMock
 
struct  DaqStatusFake
 
struct  DaqStatusMock
 

Functions

DaqStatus & operator<< (DaqStatus &status, daq::Status const &rhs)
 
ocmif::DaqSubState MakeState (daq::State state) noexcept
 Converts daq::State to DaqSubstate. More...
 
daq::State MakeState (ocmif::DaqSubState state)
 Converts DaqSubstate to daq::State. More...
 
std::string_view ToString (ocmif::DaqState state) noexcept
 
std::string_view ToString (ocmif::DaqSubState state) noexcept
 
DaqStatus & operator<< (ocmif::DaqStatus &status, daq::Status const &rhs)
 Convert daq::Status -> ocmif::DaqStatus by populating rhs. More...
 
template<class To >
To FromString (std::string_view input)
 
template<>
DaqState FromString< DaqState > (std::string_view state)
 Parse state name. More...
 
template<>
DaqSubState FromString< DaqSubState > (std::string_view state)
 Parse sub-state name. More...
 
network::uri MakeServerUri (std::string uri)
 Creates a server URI. More...
 
network::uri MakeServiceUri (std::string base_uri, std::string_view service_path)
 Creates a service URI of the form <baseuri>/<service>. More...
 

Function Documentation

◆ FromString()

template<class To >
To ocmif::FromString ( std::string_view  input)

◆ FromString< DaqState >()

template<>
DaqState ocmif::FromString< DaqState > ( std::string_view  state)

Parse state name.

Returns
State if the case-insensitive name matches a valid state.
Exceptions
std::invalid_argumentif no state matches.

Definition at line 20 of file parsing.cpp.

◆ FromString< DaqSubState >()

template<>
DaqSubState ocmif::FromString< DaqSubState > ( std::string_view  state)

Parse sub-state name.

Returns
State if the case-insensitive name matches a valid state.
Exceptions
std::invalid_argumentif no state matches.

Definition at line 34 of file parsing.cpp.

◆ MakeServerUri()

network::uri ocmif::MakeServerUri ( std::string  uri)

Creates a server URI.

Parameters
uriBase URI in the expected form e.g. "<URI>" or "<URI>/".
Returns
URI with single trailing slash.

Definition at line 13 of file uri.cpp.

◆ MakeServiceUri()

network::uri ocmif::MakeServiceUri ( std::string  base_uri,
std::string_view  service_path 
)

Creates a service URI of the form <baseuri>/<service>.

Parameters
base_uriBase URI in the expected form e.g. "<URI>" or "<URI>/".
service_pathURI path element in the form "<path>" or "/<path>".
Returns
<base_uri>/<service_path> URI with any extra slashes stripped when joining the paths.

Definition at line 19 of file uri.cpp.

◆ MakeState() [1/2]

DaqSubState ocmif::MakeState ( daq::State  state)
noexcept

Converts daq::State to DaqSubstate.

Definition at line 32 of file conversion.cpp.

◆ MakeState() [2/2]

daq::State ocmif::MakeState ( ocmif::DaqSubState  state)

Converts DaqSubstate to daq::State.

This assumes ocmif::DaqState is Acquiring.

Exceptions
std::invalid_argumentif state is not convertible.

Definition at line 56 of file conversion.cpp.

◆ operator<<() [1/2]

DaqStatus& ocmif::operator<< ( DaqStatus &  status,
daq::Status const &  rhs 
)

Definition at line 17 of file conversion.cpp.

◆ operator<<() [2/2]

DaqStatus& ocmif::operator<< ( ocmif::DaqStatus &  status,
daq::Status const &  rhs 
)

Convert daq::Status -> ocmif::DaqStatus by populating rhs.

◆ ToString() [1/2]

std::string_view ocmif::ToString ( ocmif::DaqState  state)
noexcept
Returns
string representation of enumeration.

Definition at line 78 of file conversion.cpp.

◆ ToString() [2/2]

std::string_view ocmif::ToString ( ocmif::DaqSubState  state)
noexcept
Returns
string representation of enumeration.

Definition at line 94 of file conversion.cpp.