Timing.h File Reference

#include <RobotAPI/components/units/RobotUnit/util/RtTiming.h>
#include "ErrorReporting.h"

Include dependency graph for Timing.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	Timer
class	Timer
class	Timer

Namespaces
	armarx
	This file offers overloads of toIce() and fromIce() functions for STL container types.
	armarx::control
	armarx::control::ethercat
	armarx::control::ethercat::timing
	armarx::control::ethercat::timing::bus
	armarx::control::ethercat::timing::general
	armarx::control::ethercat::timing::slave

Macros
#define	BUS_TIMING_CEND(name, bin, thresholdMs)   BUS_TIMING_CEND_COMMENT(name, bin, #name, thresholdMs)
#define	BUS_TIMING_CEND_COMMENT(name, bin, comment, thresholdMs)
#define	BUS_TIMING_END(name, bin)   BUS_TIMING_END_COMMENT(name, bin, #name)
#define	BUS_TIMING_END_COMMENT(name, bin, comment)
#define	BUS_TIMING_START(name)
#define	GENERAL_TIMING_CEND(name, thresholdMs)   GENERAL_TIMING_CEND_COMMENT(name, #name, thresholdMs)
#define	GENERAL_TIMING_CEND_COMMENT(name, comment, thresholdMs)
#define	GENERAL_TIMING_END(name)   GENERAL_TIMING_END_COMMENT(name, #name)
#define	GENERAL_TIMING_END_COMMENT(name, comment)
#define	GENERAL_TIMING_START(name)
#define	SLAVE_TIMING_CEND(sid, name, thresholdMs)   SLAVE_TIMING_CEND_COMMENT(sid, name, #name, thresholdMs)
#define	SLAVE_TIMING_CEND_COMMENT(sid, name, comment, thresholdMs)
#define	SLAVE_TIMING_END(sid, name)   SLAVE_TIMING_END_COMMENT(sid, name, #name)
#define	SLAVE_TIMING_END_COMMENT(sid, name, comment)
#define	SLAVE_TIMING_START(name)

Variables
constexpr bool	enableTimingInformation = false

Macro Definition Documentation

BUS_TIMING_CEND

#define BUS_TIMING_CEND	(		name,
			bin,
			thresholdMs
	)		BUS_TIMING_CEND_COMMENT(name, bin, #name, thresholdMs)

Definition at line 181 of file Timing.h.

BUS_TIMING_CEND_COMMENT

#define BUS_TIMING_CEND_COMMENT	(		name,
			bin,
			comment,
			thresholdMs
	)

Value:

    if constexpr (armarx::control::ethercat::timing::enableTimingInformation)                      \
    {                                                                                              \
        name.end(bin, comment, thresholdMs);                                                       \
    }

Definition at line 176 of file Timing.h.

BUS_TIMING_END

#define BUS_TIMING_END	(		name,
			bin
	)		BUS_TIMING_END_COMMENT(name, bin, #name)

Definition at line 175 of file Timing.h.

BUS_TIMING_END_COMMENT

#define BUS_TIMING_END_COMMENT	(		name,
			bin,
			comment
	)

Value:

    if constexpr (armarx::control::ethercat::timing::enableTimingInformation)                      \
    {                                                                                              \
        name.end(bin, comment);                                                                    \
    }

Definition at line 170 of file Timing.h.

BUS_TIMING_START

#define BUS_TIMING_START

(

name

)

Value:

    auto name = armarx::control::ethercat::timing::bus::Timer();                                   \
    if constexpr (armarx::control::ethercat::timing::enableTimingInformation)                      \
    {                                                                                              \
        name.start();                                                                              \
    }

Definition at line 163 of file Timing.h.

GENERAL_TIMING_CEND

#define GENERAL_TIMING_CEND	(		name,
			thresholdMs
	)		GENERAL_TIMING_CEND_COMMENT(name, #name, thresholdMs)

Definition at line 159 of file Timing.h.

GENERAL_TIMING_CEND_COMMENT

#define GENERAL_TIMING_CEND_COMMENT	(		name,
			comment,
			thresholdMs
	)

Value:

    if constexpr (armarx::control::ethercat::timing::enableTimingInformation)                      \
    {                                                                                              \
        name.end(comment, thresholdMs);                                                            \
    }

Definition at line 154 of file Timing.h.

GENERAL_TIMING_END

#define GENERAL_TIMING_END

(

name

)

GENERAL_TIMING_END_COMMENT(name, #name)

Definition at line 153 of file Timing.h.

GENERAL_TIMING_END_COMMENT

#define GENERAL_TIMING_END_COMMENT	(		name,
			comment
	)

Value:

    if constexpr (armarx::control::ethercat::timing::enableTimingInformation)                      \
    {                                                                                              \
        name.end(comment);                                                                         \
    }

Definition at line 148 of file Timing.h.

GENERAL_TIMING_START

#define GENERAL_TIMING_START

(

name

)

Value:

    auto name = armarx::control::ethercat::timing::general::Timer();                               \
    if constexpr (armarx::control::ethercat::timing::enableTimingInformation)                      \
    {                                                                                              \
        name.start();                                                                              \
    }

Definition at line 142 of file Timing.h.

SLAVE_TIMING_CEND

#define SLAVE_TIMING_CEND	(		sid,
			name,
			thresholdMs
	)		SLAVE_TIMING_CEND_COMMENT(sid, name, #name, thresholdMs)

Definition at line 203 of file Timing.h.

SLAVE_TIMING_CEND_COMMENT

#define SLAVE_TIMING_CEND_COMMENT	(		sid,
			name,
			comment,
			thresholdMs
	)

Value:

    if constexpr (armarx::control::ethercat::timing::enableTimingInformation)                      \
    {                                                                                              \
        name.end(sid, comment, thresholdMs);                                                       \
    }

Definition at line 198 of file Timing.h.

SLAVE_TIMING_END

#define SLAVE_TIMING_END	(		sid,
			name
	)		SLAVE_TIMING_END_COMMENT(sid, name, #name)

Definition at line 197 of file Timing.h.

SLAVE_TIMING_END_COMMENT

#define SLAVE_TIMING_END_COMMENT	(		sid,
			name,
			comment
	)

Value:

    if constexpr (armarx::control::ethercat::timing::enableTimingInformation)                      \
    {                                                                                              \
        name.end(sid, comment);                                                                    \
    }

Definition at line 192 of file Timing.h.

SLAVE_TIMING_START

#define SLAVE_TIMING_START

(

name

)

Value:

    auto name = armarx::control::ethercat::timing::slave::Timer();                                 \
    if constexpr (armarx::control::ethercat::timing::enableTimingInformation)                      \
    {                                                                                              \
        name.start();                                                                              \
    }

Definition at line 186 of file Timing.h.