Global namespace

Namespaces

Name

adapnex

Functions

Name

setup

Using Namespace Directives

Name

chrono_literals

adapnex namespace

Namespaces

Name

core

drivers

platforms

adapnex::core namespace

Types

Name

Description

Application

BaseSignal

ClockGenerator

A pulse generator that can be used to generate cyclic pulses.

Context

The Context class allows access to global information relevant to the execution of the application. Instances of this class are always thread‐local.

F_TRIG

Falling edge detector.

Hysteresis

A hysteresis that sets/resets the output when the defined thresholds are crossed.

HysteresisWithDelay

A hysteresis that sets/resets the output when the defined thresholds are crossed and a delay elapses.

InputArrayMapping

InputArrayMapping provides an interface for input drivers to pass an array of values to an application. Individual elements can be selected using the index operator and then accessed via the value() method or by mapping a variable that will hold the element's value.

InputValueMapping

InputValueMapping provides an interface for input drivers to pass values to an application. The value can be accessed via the value() method or by mapping a variable that will hold the value.

LambdaTask

A helper class allowing a task to be defined by a lambda function.

Mutex

Mutex defines the interface for platform‐agnostic lock that conforms to BasicLockable and Lockable. This Mutex should be used instead of standard library types like std::lock to ensure priority inheritance is used on real‐time capable platforms.

OutputArrayMapping

OutputArrayMapping provides an interface for output drivers to receive an array of values from an application. Individual elements can be selected using the index operator and then accessed via the value() method or by mapping a variable that holds the element's value.

OutputValueMapping

OutputValueMapping provides an interface for output drivers to receive values from an application. The value can be accessed via the value() method or by mapping a variable that holds the value.

RS

Bistable with dominant reset.

R_TRIG

Rising edge detector.

SR

Bistable with dominant set.

SerialPort

Represents a serial port.

Signal

SquareWaveGenerator

A cyclic signal generator that produces pulses with defined high and low durations.

TCPConnection

Represents a TCP connection.

TOF

An off‐delay timer that delays the falling edge of a signal by a defined duration.

TON

An on‐delay timer that delays the rising edge of a signal by a defined duration.

TP

A pulse generator that can be used to generate pulses with a defined pulse duration.

Task

Task represents a base class to implement schedulable application components. Tasks are combined via TaskGroup and executed by the scheduler according to the given scheduling parameters. See Application::CreateCyclicTaskGroup() and Application::CreateFreewheelingTaskGroup().

TaskGroup

TaskGroup provides the interface used to schedule multiple tasks together on the same thread. This allows, for example, drivers to be scheduled together with the tasks reading or writing from their inputs or outputs. This approach allows the driver to synchronise updates with task execution so that the tasks observe a consistent view of the inputs and outputs each cycle.

Timer

Trigger

UDPConnection

Duration

Type used to describe relative time.

SignalSet

Functions

Name

Description

map

Maps a number linearly from one range to another.

adapnex::drivers namespace

Namespaces

Name

bnr_x2x

compulab

wago

adapnex::drivers::compulab namespace

Namespaces

Name

iotdin_imx8p

adapnex::drivers::wago namespace

Namespaces

Name

cc100

adapnex::drivers::wago::cc100 namespace

Types

Name

Description

CC100IODriver

Driver for all built‐in digital and analog I/O ports on the WAGO CC100.

DigitalInputMapping

DigitalOutputMapping

adapnex::platforms namespace

Namespaces

Name

simulation

adapnex::platforms::simulation namespace

Types

Name

Description

MockContext

Simulation

Simulation implements a test fixture that allows standard scheduling APIs like Application::CreateCyclicTaskGroup() to be used in a unit test, where the application can be simulated faster than real‐time. To use the simulation test fixture declare a test using TEST_F(Simulation, ...) { ... }. Call Simulate() to run the simulation.

SimulationTaskGroup

Created with MrDocs