HLCC Documentation: hlcc::telif::ActionsCommands Class Reference

HLCC Documentation 2.2.0

Loading...

Searching...

No Matches

#include <actionsCommands.hpp>

Inheritance diagram for hlcc::telif::ActionsCommands:

Public Member Functions
	ActionsCommands (rad::Application &appl, ActionMgr &action_mgr, DataContext &data)

void	Initialize () override

void	Configure (const std::vector< std::string > &keys) override

void	Preset (scxml4cpp::Context *c)

void	SetObservingWavelength (scxml4cpp::Context *c)

void	SetVelocityOffset (scxml4cpp::Context *c)

void	SkyOffset (scxml4cpp::Context *c)

void	SetReferenceFocus (scxml4cpp::Context *c)

void	SetReferenceAberration (scxml4cpp::Context *c)

void	RequestControl (scxml4cpp::Context *c)

void	ReleaseControl (scxml4cpp::Context *c)

void	RousConfig (scxml4cpp::Context *c)

void	RousExecute (scxml4cpp::Context *c)

void	RousActivityEntry (scxml4cpp::Context *c)

void	RousActivityExit (scxml4cpp::Context *c)

void	ReadyForHandoverEstimation (scxml4cpp::Context *c)

	ActionsCommands (const ActionsCommands &)=delete

ActionsCommands &	operator= (const ActionsCommands &)=delete
	Disable copy constructor.

Detailed Description

This class contains the implementation of the actions dealing with the following "standard" commands:

GCH TODO: add all commands in the ICD. Now only an example

GetConfig

Constructor & Destructor Documentation

◆ ActionsCommands() [1/2]

hlcc::telif::ActionsCommands::ActionsCommands	(	rad::Application &	appl,
		ActionMgr &	action_mgr,
		DataContext &	data )

Constructor.

Parameters

[in]	appl	Reference to the rad-app application.
[in]	action_mgr	action manager
[in]	data	Data shared within the application among actions and activities.

◆ ActionsCommands() [2/2]

hlcc::telif::ActionsCommands::ActionsCommands ( const ActionsCommands & )

delete

Member Function Documentation

◆ Configure()

void hlcc::telif::ActionsCommands::Configure ( const std::vector< std::string > & keys )

override

This method allows to re-configure the member attributes of this class. It is usually invoked as consequence of an LoadConfig or SetConfig commands.

Parameters

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

◆ Initialize()

void hlcc::telif::ActionsCommands::Initialize ( )

override

This method allows to re-initialize the member attributes of this class. It is usually invoked as consequence of an Init command.

◆ operator=()

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

delete

Disable copy constructor.

◆ Preset()

void hlcc::telif::ActionsCommands::Preset ( scxml4cpp::Context * c )

Implementation of the Preset action. This action:

replies back for the originator of the Preset request with the current configuration

Parameters

[in] c Context containing the last event received by the State Machine.

◆ ReadyForHandoverEstimation()

void hlcc::telif::ActionsCommands::ReadyForHandoverEstimation ( scxml4cpp::Context * c )

Run the Ready for handover estimation

Parameters

[in] c Context containing the last event received by the State Machine.

◆ ReleaseControl()

void hlcc::telif::ActionsCommands::ReleaseControl ( scxml4cpp::Context * c )

Implementation of Instruments ReleaseControl action.

replies back with the succes of operation

Parameters

[in] c Context containing the last event received by the State Machine.

◆ RequestControl()

void hlcc::telif::ActionsCommands::RequestControl ( scxml4cpp::Context * c )

Implementation of Instruments RequestControl action.

replies back with the succes of operation which is based in the information if the telescope is ready for handover.

Parameters

[in] c Context containing the last event received by the State Machine.

◆ RousActivityEntry()

void hlcc::telif::ActionsCommands::RousActivityEntry ( scxml4cpp::Context * c )

Clear and prepare variables, states before ROUS activity starts. Internal event only

Parameters

[in] c Context containing the last event received by the State Machine.

◆ RousActivityExit()

void hlcc::telif::ActionsCommands::RousActivityExit ( scxml4cpp::Context * c )

Clear variables and publish in Oldb final values after ROUS activity stops. Internal event only

Parameters

[in] c Context containing the last event received by the State Machine.

◆ RousConfig()

void hlcc::telif::ActionsCommands::RousConfig ( scxml4cpp::Context * c )

Implementation of RousConfig action.

Disables/Enables the the automatic execution of ROUS maneuvers by CCS
replies back with the succes of operation

Parameters

[in] c Context containing the last event received by the State Machine.

◆ RousExecute()

void hlcc::telif::ActionsCommands::RousExecute ( scxml4cpp::Context * c )

Implementation of RousExecute action.

Executes a ROUS maneuver immediately
replies back with the succes of operation

Parameters

[in] c Context containing the last event received by the State Machine.

◆ SetObservingWavelength()

void hlcc::telif::ActionsCommands::SetObservingWavelength ( scxml4cpp::Context * c )

Implementation of the SetObservingWavelength action. This action:

Sets the current wavelength at which the instrument defines the pointing origin, in [m]. The value is both forwarded to eltpk and written to the OLDB.
replies back for the originator of the request with the success of the combined operation.

Parameters

[in] c Context containing the last event received by the State Machine.

◆ SetReferenceAberration()

void hlcc::telif::ActionsCommands::SetReferenceAberration ( scxml4cpp::Context * c )

Implementation of the SetReferenceAberration action. This action:

...
replies back for the originator of the request with the success of the operation.

Parameters

[in] c Context containing the last event received by the State Machine.

◆ SetReferenceFocus()

void hlcc::telif::ActionsCommands::SetReferenceFocus ( scxml4cpp::Context * c )

Implementation of the SetReferenceFocus action. This action:

...
replies back for the originator of the request with the success of the operation.

Parameters

[in] c Context containing the last event received by the State Machine.

◆ SetVelocityOffset()

void hlcc::telif::ActionsCommands::SetVelocityOffset ( scxml4cpp::Context * c )

Implementation of the SetVelocityOffset action. This action:

Set the the velocity offset if the flag ready_fo_handover is true.
replies back for the originator of the request with the success of the operation.

Parameters

[in] c Context containing the last event received by the State Machine.

◆ SkyOffset()

void hlcc::telif::ActionsCommands::SkyOffset ( scxml4cpp::Context * c )

Implementation of the SkyOffset action. This action:

Set the the OffsetSkyArgs if the flag ready_fo_handover is true and forwards it to the eltpk.
replies back for the originator of the request with the success of the operation.

Parameters

[in] c Context containing the last event received by the State Machine.

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/actionsCommands.hpp
/home/abuild/rpmbuild/BUILD/hlcc-v2.2.0/software/apps/telif/app/src/actionsCommands.cpp