hlcc::telif::RousData Class Reference

#include <rousData.hpp>

Public Types
enum	RousManeuverState { ROUS_INIT , ROUS_WAITING , ROUS_MANEUVER_IN_PROGRESS , ROUS_DISABLED }

Public Member Functions
	RousData (OldbInterface &oldb_interface, std::shared_ptr< elt::mal::Mal > entity_factory)
virtual	~RousData ()
	RousData ()=delete
	RousData (const RousData &)=delete
RousData &	operator= (const RousData &)=delete
void	SetRousState (const RousManeuverState &state)
RousManeuverState	GetRousState ()
void	SetRousTimerSeconds (const std::uint16_t &time_s)
std::uint16_t	GetRousTimerSeconds ()
bool	DecrementRousTimerSeconds ()
void	SetRousDisableState (const bool &disabled)
bool	GetRousDisableState ()
void	SetRousExecuteMessage ()
bool	GetRousExecuteMessage ()
bool	SetRousTimerUpdateMessage (const uint16_t &time_s)
bool	GetRousTimerUpdateMessage (uint16_t &time_s)
void	PublishRous ()
void	SetPublishRousStatus (bool enable)
void	ActivityEntryAction ()
void	ActivityExitAction ()

Member Enumeration Documentation

RousManeuverState

enum hlcc::telif::RousData::RousManeuverState

The possible Rous activity State machine

Enumerator
ROUS_INIT
ROUS_WAITING
ROUS_MANEUVER_IN_PROGRESS
ROUS_DISABLED

Constructor & Destructor Documentation

RousData() [1/3]

hlcc::telif::RousData::RousData ( OldbInterface & oldb_interface, std::shared_ptr< elt::mal::Mal > entity_factory )

explicit

Default Destructor

~RousData()

hlcc::telif::RousData::~RousData ( )

virtual

Destructor

RousData() [2/3]

hlcc::telif::RousData::RousData ( )

delete

RousData() [3/3]

hlcc::telif::RousData::RousData ( const RousData & )

delete

Member Function Documentation

ActivityEntryAction()

void hlcc::telif::RousData::ActivityEntryAction

(

)

Reset variables before Rous Activity starts

ActivityExitAction()

void hlcc::telif::RousData::ActivityExitAction

(

)

Reset variables after Rous Activity ends and publishes them.

DecrementRousTimerSeconds()

bool hlcc::telif::RousData::DecrementRousTimerSeconds

(

)

Decrements the Rous timer by 1 second

Returns

true if the timer is finished (reached 0)

GetRousDisableState()

bool hlcc::telif::RousData::GetRousDisableState

(

)

Gets the current ROUS disable state

Returns

true if ROUS disabled, false otherwise

GetRousExecuteMessage()

bool hlcc::telif::RousData::GetRousExecuteMessage

(

)

Get the execute message for ROUS activity

Returns

true if a ROUS execute message was received

GetRousState()

RousData::RousManeuverState hlcc::telif::RousData::GetRousState

(

)

Gets the Rous sm current state

Returns

Current Rous sm state

GetRousTimerSeconds()

std::uint16_t hlcc::telif::RousData::GetRousTimerSeconds

(

)

Gets the current time in the Rous timer

Returns

Rous current timer time in seconds

GetRousTimerUpdateMessage()

bool hlcc::telif::RousData::GetRousTimerUpdateMessage

(

uint16_t &

time_s

)

Get the timer update message

Parameters

[out]

time_s

New ROUS time update in seconds, only valid if function returned true

Returns

true if timer update message was received.

operator=()

RousData & hlcc::telif::RousData::operator= ( const RousData & )

delete

PublishRous()

void hlcc::telif::RousData::PublishRous

(

)

Publishes Rous Data on Oldb and control network

SetPublishRousStatus()

void hlcc::telif::RousData::SetPublishRousStatus

(

bool

enable

)

Enable / Disable the Rous publishing.

Parameters

[in]

enable

new publishing status

SetRousDisableState()

void hlcc::telif::RousData::SetRousDisableState

(

const bool &

disabled

)

Stores the Rous Disable state

Parameters

[in]

disabled

The ROUS new disabled state

SetRousExecuteMessage()

void hlcc::telif::RousData::SetRousExecuteMessage

(

)

Set the execute message for ROUS activity The message queue has only one slot, so if the previous message was not retrieved yet the latest will override.

SetRousState()

void hlcc::telif::RousData::SetRousState

(

const RousManeuverState &

state

)

Set the State for Rous sm

Parameters

[in]

state

the state to be applied

SetRousTimerSeconds()

void hlcc::telif::RousData::SetRousTimerSeconds

(

const std::uint16_t &

time_s

)

Set a new time in the Rous timer

Parameters

[in]

time_s

new time to be applied in seconds

SetRousTimerUpdateMessage()

bool hlcc::telif::RousData::SetRousTimerUpdateMessage

(

const uint16_t &

time_s

)

Set the timer update message The message queue has only one slot, so if the previous message was not retrieved yet the latest will override.

Parameters

[in]

time_s

New ROUS time update in seconds

---

The documentation for this class was generated from the following files:

• /home/abuild/rpmbuild/BUILD/hlcc-v2.2.0/software/apps/telif/app/src/include/telif/rousData.hpp
• /home/abuild/rpmbuild/BUILD/hlcc-v2.2.0/software/apps/telif/app/src/rousData.cpp