spatem_ts_setters.h File Reference

Setter functions for the ETSI ITS SPATEM. More...

#include <etsi_its_msgs_utils/impl/checks.h>

Go to the source code of this file.

Functions
template<typename T1, typename T2>
void	etsi_its_spatem_ts_msgs::access::throwIfOutOfRange (const T1 &val, const T2 &min, const T2 &max, const std::string val_desc)
	Throws an exception if a given value is out of a defined range.
void	etsi_its_spatem_ts_msgs::access::throwIfNotPresent (const bool is_present, const std::string val_desc)
	Throws an exception if the given value is not present.
void	etsi_its_spatem_ts_msgs::access::setIntersectionID (IntersectionID &intsct_id, const uint16_t id)
	Sets the IntersectionID value.
void	etsi_its_spatem_ts_msgs::access::setIntersectionID (IntersectionReferenceID &intsct_ref_id, const uint16_t id)
	Sets the IntersectionID value in an IntersectionReferenceID object.
void	etsi_its_spatem_ts_msgs::access::setIntersectionID (IntersectionState &intsct, const uint16_t id)
	Sets the IntersectionID value in an IntersectionState object.
void	etsi_its_spatem_ts_msgs::access::setMinuteOfTheYear (MinuteOfTheYear &moy, const uint32_t moy_value)
	Sets the MinuteOfTheYear value.
void	etsi_its_spatem_ts_msgs::access::setMinuteOfTheYear (IntersectionState &intsct, const uint32_t moy_value)
	Sets the MinuteOfTheYear value in an IntersectionState object.
void	etsi_its_spatem_ts_msgs::access::setDSecond (DSecond &dsecond, const uint32_t dsecond_value)
	Sets the DSecond value.
void	etsi_its_spatem_ts_msgs::access::setDSecond (DSecond &dsecond, const double dsecond_value)
	Sets the DSecond value using a double.
void	etsi_its_spatem_ts_msgs::access::setDSecond (IntersectionState &intsct, const uint32_t dsecond_value)
	Sets the DSecond value in an IntersectionState object.
void	etsi_its_spatem_ts_msgs::access::setDSecond (IntersectionState &intsct, const double dsecond_value)
	Sets the DSecond value in an IntersectionState object using a double.
void	etsi_its_spatem_ts_msgs::access::setSignalGroupID (SignalGroupID &signal_group_id, const uint8_t id)
	Sets the SignalGroupID value.
void	etsi_its_spatem_ts_msgs::access::setSignalGroupID (MovementState &movement_state, const uint8_t id)
	Sets the SignalGroupID value in a MovementState object.

Detailed Description

Setter functions for the ETSI ITS SPATEM.

Definition in file spatem_ts_setters.h.

Function Documentation

setDSecond() [1/4]

void etsi_its_spatem_ts_msgs::access::setDSecond ( DSecond & dsecond, const double dsecond_value )

inline

Sets the DSecond value using a double.

Parameters

dsecond	The DSecond object to set.
dsecond_value	The value to set in seconds.

Exceptions

std::out_of_range

if the dsecond_value is out of the valid range.

