cras::DurationStatusParam Struct Reference

Parameters of DurationStatus diagnostic task. More...

#include <duration_status_param.h>

Public Member Functions
	DurationStatusParam (const ::ros::Duration &minDuration={0, 0}, const ::ros::Duration &maxDuration=::ros::DURATION_MAX, double tolerance=0.1, size_t windowSize=5, bool noEventsIsOk=true)
	Construct the parameter object using the passed values. More...
	DurationStatusParam (const ::cras::DurationStatusParam &other)
	Copy constructor. More...
	DurationStatusParam (const ::cras::SimpleDurationStatusParam &params)
	Initialize this object from SimpleDuraitonStatusParam. More...
::cras::DurationStatusParam &	operator= (const ::cras::DurationStatusParam &other)
	Copy assignment operator. More...

Public Attributes
::ros::Duration	maxDuration {::ros::DURATION_MAX}
	Maximum duration considered as valid. More...
::ros::Duration	minDuration {0, 0}
	Minimum duration considered as valid. More...
bool	noEventsIsOk {true}
	Whether it is okay when there are no events between two update calls. More...
double	tolerance {0.1}
	Tolerance of the duration. More...
size_t	windowSize {5u}
	Number of updates during which the duration is computed. More...

Detailed Description

Parameters of DurationStatus diagnostic task.

Definition at line 21 of file duration_status_param.h.

Constructor & Destructor Documentation

DurationStatusParam() [1/3]

cras::DurationStatusParam::DurationStatusParam ( const ::ros::Duration &  minDuration = {0, 0}, const ::ros::Duration &  maxDuration = ::ros::DURATION_MAX, double  tolerance = 0.1, size_t  windowSize = 5, bool  noEventsIsOk = true  )

explicit

Construct the parameter object using the passed values.

Parameters

[in]	minDuration	Minimum allowed duration.
[in]	maxDuration	Maximum allowed duration.
[in]	tolerance	Tolerance of the duration.
[in]	windowSize	Number of updates during which the duration stats are considered.
[in]	noEventsIsOk	Whether it is okay when there are no events between two update calls.

DurationStatusParam() [2/3]

cras::DurationStatusParam::DurationStatusParam

(

const ::cras::DurationStatusParam &

other

)

Copy constructor.

Parameters

[in]

other

The object to copy from.

DurationStatusParam() [3/3]

cras::DurationStatusParam::DurationStatusParam

(

const ::cras::SimpleDurationStatusParam &

params

)

Initialize this object from SimpleDuraitonStatusParam.

Parameters

[in]

params

The parameters to initialize with.

Member Function Documentation

operator=()

::cras::DurationStatusParam& cras::DurationStatusParam::operator=

(

const ::cras::DurationStatusParam &

other

)

Copy assignment operator.

Parameters

[in]

other

The object to copy from.

Member Data Documentation

maxDuration

::ros::Duration cras::DurationStatusParam::maxDuration {::ros::DURATION_MAX}

Maximum duration considered as valid.

Definition at line 57 of file duration_status_param.h.

minDuration

::ros::Duration cras::DurationStatusParam::minDuration {0, 0}

Minimum duration considered as valid.

Definition at line 54 of file duration_status_param.h.

noEventsIsOk

bool cras::DurationStatusParam::noEventsIsOk {true}

Whether it is okay when there are no events between two update calls.

Definition at line 66 of file duration_status_param.h.

tolerance

double cras::DurationStatusParam::tolerance {0.1}

Tolerance of the duration.

Definition at line 60 of file duration_status_param.h.

windowSize

size_t cras::DurationStatusParam::windowSize {5u}

Number of updates during which the duration is computed.

Definition at line 63 of file duration_status_param.h.

---

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

• duration_status_param.h