hlcc::eltpk::ActionsGuards Class Reference

#include <actionsGuards.hpp>

Inheritance diagram for hlcc::eltpk::ActionsGuards:

Public Member Functions
	ActionsGuards (rad::Application &sm, DataContext &data)
void	Initialize () override
void	Configure (const std::vector< std::string > &keys) override
bool	EstimatedStateIsTracking (scxml4cpp::Context *c)
bool	EstimatedStateIsPresettingRaDec (scxml4cpp::Context *c)
bool	EstimatedStateIsStandStill (scxml4cpp::Context *c)
bool	EstimatedStateIsTrackingUnexpected (scxml4cpp::Context *c)
bool	EstimatedStateIsStandStillUnexpected (scxml4cpp::Context *c)
bool	EstimatedStateIsMoving (scxml4cpp::Context *c)
bool	IsPresetAllowed (scxml4cpp::Context *c)
	ActionsGuards (const ActionsGuards &)=delete
ActionsGuards &	operator= (const ActionsGuards &)=delete
	Disable copy constructor.

Detailed Description

This class contains the implementation of SM guards.

Technically, guards are also actions themselves, which is why we keep "Actions" in the class name, to show their relation with ActionsStd and ActionsCommands.

Constructor & Destructor Documentation

ActionsGuards() [1/2]

hlcc::eltpk::ActionsGuards::ActionsGuards	(	rad::Application &	sm,
		DataContext &	data )

Constructor.

Parameters

[in]	sm	Reference to the SM Adapter used to inject internal events.
[in]	data	Data shared within the application among actions and activities.

ActionsGuards() [2/2]

hlcc::eltpk::ActionsGuards::ActionsGuards ( const ActionsGuards & )

delete

Member Function Documentation

Configure()

void hlcc::eltpk::ActionsGuards::Configure ( const std::vector< std::string > & keys )

override

Method invoked when SetConfig or LoadConfig command is received to re-configure the actions class attributes.

Parameters

keys	Modified parameters. Empty vector means all params have changed.

EstimatedStateIsMoving()

bool hlcc::eltpk::ActionsGuards::EstimatedStateIsMoving

(

scxml4cpp::Context *

c

)

EstimatedStateIsPresettingRaDec()

bool hlcc::eltpk::ActionsGuards::EstimatedStateIsPresettingRaDec

(

scxml4cpp::Context *

c

)

EstimatedStateIsStandStill()

bool hlcc::eltpk::ActionsGuards::EstimatedStateIsStandStill

(

scxml4cpp::Context *

c

)

EstimatedStateIsStandStillUnexpected()

bool hlcc::eltpk::ActionsGuards::EstimatedStateIsStandStillUnexpected

(

scxml4cpp::Context *

c

)

EstimatedStateIsTracking()

bool hlcc::eltpk::ActionsGuards::EstimatedStateIsTracking

(

scxml4cpp::Context *

c

)

Implementation of the EstimatedStateIsTracking guard.

Parameters

[in]

c

Context containing the last event received by the State Machine.

EstimatedStateIsTrackingUnexpected()

bool hlcc::eltpk::ActionsGuards::EstimatedStateIsTrackingUnexpected

(

scxml4cpp::Context *

c

)

Initialize()

void hlcc::eltpk::ActionsGuards::Initialize ( )

override

Method invoked when Init command is received to re-initialize the actions class attributes.

IsPresetAllowed()

bool hlcc::eltpk::ActionsGuards::IsPresetAllowed

(

scxml4cpp::Context *

c

)

Checks boundary conditions whether a Preset command is allowed. Currently this checks only that PTP sync is working (or is disabled). See ETCS-1246.

Parameters

[in]

c

Context containing the last event received by the State Machine.

operator=()

ActionsGuards & hlcc::eltpk::ActionsGuards::operator= ( const ActionsGuards & )

delete

Disable copy constructor.

---

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

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