MIRA: ChannelAccessWrapper< T > Struct Template Reference

MIRA

#include <python/UnitWrapper.h>

Static Public Member Functions
static T	get (Channel< T > &channel)
	Typed get method for typed channel which must be declared for every wrapped type. More...

static T	getTime (Channel< T > &channel, const Time &time)
	Typed get method for typed channel which must be declared for every wrapped type. More...

static T	getTimeDuration (Channel< T > &channel, const Time &time, const Duration &tolerance)
	Typed get method for typed channel which must be declared for every wrapped type. More...

static ChannelRead< T >	read (Channel< T > &channel)
	Typed get method for typed channel which must be declared for every wrapped type. More...

static ChannelRead< T >	readTime (Channel< T > &channel, const Time &time)
	Typed get method for typed channel which must be declared for every wrapped type. More...

static ChannelRead< T >	readTimeDuration (Channel< T > &channel, const Time &time, const Duration &tolerance)
	Typed get method for typed channel which must be declared for every wrapped type. More...

static void	postTimeFrame (Channel< T > &channel, const T &value, const Time &time, const std::string &frameID)
	Typed post method for typed channel which must be declared for every wrapped type. More...

static void	postTime (Channel< T > &channel, const T &value, const Time &time)

static void	post (Channel< T > &channel, const T &value)

Member Function Documentation

◆ get()

static T get ( Channel< T > & channel )

inlinestatic

Typed get method for typed channel which must be declared for every wrapped type.

This is automatically appended to the definition of the wrapper when using the macro MIRA_PYCONNECTOR_TYPE_FOOTER.

◆ getTime()

static T getTime	(	Channel< T > &	channel,
		const Time &	time
	)

inlinestatic

Typed get method for typed channel which must be declared for every wrapped type.

This is automatically appended to the definition of the wrapper when using the macro MIRA_PYCONNECTOR_TYPE_FOOTER.

◆ getTimeDuration()

static T getTimeDuration	(	Channel< T > &	channel,
		const Time &	time,
		const Duration &	tolerance
	)

inlinestatic

Typed get method for typed channel which must be declared for every wrapped type.

This is automatically appended to the definition of the wrapper when using the macro MIRA_PYCONNECTOR_TYPE_FOOTER.

◆ read()

static ChannelRead<T> read ( Channel< T > & channel )

inlinestatic

Typed get method for typed channel which must be declared for every wrapped type.

This is automatically appended to the definition of the wrapper when using the macro MIRA_PYCONNECTOR_TYPE_FOOTER.

◆ readTime()

static ChannelRead<T> readTime	(	Channel< T > &	channel,
		const Time &	time
	)

inlinestatic

Typed get method for typed channel which must be declared for every wrapped type.

This is automatically appended to the definition of the wrapper when using the macro MIRA_PYCONNECTOR_TYPE_FOOTER.

◆ readTimeDuration()

static ChannelRead<T> readTimeDuration	(	Channel< T > &	channel,
		const Time &	time,
		const Duration &	tolerance
	)

inlinestatic

Typed get method for typed channel which must be declared for every wrapped type.

This is automatically appended to the definition of the wrapper when using the macro MIRA_PYCONNECTOR_TYPE_FOOTER.

◆ postTimeFrame()

static void postTimeFrame	(	Channel< T > &	channel,
		const T &	value,
		const Time &	time,
		const std::string &	frameID
	)

inlinestatic

Typed post method for typed channel which must be declared for every wrapped type.

This is automatically appended to the definition of the wrapper when using the macro MIRA_PYCONNECTOR_TYPE_FOOTER. For some reasons (seems to be known in the community) py::class_ does not take Channel<int>::post directly. So we have to build it that way.

◆ postTime()

static void postTime	(	Channel< T > &	channel,
		const T &	value,
		const Time &	time
	)

inlinestatic

◆ post()

static void post	(	Channel< T > &	channel,
		const T &	value
	)

inlinestatic

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

include/python/UnitWrapper.h