spatem_ts_getters.h File Reference

Getter 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.
uint16_t	etsi_its_spatem_ts_msgs::access::getIntersectionID (const IntersectionID &intsct_id)
	Get the intersection-id.
uint16_t	etsi_its_spatem_ts_msgs::access::getIntersectionID (const IntersectionReferenceID &intsct_ref_id)
	Get the intersection-id of an IntersectionReferenceID object.
uint16_t	etsi_its_spatem_ts_msgs::access::getIntersectionID (const IntersectionState &intsct)
	Get the intersection-id of an IntersectionState object.
MinuteOfTheYear	etsi_its_spatem_ts_msgs::access::getMinuteOfTheYear (const IntersectionState &intsct)
	Get the MinuteOfTheYear object from a given IntersectionState object.
DSecond	etsi_its_spatem_ts_msgs::access::getDSecond (const IntersectionState &intsct)
	Get the DSecond object from a given IntersectionState object.
double	etsi_its_spatem_ts_msgs::access::getDSecondValue (const DSecond &dsecond)
	Get the value of a DSecond object in seconds.
double	etsi_its_spatem_ts_msgs::access::getDSecondValue (const IntersectionState &intsct)
	Get the value of an DSecond object from a given IntersectionState object.
uint8_t	etsi_its_spatem_ts_msgs::access::getSignalGroupID (const SignalGroupID &signal_group_id)
	Get the Signal Group-ID of an SignalGroupID object.
uint8_t	etsi_its_spatem_ts_msgs::access::getSignalGroupID (const MovementState &mvmt_state)
	Get the Signal Group-ID of an MovementState object.
MovementEvent	etsi_its_spatem_ts_msgs::access::getCurrentMovementEvent (const MovementState &mvmt_state)
	Get the current MovementEvent of a given MovementState object.
MovementPhaseState	etsi_its_spatem_ts_msgs::access::getCurrentMovementPhaseState (const MovementState &mvmt_state)
	Get the Current MovementPhaseState object of a given MovementState object.
uint8_t	etsi_its_spatem_ts_msgs::access::getCurrentMovementPhaseStateValue (const MovementState &mvmt_state)
	Get the Current MovementPhaseState object of a given MovementState object.

Detailed Description

Getter functions for the ETSI ITS SPATEM.

Definition in file spatem_ts_getters.h.

Function Documentation

getCurrentMovementEvent()

MovementEvent etsi_its_spatem_ts_msgs::access::getCurrentMovementEvent ( const MovementState & mvmt_state )

inline

Get the current MovementEvent of a given MovementState object.

Parameters

mvmt_event

MovementState object to get the MovementEvent from

Returns

MovementEvent object

Definition at line 162 of file spatem_ts_getters.h.

getCurrentMovementPhaseState()

MovementPhaseState etsi_its_spatem_ts_msgs::access::getCurrentMovementPhaseState ( const MovementState & mvmt_state )

inline

Get the Current MovementPhaseState object of a given MovementState object.

Parameters

mvmt_state

MovementState object to get the MovementPhaseState from

Returns

MovementPhaseState object

Definition at line 175 of file spatem_ts_getters.h.

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

  inline uint16_t getIntersectionID(const IntersectionID& intsct_id) {
    return intsct_id.value;
  }

  inline uint16_t getIntersectionID(const IntersectionReferenceID& intsct_ref_id) {
    return getIntersectionID(intsct_ref_id.id);
  }

  inline uint16_t getIntersectionID(const IntersectionState& intsct) {
    return getIntersectionID(intsct.id);
  }

  inline MinuteOfTheYear getMinuteOfTheYear(const IntersectionState& intsct) {
    throwIfNotPresent(intsct.moy_is_present, "intsct.moy");
    return intsct.moy;
  }

  inline DSecond getDSecond(const IntersectionState& intsct) {
    throwIfNotPresent(intsct.time_stamp_is_present, "intsct.time_stamp");
    return intsct.time_stamp;
  }

  inline double getDSecondValue(const DSecond& dsecond) {
    return ((double)dsecond.value)*1e-3;
  }

  inline double getDSecondValue(const IntersectionState& intsct) {
    return getDSecondValue(getDSecond(intsct));
  }

  inline uint8_t getSignalGroupID(const SignalGroupID& signal_group_id) {
    return signal_group_id.value;
  }

  inline uint8_t getSignalGroupID(const MovementState& mvmt_state) {
    return getSignalGroupID(mvmt_state.signal_group);
  }

  inline MovementEvent getCurrentMovementEvent(const MovementState& mvmt_state) {
    if(mvmt_state.state_time_speed.array.size()<=0) {
      throw std::runtime_error("MovementEventList is empty.");
    }
    return mvmt_state.state_time_speed.array[0];
  }

  inline MovementPhaseState getCurrentMovementPhaseState(const MovementState& mvmt_state) {
    return getCurrentMovementEvent(mvmt_state).event_state;
  }

  inline uint8_t getCurrentMovementPhaseStateValue(const MovementState& mvmt_state) {
    return getCurrentMovementPhaseState(mvmt_state).value;
  }
 
} // namespace access
 
} // namespace etsi_its_spatem_ts_msgs

getCurrentMovementPhaseStateValue()

uint8_t etsi_its_spatem_ts_msgs::access::getCurrentMovementPhaseStateValue ( const MovementState & mvmt_state )

inline

Get the Current MovementPhaseState object of a given MovementState object.

Parameters

mvmt_state