Definition at line 141 of file spatem_ts_setters.h.

                                                                                {
    setDSecond(intsct.time_stamp, dsecond_value);
    intsct.time_stamp_is_present = true;

setDSecond() [2/4]

void etsi_its_spatem_ts_msgs::access::setDSecond ( DSecond & dsecond, const uint32_t dsecond_value )

inline

Sets the DSecond value.

Parameters

dsecond	The DSecond object to set.
dsecond_value	The value to set.

Exceptions

std::out_of_range

if the dsecond_value is out of the valid range.

Definition at line 129 of file spatem_ts_setters.h.

                                                                                  {
    setDSecond(intsct.time_stamp, dsecond_value);
    intsct.time_stamp_is_present = true;

setDSecond() [3/4]

void etsi_its_spatem_ts_msgs::access::setDSecond ( IntersectionState & intsct, const double dsecond_value )

inline

Sets the DSecond value in an IntersectionState object using a double.

Parameters

intsct	The IntersectionState object to set.
dsecond_value	The value to set in seconds.

Exceptions

std::out_of_range

if the dsecond_value is out of the valid range.

Definition at line 165 of file spatem_ts_setters.h.

                                                                                {
    setSignalGroupID(movement_state.signal_group, id);
  }

setDSecond() [4/4]

void etsi_its_spatem_ts_msgs::access::setDSecond ( IntersectionState & intsct, const uint32_t dsecond_value )

inline

Sets the DSecond value in an IntersectionState object.

Parameters

intsct	The IntersectionState object to set.
dsecond_value	The value to set.

Exceptions

std::out_of_range

if the dsecond_value is out of the valid range.

Definition at line 153 of file spatem_ts_setters.h.

                                                                                 {
    throwIfOutOfRange(id, SignalGroupID::MIN, SignalGroupID::MAX, "SignalGroupID");
    signal_group_id.value = id;

setIntersectionID() [1/3]

void etsi_its_spatem_ts_msgs::access::setIntersectionID ( IntersectionID & intsct_id, const uint16_t id )

inline

Sets the IntersectionID value.

Parameters

intsct_id	The IntersectionID object to set.
id	The value to set.

Exceptions

std::out_of_range

if the id is out of the valid range.

Definition at line 71 of file spatem_ts_setters.h.

                                                                              {
    setIntersectionID(intsct.id, id);
  }
 

setIntersectionID() [2/3]

void etsi_its_spatem_ts_msgs::access::setIntersectionID ( IntersectionReferenceID & intsct_ref_id, const uint16_t id )

inline

Sets the IntersectionID value in an IntersectionReferenceID object.

Parameters

intsct_ref_id	The IntersectionReferenceID object to set.
id	The value to set.

Exceptions

std::out_of_range

if the id is out of the valid range.

Definition at line 83 of file spatem_ts_setters.h.

setIntersectionID() [3/3]

void etsi_its_spatem_ts_msgs::access::setIntersectionID ( IntersectionState & intsct, const uint16_t id )

inline

Sets the IntersectionID value in an IntersectionState object.

Parameters

intsct	The IntersectionState object to set.
id	The value to set.

Exceptions

std::out_of_range

if the id is out of the valid range.

Definition at line 94 of file spatem_ts_setters.h.

                                                                                      {
    setMinuteOfTheYear(intsct.moy, moy_value);
    intsct.moy_is_present = true;

setMinuteOfTheYear() [1/2]

void etsi_its_spatem_ts_msgs::access::setMinuteOfTheYear ( IntersectionState & intsct, const uint32_t moy_value )

inline

Sets the MinuteOfTheYear value in an IntersectionState object.

Parameters

intsct	The IntersectionState object to set.
moy_value	The value to set.

Exceptions

std::out_of_range

if the moy_value is out of the valid range.

Definition at line 117 of file spatem_ts_setters.h.

                                                                       {
    uint32_t dsecond_value_ms = (uint32_t)(dsecond_value*1e3);
    setDSecond(dsecond, dsecond_value_ms);

setMinuteOfTheYear() [2/2]

void etsi_its_spatem_ts_msgs::access::setMinuteOfTheYear ( MinuteOfTheYear & moy, const uint32_t moy_value )

inline

Sets the MinuteOfTheYear value.

Parameters

moy	The MinuteOfTheYear object to set.
moy_value	The value to set.

Exceptions

std::out_of_range

if the moy_value is out of the valid range.

Definition at line 105 of file spatem_ts_setters.h.

                                                                         {
    throwIfOutOfRange(dsecond_value, DSecond::MIN, DSecond::MAX, "DSecond");
    dsecond.value = dsecond_value;

setSignalGroupID() [1/2]

void etsi_its_spatem_ts_msgs::access::setSignalGroupID ( MovementState & movement_state, const uint8_t id )

inline

Sets the SignalGroupID value in a MovementState object.

Parameters

movement_state	The MovementState object to set.
id	The value to set.

Exceptions

std::out_of_range

if the id is out of the valid range.

Definition at line 189 of file spatem_ts_setters.h.

                                  {
 
namespace access {
 
#include <etsi_its_msgs_utils/impl/checks.h>

  inline void setIntersectionID(IntersectionID& intsct_id, const uint16_t id) {
    throwIfOutOfRange(id, IntersectionID::MIN, IntersectionID::MAX, "IntersectionID");
    intsct_id.value = id;
  }

  inline void setIntersectionID(IntersectionReferenceID& intsct_ref_id, const uint16_t id) {
    setIntersectionID(intsct_ref_id.id, id);
  }

  inline void setIntersectionID(IntersectionState& intsct, const uint16_t id) {
    setIntersectionID(intsct.id, id);
  }

  inline void setMinuteOfTheYear(MinuteOfTheYear& moy, const uint32_t moy_value) {
    throwIfOutOfRange(moy_value, MinuteOfTheYear::MIN, MinuteOfTheYear::MAX, "MinuteOfTheYear");
    moy.value = moy_value;
  }

  inline void setMinuteOfTheYear(IntersectionState& intsct, const uint32_t moy_value) {
    setMinuteOfTheYear(intsct.moy, moy_value);
    intsct.moy_is_present = true;
  }

  inline void setDSecond(DSecond& dsecond, const uint32_t dsecond_value) {
    throwIfOutOfRange(dsecond_value, DSecond::MIN, DSecond::MAX, "DSecond");
    dsecond.value = dsecond_value;
  }

  inline void setDSecond(DSecond& dsecond, const double dsecond_value) {
    uint32_t dsecond_value_ms = (uint32_t)(dsecond_value*1e3);
    setDSecond(dsecond, dsecond_value_ms);
  }

  inline void setDSecond(IntersectionState& intsct, const uint32_t dsecond_value) {
    setDSecond(intsct.time_stamp, dsecond_value);
    intsct.time_stamp_is_present = true;
  }

  inline void setDSecond(IntersectionState& intsct, const double dsecond_value) {
    setDSecond(intsct.time_stamp, dsecond_value);
    intsct.time_stamp_is_present = true;
  }

  inline void setSignalGroupID(SignalGroupID& signal_group_id, const uint8_t id) {
    throwIfOutOfRange(id, SignalGroupID::MIN, SignalGroupID::MAX, "SignalGroupID");
    signal_group_id.value = id;
  }

  inline void setSignalGroupID(MovementState& movement_state, const uint8_t id) {
    setSignalGroupID(movement_state.signal_group, id);
  }
 
} // namespace access
 
} // namespace etsi_its_spatem_ts_msgs

setSignalGroupID() [2/2]

void etsi_its_spatem_ts_msgs::access::setSignalGroupID ( SignalGroupID & signal_group_id, const uint8_t id )

inline

Sets the SignalGroupID value.

Parameters

signal_group_id	The SignalGroupID object to set.
id	The value to set.

Exceptions

std::out_of_range

if the id is out of the valid range.

Definition at line 177 of file spatem_ts_setters.h.

                                  {
 
namespace access {
 
#include <etsi_its_msgs_utils/impl/checks.h>

  inline void setIntersectionID(IntersectionID& intsct_id, const uint16_t id) {
    throwIfOutOfRange(id, IntersectionID::MIN, IntersectionID::MAX, "IntersectionID");
    intsct_id.value = id;
  }

  inline void setIntersectionID(IntersectionReferenceID& intsct_ref_id, const uint16_t id) {
    setIntersectionID(intsct_ref_id.id, id);
  }

  inline void setIntersectionID(IntersectionState& intsct, const uint16_t id) {
    setIntersectionID(intsct.id, id);
  }

  inline void setMinuteOfTheYear(MinuteOfTheYear& moy, const uint32_t moy_value) {
    throwIfOutOfRange(moy_value, MinuteOfTheYear::MIN, MinuteOfTheYear::MAX, "MinuteOfTheYear");
    moy.value = moy_value;
  }

  inline void setMinuteOfTheYear(IntersectionState& intsct, const uint32_t moy_value) {
    setMinuteOfTheYear(intsct.moy, moy_value);
    intsct.moy_is_present = true;
  }

  inline void setDSecond(DSecond& dsecond, const uint32_t dsecond_value) {
    throwIfOutOfRange(dsecond_value, DSecond::MIN, DSecond::MAX, "DSecond");
    dsecond.value = dsecond_value;
  }

  inline void setDSecond(DSecond& dsecond, const double dsecond_value) {
    uint32_t dsecond_value_ms = (uint32_t)(dsecond_value*1e3);
    setDSecond(dsecond, dsecond_value_ms);
  }

  inline void setDSecond(IntersectionState& intsct, const uint32_t dsecond_value) {
    setDSecond(intsct.time_stamp, dsecond_value);
    intsct.time_stamp_is_present = true;
  }

  inline void setDSecond(IntersectionState& intsct, const double dsecond_value) {
    setDSecond(intsct.time_stamp, dsecond_value);
    intsct.time_stamp_is_present = true;
  }

  inline void setSignalGroupID(SignalGroupID& signal_group_id, const uint8_t id) {
    throwIfOutOfRange(id, SignalGroupID::MIN, SignalGroupID::MAX, "SignalGroupID");
    signal_group_id.value = id;
  }

  inline void setSignalGroupID(MovementState& movement_state, const uint8_t id) {
    setSignalGroupID(movement_state.signal_group, id);
  }
 
} // namespace access
 
} // namespace etsi_its_spatem_ts_msgs

throwIfNotPresent()

void etsi_its_spatem_ts_msgs::access::throwIfNotPresent ( const bool is_present, const std::string val_desc )

inline

Throws an exception if the given value is not present.

Parameters

is_present	Whether the value is present.
val_desc	Description of the value for the exception message.

Definition at line 58 of file spatem_ts_getters.h.

throwIfOutOfRange()

template<typename T1, typename T2>

void etsi_its_spatem_ts_msgs::access::throwIfOutOfRange	(	const T1 &	val,
		const T2 &	min,
		const T2 &	max,
		const std::string	val_desc )

Throws an exception if a given value is out of a defined range.

Template Parameters

T1
T2

Parameters

val	The value to check if it is in the range.
min	The minimum value of the range.
max	The maximum value of the range.
val_desc	Description of the value for the exception message.

Definition at line 47 of file spatem_ts_getters.h.