RTC Toolkit
2.0.0
|
Namespaces | |
detail | |
test | |
Classes | |
struct | AbstractEvent |
Abstract Event Type that is used as a base for all events. More... | |
class | AlertConflictException |
Exception indicating that a metric such as counter or thread conflicts with already known metrics. More... | |
class | AlertDescription |
Uniquely describes an alert. More... | |
class | AlertEventPublisher |
Alert observer that publishes alerts to event service using the typed event AlertStatusEvent . More... | |
class | AlertLogger |
Simple alert observer that writes alerts to log. More... | |
class | AlertService |
Implementation of AlertIf. More... | |
class | AlertServiceIf |
Alert Service interface. More... | |
class | AlertSource |
Models a single alert source that can be set or cleared. More... | |
class | AlertSourceFactoryIf |
Interface to create AlertSource. More... | |
struct | AlertStatusEvent |
Event published when alert status is changed. More... | |
class | AlertStatusObserverIf |
Interface to observe alert status. More... | |
struct | AsSpan |
Gets the span type for converting type T to a span. More... | |
struct | AsSpan< const std::array< T, Size > > |
struct | AsSpan< MatrixBuffer< T, Allocator > > |
struct | AsSpan< std::array< T, Size > > |
struct | AsSpan< std::vector< T, Allocator > > |
class | BufferTooSmall |
The BufferTooSmall is thrown when an API call fails because the provided buffer is not big enough to hold the data. More... | |
class | CommandReplier |
Class that handles reception of commands using MAL. More... | |
class | CommandRequestor |
Extendable class that allows to send commands to components using MAL. More... | |
class | ComponentMetrics |
Implementation of ComponentMetricsIf. More... | |
class | ComponentMetricsConfigurator |
Configures ComponentMetrics from a runtime repository. More... | |
class | ComponentMetricsIf |
Component metrics interface. More... | |
struct | ComponentMetricsParams |
Dynamic parameters for ComponentMetrics. More... | |
struct | ComputationEvent |
Abstract Event Type that is used as a base for computation events. More... | |
struct | ComputationFinishedEvent |
Event Type used to signal that a computation has finished. More... | |
struct | ComputationStartedEvent |
Event Type used to signal that a computation has started. More... | |
struct | ConfigurationEvent |
Abstract Event Type that is used as a base for configuration events. More... | |
struct | ConfigurationRetrievedEvent |
Event Type used to signal that a configuration data item was retrieved from RTR. More... | |
struct | ConfigurationUpdatedEvent |
Event Type used to signal that a configuration data item was updated in RTR. More... | |
struct | CoordinationEvent |
Abstract Event Type that is used as a base for coordination events. More... | |
class | CounterMetricInfo |
Defines auxiliary information associated with each counter registered with ComponentMetricsIf. More... | |
class | DataPointPath |
This class provides a wrapper for a data point path. More... | |
class | DataPointRecordingUnit |
Recording Unit that can record RTR datapoints. More... | |
class | DataRecorder |
class | Dds |
Common functionallty needed to create DDS entities like participant and topic that can be later used (extent) for DDS data publishing and subscribing . More... | |
class | DdsPub |
All functionallty needed to create DDS entities for DDS data publishing is concentrated in this class. More... | |
class | DdsReaderListener |
Listener class for different DDS events. More... | |
struct | DdsReaderParams |
Structure that keeps together topic name and DDS Data Writer listener. More... | |
class | DdsSub |
All functionality needed to create DDS entities for DDS data subscribing is concentrated in this class. More... | |
class | DdsWriterListener |
Listener class for differetn DDS events. More... | |
struct | DdsWriterParams |
Structure that keeps together topic name and DDS Data Writer listener. More... | |
class | DebugExport |
class | DirCreationError |
struct | empty_base |
class | EventPublisherIf |
Interface class for publishing JSON events. More... | |
class | EventServiceIf |
Interface class for providing pub/sub facilities for JSON events. More... | |
class | EventSubscriberIf |
Interface class for subscribing to JSON events. More... | |
class | FileFormatError |
class | FileOldbAdapter |
A file based OLDB adapter that simulates OLDB with a local YAML file. More... | |
class | FilePersistentRepoAdapter |
Implements a file based Persistent Configuration Repository adapter that can be used for testing. More... | |
class | FileRepository |
Implements a file based repository that stores datapoints in local YAML and FITS files. More... | |
class | FileRuntimeRepoAdapter |
class | FileServiceRegistryAdapter |
Class that implements a very basic service discovery mechanism. More... | |
struct | FitsColumn |
struct | FitsColumnFormat |
Type that stores type information for a FITS TFORM string. More... | |
class | FitsRecorder |
class | FuncCmdsImpl |
Class that handles reception of commands Run, Idle and Recover using MAL. More... | |
struct | HrtcConfigurationAppliedEvent |
Event Type used to signal that a configuration data item was applied in HRTC. More... | |
struct | HrtcConfigurationScheduledEvent |
Event Type used to signal that a configuration data item was scheduled to be applied in HRTC. More... | |
struct | HrtcStateChangedEvent |
Event Type used to signal that some entity in HRTC changed its state. More... | |
class | IDisabling |
class | IEnabling |
class | IInitialising |
class | InitialisationException |
Thrown in cases where an initialisation routine has failed. More... | |
class | InvalidArgumentException |
class | InvalidSetting |
This Exception is raised when a invalid setting was used in the runtime repo. More... | |
class | InvalidStateChange |
This Exception is raised when the state change requested is invalid. More... | |
class | InvalidUriInFileError |
class | IpcqError |
This Exception is raised when the ipc queue returns an error that cannot be handled by the RecordingThread. More... | |
class | IpcqRecordingUnit |
Recording Unit that can record from shared memory queue. More... | |
struct | is_base_of_template_impl |
struct | is_present |
struct | IsDynamicSpan |
Type trait to check if a type is a gsl::span with dynamic size. More... | |
struct | IsDynamicSpan< gsl::span< T, N > > |
struct | IsMatrixBuffer |
Type trait to check if a type is a MatrixBuffer. More... | |
struct | IsMatrixBuffer< MatrixBuffer< T, Allocator > > |
struct | IsMatrixBufferType |
Structure for detecting MatrixBuffer types using SFINAE. More... | |
struct | IsMatrixBufferType< MatrixBuffer< T, A > > |
Structure for detecting MatrixBuffer types using SFINAE. More... | |
struct | IsMatrixSpanType |
Structure for detecting MatrixSpan types using SFINAE. More... | |
struct | IsMatrixSpanType< MatrixSpan< T > > |
Structure for detecting MatrixSpan types using SFINAE. More... | |
struct | IsSpanConvertible |
Type trait to check if a type can be converted to a Span using AsSpan/ToSpan. More... | |
struct | IsSpanType |
Structure for detecting gsl::span types using SFINAE. More... | |
struct | IsSpanType< gsl::span< T > > |
Structure for detecting gsl::span types using SFINAE. More... | |
struct | IsStaticSpan |
Type trait to check if a type is a gsl::span with fixed size. More... | |
struct | IsStaticSpan< gsl::span< T, N > > |
struct | IsStdArray |
struct | IsStdArray< std::array< T, N > > |
class | IStarting |
struct | IsVector |
Type trait to check if a type is a std::vector. More... | |
struct | IsVector< std::vector< T, Allocator > > |
struct | IsVectorType |
Structure for detecting std::vector types using SFINAE. More... | |
struct | IsVectorType< std::vector< T > > |
Structure for detecting std::vector types using SFINAE. More... | |
class | JsonEventRecordingUnit |
Recording Unit that can record JSON events. More... | |
class | LogInfo |
class | LogInitializer |
RAII class to clean-up logging without leaking memory. More... | |
struct | Loopaware |
Life cycle extension to make RtcComponent Loopaware. More... | |
class | LoopCmdsImpl |
Class that handles reception of commands Open and Close using MAL. More... | |
class | MalDdsEventPublisher |
Implementation of event publisher. More... | |
class | MalDdsEventService |
Implementation of low-level event service using CII MAL DDS as middleware. More... | |
class | MalDdsEventSubscriber |
Implementation of event subscriber. More... | |
class | MatrixBuffer |
class | MatrixSpan |
A span class that simply extends gsl::span to record the number of rows and columns of a matrix and checks that this correctly corresponds to the underlying buffer size in debug builds. More... | |
class | MeasCmdsImpl |
Class that handles reception of command Measure using MAL. More... | |
struct | Measurable |
Life cycle extension to make RtcComponent Measurable. More... | |
class | MetricConflictException |
Exception indicating that a metric such as counter or thread conflicts with already known metrics. More... | |
class | ModelBuilderBase |
Base class of the ModelBuilder. More... | |
class | ModelManipulator |
Class that provides methods to manipulate the state machine model. More... | |
class | NestedExceptionPrinter |
Adapter object intended to be used in contexts without direct access to the output-stream object. More... | |
class | NotImplementedException |
The NotImplementedException is thrown whenever an attempt is made to use a feature or function that has not been implemented. More... | |
class | OldbAdapter |
Provides access to the OLDB to read and write datapoints. More... | |
class | OldbIf |
class | OptCmdsImpl |
Class that handles reception of command Optimise using MAL. More... | |
struct | Optimisable |
Life cycle extension to make RtcComponent Optimisable. More... | |
class | PathMapper |
Used to calculate URIs from datapoint paths. More... | |
class | PathMissingException |
class | PersistentRepoAdapter |
Implements the Persistent Configuration Repository adapter that uses the CII configuration service as the backend. More... | |
class | PersistentRepoIf |
class | PlantUmlExport |
struct | RecordingInfo |
struct | RecordingInfo< ComputationEvent > |
Trait class that defines how ComputationEvent is recorded. More... | |
struct | RecordingInfo< ComputationFinishedEvent > |
Trait class that defines how ComputationFinishedEvent is recorded. More... | |
struct | RecordingInfo< ComputationStartedEvent > |
Trait class that defines how ComputationStartedEvent is recorded. More... | |
struct | RecordingInfo< ConfigurationEvent > |
Trait class that defines how ConfigurationEvent is recorded. More... | |
struct | RecordingInfo< ScaoLoopTopic > |
class | RecordingUnit |
Abstract base class for all sources that can be recorded by the MetadataCollector and TelemetryRecorder. More... | |
class | RepositoryIf |
Abstract interface providing basic read and write facilities to a repository. More... | |
class | RepositorySubscriberIf |
Abstract interface providing subscription facilities for a repository. More... | |
class | RequestAborted |
class | RequestFailed |
class | RequestRejected |
struct | RtcComponent |
Basic life cycle for RtcComponent. More... | |
class | RtctkException |
The RtctkException class is the base class for all Rtctk exceptions. More... | |
struct | Runnable |
Life cycle extension to make RtcComponent Runnable. More... | |
class | RuntimeRepoAdapter |
class | RuntimeRepoIf |
class | ScXmlExport |
class | ServiceContainer |
Container class that holds services of any type. More... | |
class | ServiceDiscovery |
Class that implements a very basic service discovery mechanism. More... | |
class | ServiceRegistryIf |
Class that implements a service registry to be used by the service discovery. More... | |
class | SmCatExport |
struct | State |
struct | StateChangedEvent |
Event Type used to signal that some entity changed its state. More... | |
struct | StateMachine |
class | StateMachineEngine |
class | StatePublisher |
Class used to publish state-changed-topic using MAL. More... | |
class | StateSubscriber |
Class used to subscribe to state-changed-topic using MAL. More... | |
class | StdCmdsImpl |
Class that handles reception of stdif commands. More... | |
struct | StdComponent |
Basic life cycle for StdComponent. More... | |
class | StdIfRequestAborted |
class | StdIfRequestFailed |
class | StdIfRequestRejected |
class | SuspCmdsImpl |
Class that handles reception of commands Suspend and Resume using MAL. More... | |
struct | Suspendable |
Life cycle extension to make Loopaware RtcComponent Suspendable. More... | |
class | ThreadActivity |
Class that handles state machine activities. More... | |
class | ThreadMetricInfo |
Defines auxiliary information associated with each thread registered with ComponentMetricsIf. More... | |
struct | Transition |
class | TypedEventPublisher |
An event publisher that is aware of event types. More... | |
class | TypedEventRecordingUnit |
Recording Unit that can record typed events. More... | |
class | TypedEventService |
A high-level event service API that is aware of event types. More... | |
class | TypedEventSubscriber |
An event subscriber that is aware of event types. More... | |
class | UnsupportedTypeException |
The UnsupportedTypeException is thrown whenever an attempt is made to use an unsupported type in the RTC Toolkit API. More... | |
class | UnsupportedUriException |
The UnsupportedUriException is thrown whenever an attempt is made to use an unsupported URI in the RTC Toolkit API. More... | |
class | UpdateCmdsImpl |
Class that handles reception of command Update using MAL. More... | |
Typedefs | |
using | Payload = std::string |
using | RtcComponentSuper = StdComponent< UseStarting< Enabled >, UseInitialising< Enabled >, UseEnabling< Enabled >, UseDisabling< Enabled > > |
using | Args = detail::Args |
using | ActionMethod = std::function< void(scxml4cpp::Context *c)> |
using | GuardMethod = std::function< bool(scxml4cpp::Context *c)> |
using | ActivityMethod = std::function< void(StopToken f)> |
using | SuccessMethod = std::function< void()> |
using | FailureMethod = std::function< void(std::exception_ptr)> |
using | RejectMethod = std::function< void(const rad::AnyEvent &, const std::string &state)> |
using | StateMethod = std::function< void(const std::string &)> |
using | StopSource = rad::StopSource |
using | StopToken = rad::StopToken |
using | Enabled = std::true_type |
using | Disabled = std::false_type |
template<template< typename... > class Base, typename Derived > | |
using | is_base_of_template = typename is_base_of_template_impl< Base, Derived >::type |
template<class T , bool Condition> | |
using | optional_base = std::conditional_t< Condition, T, empty_base< T > > |
using | JsonPayload = nlohmann::json |
Type requirements: More... | |
template<typename T > | |
using | AsSpanT = typename AsSpan< T >::TYPE |
using | RecUnitListType = std::list< std::unique_ptr< RecordingUnit > > |
using | RecUnitFactoryType = std::function< RecUnitListType(std::string const &, ServiceContainer &)> |
using | PathList = RepositoryIf::PathList |
using | ReadRequest = RepositoryIf::ReadRequest |
using | WriteRequest = RepositoryIf::WriteRequest |
using | Response = RepositoryIf::Response |
Enumerations | |
enum | StateType { Machine, Simple, Parallel, Composite, Initial, Final } |
Functions | |
template<typename EventType > | |
elt::mal::future< std::string > | InjectReqRepEvent (StateMachineEngine &engine) |
template<typename EventType , typename PayloadType > | |
elt::mal::future< std::string > | InjectReqRepEvent (StateMachineEngine &engine, PayloadType &payload) |
std::stringstream | Export (StateMachine &sm, std::string const &format) |
Export the in-memory state machine model in various formats. More... | |
template<class BL , class BLF > | |
void | RunAsRtcComponent (Args const &args, BLF factory) |
RTC Component runner function, needed to run custom BusinessLogic as RTC Component. More... | |
template<class BL > | |
void | RunAsRtcComponent (Args const &args) |
RTC Component runner function, needed to run custom BusinessLogic as RTC Component. More... | |
int | Main (int argc, char *argv[]) |
Main function implementation. More... | |
template<typename EVENT > | |
std::shared_ptr< typename EVENT::payload_t > | GetPayloadNothrow (scxml4cpp::Context *c) |
RTCTK_DEFINE_OPTION (UseStarting, Disabled) | |
RTCTK_DEFINE_OPTION (UseInitialising, Enabled) | |
RTCTK_DEFINE_OPTION (UseEnabling, Disabled) | |
RTCTK_DEFINE_OPTION (UseDisabling, Disabled) | |
std::string | ReplaceAll (std::string str, const std::string &from, const std::string &to) |
std::ostream & | operator<< (std::ostream &os, AlertServiceIf::AlertStatus const &status) |
std::istream & | operator>> (std::istream &input, DataPointPath &path) |
void | PrintNestedExceptions (std::ostream &os, std::exception const &exception) |
Print nested exception(s) in exception messages to os. More... | |
void | PrintNestedExceptions (std::ostream &os, std::exception_ptr ptr) |
Print nested exception(s) in exception messages to os. More... | |
std::string | GetCfitsioErrorMsg (int status) |
Helper function to convert a Cfitsio status code to a human readable message. More... | |
std::string | CfitsioImageTypeToString (int bitpix) |
Returns a string representation of a Cfitsio image type code. More... | |
std::string | CfitsioDataTypeToString (int datatype) |
Returns a string representation of a Cfitsio data type code. More... | |
const std::type_info & | GetFitsImageType (const std::string &filename) |
Get the C++ type corresponding to a FITS image. More... | |
std::size_t | GetFitsImageSize (const std::string &filename) |
Get the number of pixels in a FITS image. More... | |
DataPointPath | operator""_dppath (const char *str, std::size_t len) |
bool | operator== (const DataPointPath &lhs, const char *rhs) noexcept |
bool | operator< (const DataPointPath &lhs, const char *rhs) noexcept |
bool | operator<= (const DataPointPath &lhs, const char *rhs) noexcept |
bool | operator> (const DataPointPath &lhs, const char *rhs) noexcept |
bool | operator>= (const DataPointPath &lhs, const char *rhs) noexcept |
bool | operator== (const DataPointPath &lhs, const std::string &rhs) noexcept |
bool | operator< (const DataPointPath &lhs, const std::string &rhs) noexcept |
bool | operator<= (const DataPointPath &lhs, const std::string &rhs) noexcept |
bool | operator> (const DataPointPath &lhs, const std::string &rhs) noexcept |
bool | operator>= (const DataPointPath &lhs, const std::string &rhs) noexcept |
bool | operator== (const DataPointPath &lhs, const DataPointPath &rhs) noexcept |
bool | operator< (const DataPointPath &lhs, const DataPointPath &rhs) noexcept |
bool | operator<= (const DataPointPath &lhs, const DataPointPath &rhs) noexcept |
bool | operator> (const DataPointPath &lhs, const DataPointPath &rhs) noexcept |
bool | operator>= (const DataPointPath &lhs, const DataPointPath &rhs) noexcept |
DataPointPath | operator+ (DataPointPath lhs, const DataPointPath &rhs) |
DataPointPath | operator/ (DataPointPath lhs, const DataPointPath &rhs) |
std::ostream & | operator<< (std::ostream &out, const DataPointPath &rhs) |
template<class E > | |
auto | WrapWithNested (E &&exception) noexcept(std::is_nothrow_constructible_v< detail::UnspecifiedNested< typename std::decay_t< E >>, E && >) |
Constructs an unspecified exception that derives from both the provided object and std::nested_exception. More... | |
template<typename T , typename A > | |
void | WriteMatrixToFits (const std::string &filename, const MatrixBuffer< T, A > &matrix) |
Writes MatrixBuffer data representing a matrix as an image to a FITS file. More... | |
template<typename T , typename A > | |
void | ReadMatrixFromFits (const std::string &filename, MatrixBuffer< T, A > &matrix) |
Reads a FITS file image into a MatrixBuffer object representing a matrix. More... | |
template<typename T , typename A > | |
void | WriteVectorToFits (const std::string &filename, const std::vector< T, A > &vector) |
Writes std::vector data as a 1D image to a FITS file. More... | |
template<typename T , typename A > | |
void | ReadVectorFromFits (const std::string &filename, std::vector< T, A > &vector) |
Reads a FITS file containing a 1D image into a std::vector object. More... | |
template<typename A > | |
void | WriteMatrixToFits (const std::string &filename, const MatrixBuffer< bool, A > &matrix) |
Writes a matrix of boolean values as a FITS image with 8 bits per pixel. More... | |
template<typename A > | |
void | ReadMatrixFromFits (const std::string &filename, MatrixBuffer< bool, A > &matrix) |
Reads a matrix of boolean values from a FITS image with 8 bits per pixel. More... | |
template<typename A > | |
void | WriteVectorToFits (const std::string &filename, const std::vector< bool, A > &vector) |
Write a vector of boolean values to a FITS file as a 1D image of 8 bit pixels. More... | |
template<typename A > | |
void | ReadVectorFromFits (const std::string &filename, std::vector< bool, A > &vector) |
Read a vector of boolean values from a FITS files containing a 1D image of 8 bit pixels. More... | |
template<typename T , typename A > | |
constexpr bool | operator== (const MatrixBuffer< T, A > &lhs, const MatrixBuffer< T, A > &rhs) noexcept |
Compares two MatrixBuffer objects and returns true if they have the same shape and identical elements. More... | |
template<typename T , typename A > | |
constexpr bool | operator!= (const MatrixBuffer< T, A > &lhs, const MatrixBuffer< T, A > &rhs) noexcept |
Compares two MatrixBuffer objects and returns true if they do not have the same shape or the elements are different. More... | |
template<typename T , typename A > | |
constexpr bool | operator< (const MatrixBuffer< T, A > &lhs, const MatrixBuffer< T, A > &rhs) noexcept |
Compares two MatrixBuffer objects and returns true for the following cases: More... | |
template<typename T , typename A > | |
constexpr bool | operator<= (const MatrixBuffer< T, A > &lhs, const MatrixBuffer< T, A > &rhs) noexcept |
Compares two MatrixBuffer objects and effectively returns rhs < lhs or rhs == lhs . More... | |
template<typename T , typename A > | |
constexpr bool | operator> (const MatrixBuffer< T, A > &lhs, const MatrixBuffer< T, A > &rhs) noexcept |
Compares two MatrixBuffer objects and returns true for the following cases: More... | |
template<typename T , typename A > | |
constexpr bool | operator>= (const MatrixBuffer< T, A > &lhs, const MatrixBuffer< T, A > &rhs) noexcept |
Compares two MatrixBuffer objects and effectively returns rhs > lhs or rhs == lhs . More... | |
template<typename T > | |
bool | GetOptionalParam (RepositoryIf &repo, const DataPointPath &path, T &value) |
Get optional datapoint. More... | |
std::optional< numapp::NumaPolicies > | GetNumaPolicies (RepositoryIf &repo, const DataPointPath &path) |
Constructs a NumaPolicies object from the configuration datapoints found under the given datapoint path. More... | |
std::string | RetcodeToString (ReturnCode_t retcode) |
const char * | GetTopicName (DataWriter *writer) |
const char * | GetTopicName (DataReader *reader) |
FASTDDS_SEQUENCE (AgnosticTopicSeq, AgnosticTopic) | |
FASTDDS_SEQUENCE (SampleInfoSeq, SampleInfo) | |
template<class T > | |
std::string | GetFitsType () |
Get the TFORM value for a type. More... | |
template<class T , class... Args> | |
void | GetFITSTForm (std::vector< std::string > &input) |
Get a vactor of TFORM strings for a list of types. More... | |
template<class T , class... Args> | |
void | AddRecUnit (RecUnitListType &units, Args &&... args) |
Add a RecordingUnit to the RecordingUnit list of a TelemetryRecorder oder MetadataCollector. More... | |
template<typename T > | |
AsSpanT< T > | ToSpan (T &data) |
Simple function that converts types that are convertible to spans to a span. More... | |
template<typename T > | |
std::string | PrettyTypeName () |
uint64_t | GetTimestamp () |
void | LogConfigure (const std::string &cfg_file_name="") |
Initial logging system configuration. More... | |
void | MakeLogger (const std::string &name, log4cplus::LogLevel ll, bool log_to_file=true, bool additive=false, log4cplus::LogLevel log_to_console_threshold=log4cplus::NOT_SET_LOG_LEVEL) |
Retrieve new logger programmatically. More... | |
void | SetDefaultLogger (const std::string &name) |
Set the default logger. More... | |
log4cplus::Logger & | GetLogger (const std::string &name="") |
Get handle to a specific logger (used with logging macros) More... | |
void | ConfigureLogger (log4cplus::Logger &logger, log4cplus::LogLevel ll, bool log_to_file, bool additive, log4cplus::LogLevel log_to_console_threshold=log4cplus::NOT_SET_LOG_LEVEL) |
void | LogConfigure (const string &cfg_file_name) |
log4cplus::Logger & | GetLogger (const string &logger_name) |
void | MakeLogger (const string &name, log4cplus::LogLevel ll, bool log_to_file, bool additive, log4cplus::LogLevel log_to_console_threshold) |
bool | operator== (ComponentMetricsParams const &lhs, ComponentMetricsParams const &rhs) noexcept |
Equality operator for ComponentMetricsParams. More... | |
bool | operator!= (ComponentMetricsParams const &lhs, ComponentMetricsParams const &rhs) noexcept |
Inequality operator for ComponentMetricsParams. More... | |
std::ostream & | operator<< (std::ostream &os, ComponentMetricsParams const ¶ms) |
Formatter for ComponentMetricsParams. More... | |
py::module EXPORT_TYPE | LoadMatrixBufferPyBinds () |
py::module EXPORT_TYPE | LoadVectorBufferPyBinds () |
PYBIND11_EMBEDDED_MODULE (Import_Matrix_Buffer, m) | |
PYBIND11_EMBEDDED_MODULE (Import_Vector_Buffer, m) | |
Variables | |
const std::string | STD_OK_REPLY = "OK" |
template<template< typename... > class Base, typename Derived > | |
constexpr bool | is_base_of_template_v = is_base_of_template<Base, Derived>::value |
template<typename What , typename... Args> | |
constexpr bool | is_present_v = is_present<What, Args...>::value |
template<typename T > | |
constexpr bool | IS_VECTOR_TYPE = IsVectorType<T>::value |
Is true if the type is a std::vector<U> of some type U . More... | |
template<typename T > | |
constexpr bool | IS_MATRIX_BUFFER_TYPE = IsMatrixBufferType<T>::value |
Is true if the type is a MatrixBuffer<U> of some type U . More... | |
template<typename T > | |
constexpr bool | IS_SPAN_TYPE = IsSpanType<T>::value |
Is true if the type is a gsl::span<U> of some type U . More... | |
template<typename T > | |
constexpr bool | IS_MATRIX_SPAN_TYPE = IsMatrixSpanType<T>::value |
Is true if the type is a MatrixSpan<U> of some type U . More... | |
template<typename T > | |
constexpr bool | IsSpanConvertibleV = IsSpanConvertible<T>::value |
Small helper alias for IsSpanConvertible. More... | |
const std::string | DEFAULT_PATTERN = "[%D{%H:%M:%S:%q}][%-5p][%c] %m%n" |
std::string | default_logger = "root" |
using rtctk::componentFramework::ActionMethod = typedef std::function<void(scxml4cpp::Context* c)> |
using rtctk::componentFramework::ActivityMethod = typedef std::function<void(StopToken f)> |
using rtctk::componentFramework::Args = typedef detail::Args |
using rtctk::componentFramework::AsSpanT = typedef typename AsSpan<T>::TYPE |
using rtctk::componentFramework::Disabled = typedef std::false_type |
using rtctk::componentFramework::Enabled = typedef std::true_type |
using rtctk::componentFramework::FailureMethod = typedef std::function<void(std::exception_ptr)> |
using rtctk::componentFramework::GuardMethod = typedef std::function<bool(scxml4cpp::Context* c)> |
using rtctk::componentFramework::is_base_of_template = typedef typename is_base_of_template_impl<Base, Derived>::type |
using rtctk::componentFramework::JsonPayload = typedef nlohmann::json |
Type requirements:
using rtctk::componentFramework::optional_base = typedef std::conditional_t<Condition, T, empty_base<T> > |
using rtctk::componentFramework::Payload = typedef std::string |
using rtctk::componentFramework::ReadRequest = typedef RepositoryIf::ReadRequest |
using rtctk::componentFramework::RecUnitFactoryType = typedef std::function<RecUnitListType(std::string const&, ServiceContainer&)> |
using rtctk::componentFramework::RecUnitListType = typedef std::list<std::unique_ptr<RecordingUnit> > |
using rtctk::componentFramework::RejectMethod = typedef std::function<void(const rad::AnyEvent&, const std::string& state)> |
using rtctk::componentFramework::Response = typedef RepositoryIf::Response |
using rtctk::componentFramework::RtcComponentSuper = typedef StdComponent<UseStarting<Enabled>, UseInitialising<Enabled>, UseEnabling<Enabled>, UseDisabling<Enabled> > |
using rtctk::componentFramework::StateMethod = typedef std::function<void(const std::string&)> |
using rtctk::componentFramework::StopSource = typedef rad::StopSource |
using rtctk::componentFramework::StopToken = typedef rad::StopToken |
using rtctk::componentFramework::SuccessMethod = typedef std::function<void()> |
using rtctk::componentFramework::WriteRequest = typedef RepositoryIf::WriteRequest |
void rtctk::componentFramework::AddRecUnit | ( | RecUnitListType & | units, |
Args &&... | args | ||
) |
Add a RecordingUnit to the RecordingUnit list of a TelemetryRecorder oder MetadataCollector.
units | list of RecordingUnits |
args | Arguments for the Constructor of that RecordingUnit |
std::string rtctk::componentFramework::CfitsioDataTypeToString | ( | int | datatype | ) |
Returns a string representation of a Cfitsio data type code.
[in] | datatype | The Cfitsio data type code that may be used with fits_read_pix or fits_write_pix. |
std::string rtctk::componentFramework::CfitsioImageTypeToString | ( | int | bitpix | ) |
Returns a string representation of a Cfitsio image type code.
[in] | bitpix | The Cfitsio image type code that may be used with fits_create_img or returned by fits_get_img_equivtype. |
void rtctk::componentFramework::ConfigureLogger | ( | log4cplus::Logger & | logger, |
log4cplus::LogLevel | ll, | ||
bool | log_to_file, | ||
bool | additive, | ||
log4cplus::LogLevel | log_to_console_threshold = log4cplus::NOT_SET_LOG_LEVEL |
||
) |
DOR, use the warning suppression macros to supress warning about use of auto_ptr
DOR, use the warning suppression macros to supress warning about use of auto_ptr
std::stringstream rtctk::componentFramework::Export | ( | StateMachine & | sm, |
std::string const & | format | ||
) |
Export the in-memory state machine model in various formats.
sm | reference to the state machine model. |
format | format as a string, options "scxml", "smcat", "puml", "debug" |
various | rtctk::componentFramework::RtctkException exceptions |
rtctk::componentFramework::FASTDDS_SEQUENCE | ( | AgnosticTopicSeq | , |
AgnosticTopic | |||
) |
rtctk::componentFramework::FASTDDS_SEQUENCE | ( | SampleInfoSeq | , |
SampleInfo | |||
) |
std::string rtctk::componentFramework::GetCfitsioErrorMsg | ( | int | status | ) |
Helper function to convert a Cfitsio status code to a human readable message.
[in] | status | The status code set by a Cfitsio routine. |
std::size_t rtctk::componentFramework::GetFitsImageSize | ( | const std::string & | filename | ) |
Get the number of pixels in a FITS image.
This method will return the total number pixels in the image stored in the primary HDU of a FITS file.
filename | The name of the FITS file to query. |
RtctkException | If the FITS file could not be read or has the wrong format. |
const std::type_info & rtctk::componentFramework::GetFitsImageType | ( | const std::string & | filename | ) |
Get the C++ type corresponding to a FITS image.
This method will identify the FITS format of the image in the primary HDU and return the type info object corresponding to the C++ type that should be used with one of the methods: ReadVectorFromFits, WriteVectorToFits, ReadMatrixFromFits or WriteMatrixToFits.
filename | The name of the FITS file to query. |
RtctkException | If the FITS file could not be read or has the wrong format. |
void rtctk::componentFramework::GetFITSTForm | ( | std::vector< std::string > & | input | ) |
Get a vactor of TFORM strings for a list of types.
input | vector into which the TFORM values should be written |
std::string rtctk::componentFramework::GetFitsType | ( | ) |
Get the TFORM value for a type.
Supports integers, float, double and std::arrays with these types
log4cplus::Logger& rtctk::componentFramework::GetLogger | ( | const std::string & | name = "" | ) |
Get handle to a specific logger (used with logging macros)
The default logger will be retrieved when calling GetLogger() without any further arguments
name | optional: name of the requested logger |
log4cplus::Logger& rtctk::componentFramework::GetLogger | ( | const string & | logger_name | ) |
std::optional< numapp::NumaPolicies > rtctk::componentFramework::GetNumaPolicies | ( | RepositoryIf & | repo, |
const DataPointPath & | path | ||
) |
Constructs a NumaPolicies object from the configuration datapoints found under the given datapoint path.
repo | Repository to read from. |
path | The base path under which configuration datapoints for NUMA policies will be searched. The following sub-paths will be searched:
|
Valid values for the scheduler_policy
datapoint are:
Fifo
Rr
Other
Batch
If either Fifo or Rr are used then the scheduler_priority
must be used to set the threads priority. Valid values for scheduler_priority
is different depending on scheduler_policy:
Fifo
and Rr:
1-99Other
and Batch:
-20 - 19 with 0 being the default. This is also known as the "nice" value.Valid values for the memory_policy_mode
datapoint are:
Default
Bind
Interleave
Preferred
scheduler_priority
without scheduler_policy has no effect. scheduler_policy
must always be used if scheduler_priority
is set in the configuration. memory_policy_mode
and memory_policy_nodes
must be provided together. bool rtctk::componentFramework::GetOptionalParam | ( | RepositoryIf & | repo, |
const DataPointPath & | path, | ||
T & | value | ||
) |
Get optional datapoint.
T | Data point type. |
repo | Repository to read from. | |
path | Data point to read. | |
[out] | value | Destination variable for read datapoint. Will not be modified if datapoint does not exist. |
true | if the datapoint exists and value has been set. |
false | otherwise. |
std::shared_ptr<typename EVENT::payload_t> rtctk::componentFramework::GetPayloadNothrow | ( | scxml4cpp::Context * | c | ) |
|
inline |
const char * rtctk::componentFramework::GetTopicName | ( | DataReader * | reader | ) |
const char * rtctk::componentFramework::GetTopicName | ( | DataWriter * | writer | ) |
elt::mal::future<std::string> rtctk::componentFramework::InjectReqRepEvent | ( | StateMachineEngine & | engine | ) |
elt::mal::future<std::string> rtctk::componentFramework::InjectReqRepEvent | ( | StateMachineEngine & | engine, |
PayloadType & | payload | ||
) |
py::module EXPORT_TYPE rtctk::componentFramework::LoadMatrixBufferPyBinds | ( | ) |
py::module EXPORT_TYPE rtctk::componentFramework::LoadVectorBufferPyBinds | ( | ) |
void rtctk::componentFramework::LogConfigure | ( | const std::string & | cfg_file_name = "" | ) |
Initial logging system configuration.
If no log properties file is given, the system will be configured programmatically using the RTC Tk default settings for three log sinks:
cfg_file_name | optional pathname of log4cplus .properties file |
void rtctk::componentFramework::LogConfigure | ( | const string & | cfg_file_name | ) |
int rtctk::componentFramework::Main | ( | int | argc, |
char * | argv[] | ||
) |
Main function implementation.
Main reason for this is to have the implementation inside a namespace owned by rtctk to avoid name lookup problems.
void rtctk::componentFramework::MakeLogger | ( | const std::string & | name, |
log4cplus::LogLevel | ll, | ||
bool | log_to_file = true , |
||
bool | additive = false , |
||
log4cplus::LogLevel | log_to_console_threshold = log4cplus::NOT_SET_LOG_LEVEL |
||
) |
Retrieve new logger programmatically.
name | name of the new logger |
ll | initial log level (can be changed later) |
log_to_file | optional: should a log-file be created in the logsink directory |
additive | optional: enable additivity for logger |
log_to_console_threshold | optional: threshold of console logs |
void rtctk::componentFramework::MakeLogger | ( | const string & | name, |
log4cplus::LogLevel | ll, | ||
bool | log_to_file, | ||
bool | additive, | ||
log4cplus::LogLevel | log_to_console_threshold | ||
) |
|
constexprnoexcept |
Compares two MatrixBuffer objects and returns true if they do not have the same shape or the elements are different.
|
inline |
|
inline |
InvalidPathException | When invalid characters are found. Only a-z,0-9,_,/ are allowed, no duplicate slashes '/', and no triple underscores '_' or trailing underscores. |
lhs | Left hand side operand. |
rhs | Right hand side operand. |
|
inline |
lhs | Left hand side operand. |
rhs | Right hand side operand. |
|
inlinenoexcept |
|
inlinenoexcept |
|
inlinenoexcept |
|
constexprnoexcept |
Compares two MatrixBuffer objects and returns true
for the following cases:
lhs
matrix has fewer elements.lhs
and rhs
, but lhs
has fewer rows.operator<
returns true for the first element that is different between lhs
and rhs
. For any other case we return false
. std::ostream& rtctk::componentFramework::operator<< | ( | std::ostream & | os, |
AlertServiceIf::AlertStatus const & | status | ||
) |
|
inline |
|
inlinenoexcept |
|
inlinenoexcept |
|
inlinenoexcept |
|
constexprnoexcept |
Compares two MatrixBuffer objects and effectively returns rhs
<
lhs
or
rhs
==
lhs
.
|
inlinenoexcept |
|
inlinenoexcept |
|
inlinenoexcept |
|
constexprnoexcept |
Compares two MatrixBuffer objects and returns true if they have the same shape and identical elements.
|
inlinenoexcept |
|
inlinenoexcept |
|
inlinenoexcept |
|
constexprnoexcept |
Compares two MatrixBuffer objects and returns true
for the following cases:
lhs
matrix has more elements.lhs
and rhs
, but lhs
has more rows.operator>
returns true for the first element that is different between lhs
and rhs
. For any other case we return false
.
|
inlinenoexcept |
|
inlinenoexcept |
|
inlinenoexcept |
|
constexprnoexcept |
Compares two MatrixBuffer objects and effectively returns rhs
>
lhs
or
rhs
==
lhs
.
std::istream& rtctk::componentFramework::operator>> | ( | std::istream & | input, |
DataPointPath & | path | ||
) |
std::string rtctk::componentFramework::PrettyTypeName | ( | ) |
void rtctk::componentFramework::PrintNestedExceptions | ( | std::ostream & | os, |
std::exception const & | exception | ||
) |
Print nested exception(s) in exception messages to os.
It uses a simple form where first line is indented and prefixed as:
exception: Message exception: Nested message exception: Even more nested
os | output stream to print to. |
exception | exception (possibly nested) to print. |
void rtctk::componentFramework::PrintNestedExceptions | ( | std::ostream & | os, |
std::exception_ptr | ptr | ||
) |
Print nested exception(s) in exception messages to os.
If ptr does not hold an exception this function has no effect.
os | output stream to print to. |
ptr | exception (possibly nested) to print. |
rtctk::componentFramework::PYBIND11_EMBEDDED_MODULE | ( | Import_Matrix_Buffer | , |
m | |||
) |
rtctk::componentFramework::PYBIND11_EMBEDDED_MODULE | ( | Import_Vector_Buffer | , |
m | |||
) |
void rtctk::componentFramework::ReadMatrixFromFits | ( | const std::string & | filename, |
MatrixBuffer< bool, A > & | matrix | ||
) |
Reads a matrix of boolean values from a FITS image with 8 bits per pixel.
void rtctk::componentFramework::ReadMatrixFromFits | ( | const std::string & | filename, |
MatrixBuffer< T, A > & | matrix | ||
) |
Reads a FITS file image into a MatrixBuffer object representing a matrix.
[in] | filename | Name of the FITS file to read from. |
[out] | matrix | The matrix data object that will be updated with the loaded data. |
void rtctk::componentFramework::ReadVectorFromFits | ( | const std::string & | filename, |
std::vector< bool, A > & | vector | ||
) |
Read a vector of boolean values from a FITS files containing a 1D image of 8 bit pixels.
void rtctk::componentFramework::ReadVectorFromFits | ( | const std::string & | filename, |
std::vector< T, A > & | vector | ||
) |
Reads a FITS file containing a 1D image into a std::vector object.
[in] | filename | Name of the FITS file to read from. |
[out] | vector | The vector data object that will be updated with the loaded data. |
std::string rtctk::componentFramework::ReplaceAll | ( | std::string | str, |
const std::string & | from, | ||
const std::string & | to | ||
) |
std::string rtctk::componentFramework::RetcodeToString | ( | ReturnCode_t | retcode | ) |
rtctk::componentFramework::RTCTK_DEFINE_OPTION | ( | UseDisabling | , |
Disabled | |||
) |
rtctk::componentFramework::RTCTK_DEFINE_OPTION | ( | UseEnabling | , |
Disabled | |||
) |
rtctk::componentFramework::RTCTK_DEFINE_OPTION | ( | UseInitialising | , |
Enabled | |||
) |
rtctk::componentFramework::RTCTK_DEFINE_OPTION | ( | UseStarting | , |
Disabled | |||
) |
void rtctk::componentFramework::SetDefaultLogger | ( | const std::string & | name | ) |
Set the default logger.
The default logger will be retrieved when calling GetLogger() without any further arguments
name | name of the default logger |
AsSpanT<T> rtctk::componentFramework::ToSpan | ( | T & | data | ) |
Simple function that converts types that are convertible to spans to a span.
data | the original data which will be pointed to by the span |
|
noexcept |
Constructs an unspecified exception that derives from both the provided object and std::nested_exception.
std::rethrow_if_nested
as it terminates the application if there's no nested exception.If there is a current exception (std::current_exception() == true
) the nested exception will be stored with the returned exception type.
E | exception type used to deduce the exception type to construct using std::decay<E> . |
exception | Exception used to copy or move-construct the unspecified exception. |
Exceptions | thrown by exception copy/move constructor. |
void rtctk::componentFramework::WriteMatrixToFits | ( | const std::string & | filename, |
const MatrixBuffer< bool, A > & | matrix | ||
) |
Writes a matrix of boolean values as a FITS image with 8 bits per pixel.
void rtctk::componentFramework::WriteMatrixToFits | ( | const std::string & | filename, |
const MatrixBuffer< T, A > & | matrix | ||
) |
Writes MatrixBuffer data representing a matrix as an image to a FITS file.
[in] | filename | Name of the FITS file to create. It will be overwritten if it exists. |
[in] | matrix | The matrix data to write. |
void rtctk::componentFramework::WriteVectorToFits | ( | const std::string & | filename, |
const std::vector< bool, A > & | vector | ||
) |
Write a vector of boolean values to a FITS file as a 1D image of 8 bit pixels.
void rtctk::componentFramework::WriteVectorToFits | ( | const std::string & | filename, |
const std::vector< T, A > & | vector | ||
) |
Writes std::vector data as a 1D image to a FITS file.
[in] | filename | Name of the FITS file to create. It will be overwritten if it exists. |
[in] | vector | The vector data to write. |
std::string rtctk::componentFramework::default_logger = "root" |
const std::string rtctk::componentFramework::DEFAULT_PATTERN = "[%D{%H:%M:%S:%q}][%-5p][%c] %m%n" |
|
inlineconstexpr |
|
inlineconstexpr |
Is true
if the type is a MatrixBuffer<U>
of some type U
.
|
inlineconstexpr |
Is true
if the type is a MatrixSpan<U>
of some type U
.
|
inlineconstexpr |
|
inlineconstexpr |
Is true
if the type is a gsl::span<U>
of some type U
.
|
inlineconstexpr |
Is true
if the type is a std::vector<U>
of some type U
.
|
inlineconstexpr |
Small helper alias for IsSpanConvertible.
|
inline |