control::PortLayout< Channels > Struct Template Reference

Port layout over either the state-space input or output axis. More...

#include <control_traits.hpp>

Public Types
using	ChannelsTuple = std::tuple< Channels... >

Static Public Member Functions
template<PortRole Role>
static consteval std::size_t	count ()
	count channels matching a port role
template<PortRole Role>
static consteval std::size_t	total_size ()
	total dimension for channels matching a port role
template<PortRole Role, std::size_t Index>
static consteval std::size_t	offset ()
	offset of the Index-th channel matching a port role
template<PortRole Role, std::size_t Index>
static consteval std::size_t	size ()
	size of the Index-th channel matching a port role
template<std::size_t FullDim>
static consteval bool	validates ()
	validate port bounds and overlap against a full axis dimension

Detailed Description

template<PortLike... Channels>
struct control::PortLayout< Channels >

Port layout over either the state-space input or output axis.

Definition at line 41 of file control_traits.hpp.

Member Typedef Documentation

ChannelsTuple

template<PortLike... Channels>

using control::PortLayout< Channels >::ChannelsTuple = std::tuple<Channels...>

Definition at line 42 of file control_traits.hpp.

Member Function Documentation

count()

template<PortLike... Channels>

template<PortRole Role>

static consteval std::size_t control::PortLayout< Channels >::count ( )

inlinestatic

count channels matching a port role

Definition at line 46 of file control_traits.hpp.

offset()

template<PortLike... Channels>

template<PortRole Role, std::size_t Index>

static consteval std::size_t control::PortLayout< Channels >::offset ( )

inlinestatic

offset of the Index-th channel matching a port role

Definition at line 60 of file control_traits.hpp.

size()

template<PortLike... Channels>

template<PortRole Role, std::size_t Index>

static consteval std::size_t control::PortLayout< Channels >::size ( )

inlinestatic

size of the Index-th channel matching a port role

Definition at line 76 of file control_traits.hpp.

total_size()

template<PortLike... Channels>

template<PortRole Role>

static consteval std::size_t control::PortLayout< Channels >::total_size ( )

inlinestatic

total dimension for channels matching a port role

Definition at line 53 of file control_traits.hpp.

validates()

template<PortLike... Channels>

template<std::size_t FullDim>

static consteval bool control::PortLayout< Channels >::validates ( )

inlinestatic

validate port bounds and overlap against a full axis dimension

Definition at line 91 of file control_traits.hpp.

---

The documentation for this struct was generated from the following file:

• include/akreon/control/control_traits.hpp