MovementState object to get the MovementPhaseState from

Returns

MovementPhaseState object

Definition at line 185 of file spatem_ts_getters.h.

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

  inline uint16_t getIntersectionID(const IntersectionID& intsct_id) {
    return intsct_id.value;
  }

  inline uint16_t getIntersectionID(const IntersectionReferenceID& intsct_ref_id) {
    return getIntersectionID(intsct_ref_id.id);
  }

  inline uint16_t getIntersectionID(const IntersectionState& intsct) {
    return getIntersectionID(intsct.id);
  }

  inline MinuteOfTheYear getMinuteOfTheYear(const IntersectionState& intsct) {
    throwIfNotPresent(intsct.moy_is_present, "intsct.moy");
    return intsct.moy;
  }

  inline DSecond getDSecond(const IntersectionState& intsct) {
    throwIfNotPresent(intsct.time_stamp_is_present, "intsct.time_stamp");
    return intsct.time_stamp;
  }

  inline double getDSecondValue(const DSecond& dsecond) {
    return ((double)dsecond.value)*1e-3;
  }

  inline double getDSecondValue(const IntersectionState& intsct) {
    return getDSecondValue(getDSecond(intsct));
  }

  inline uint8_t getSignalGroupID(const SignalGroupID& signal_group_id) {
    return signal_group_id.value;
  }

  inline uint8_t getSignalGroupID(const MovementState& mvmt_state) {
    return getSignalGroupID(mvmt_state.signal_group);
  }

  inline MovementEvent getCurrentMovementEvent(const MovementState& mvmt_state) {
    if(mvmt_state.state_time_speed.array.size()<=0) {
      throw std::runtime_error("MovementEventList is empty.");
    }
    return mvmt_state.state_time_speed.array[0];
  }

  inline MovementPhaseState getCurrentMovementPhaseState(const MovementState& mvmt_state) {
    return getCurrentMovementEvent(mvmt_state).event_state;
  }

  inline uint8_t getCurrentMovementPhaseStateValue(const MovementState& mvmt_state) {
    return getCurrentMovementPhaseState(mvmt_state).value;
  }
 
} // namespace access
 
} // namespace etsi_its_spatem_ts_msgs

getDSecond()

DSecond etsi_its_spatem_ts_msgs::access::getDSecond ( const IntersectionState & intsct )

inline

Get the DSecond object from a given IntersectionState object.

Parameters

intsct

IntersectionState object to get the DSecond from

Returns

DSecond object

Definition at line 111 of file spatem_ts_getters.h.

getDSecondValue() [1/2]

double etsi_its_spatem_ts_msgs::access::getDSecondValue ( const DSecond & dsecond )

inline

Get the value of a DSecond object in seconds.

Parameters

dsecond

DSecond object to get the value from

Returns

double value of DSecond given in seconds

Definition at line 122 of file spatem_ts_getters.h.

getDSecondValue() [2/2]

double etsi_its_spatem_ts_msgs::access::getDSecondValue ( const IntersectionState & intsct )

inline

Get the value of an DSecond object from a given IntersectionState object.

Parameters

intsct

Returns

double

Definition at line 132 of file spatem_ts_getters.h.

getIntersectionID() [1/3]

uint16_t etsi_its_spatem_ts_msgs::access::getIntersectionID ( const IntersectionID & intsct_id )

inline

Get the intersection-id.

Parameters

intsct_id

intersection-id object to get the value from

Returns

uint16_t id of the intersection

Definition at line 70 of file spatem_ts_getters.h.

getIntersectionID() [2/3]

uint16_t etsi_its_spatem_ts_msgs::access::getIntersectionID ( const IntersectionReferenceID & intsct_ref_id )

inline

Get the intersection-id of an IntersectionReferenceID object.

Parameters

intsct_ref_id

IntersectionReferenceID object

Returns

uint16_t id of the intersection

Definition at line 80 of file spatem_ts_getters.h.

getIntersectionID() [3/3]

uint16_t etsi_its_spatem_ts_msgs::access::getIntersectionID ( const IntersectionState & intsct )

inline

Get the intersection-id of an IntersectionState object.

Parameters

intsct

IntersectionState object

Returns

uint16_t id of the intersection

Definition at line 90 of file spatem_ts_getters.h.

getMinuteOfTheYear()

MinuteOfTheYear etsi_its_spatem_ts_msgs::access::getMinuteOfTheYear ( const IntersectionState & intsct )

inline

Get the MinuteOfTheYear object from a given IntersectionState object.

Parameters

intsct

IntersectionState object to get the MinuteOfTheYear from

Returns

MinuteOfTheYear object

Definition at line 100 of file spatem_ts_getters.h.

getSignalGroupID() [1/2]

uint8_t etsi_its_spatem_ts_msgs::access::getSignalGroupID ( const MovementState & mvmt_state )

inline

Get the Signal Group-ID of an MovementState object.

Parameters

mvmt_state

MovementState object to get the id from

Returns

uint8_t the id of the signal group

Definition at line 152 of file spatem_ts_getters.h.

getSignalGroupID() [2/2]

uint8_t etsi_its_spatem_ts_msgs::access::getSignalGroupID ( const SignalGroupID & signal_group_id )

inline

Get the Signal Group-ID of an SignalGroupID object.

Parameters

signal_group_id

SignalGroupID object to get the id from

Returns

uint8_t the id of the signal group

Definition at line 142 of file spatem_ts_getters.h.

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.