irsol::server::handlers::CommandGISHandler Class Reference

Handler for the gis command (sequence frame acquisition). More...

#include <command_gis.hpp>

Inheritance diagram for irsol::server::handlers::CommandGISHandler:

Public Member Functions
	CommandGISHandler (std::shared_ptr< Context > ctx)
	Constructs the CommandGISHandler.
Public Member Functions inherited from irsol::server::handlers::internal::CommandGIBaseHandler
	CommandGIBaseHandler (std::shared_ptr< Context > ctx)
	Constructs the CommandGIBaseHandler.
Public Member Functions inherited from irsol::server::handlers::internal::HandlerBase< T, >
virtual std::vector< out_message_t >	operator() (const irsol::types::client_id_t &clientId, T &&message)
	Invokes the handler for a given client and message.

Private Member Functions
std::vector< irsol::protocol::OutMessage >	validate (const protocol::Command &message, std::shared_ptr< irsol::server::ClientSession > session) const override
	Validates the gis command parameters.
uint64_t	getInputSequenceLength (const protocol::Command &message, std::shared_ptr< irsol::server::ClientSession > session) const override
	Returns the input sequence length for the gis command.
double	getFrameRate (const protocol::Command &message, std::shared_ptr< irsol::server::ClientSession > session) const override
	Returns the frame rate for the gis command.

Additional Inherited Members
Protected Member Functions inherited from irsol::server::handlers::internal::CommandGIBaseHandler
std::vector< out_message_t >	process (std::shared_ptr< irsol::server::ClientSession > session, protocol::Command &&message) final override
	Processes a frame acquisition command, starting the frame collection thread.
Protected Member Functions inherited from irsol::server::handlers::internal::HandlerBase< T, >
	HandlerBase (std::shared_ptr< Context > ctx)
	Constructs the handler base.
virtual std::vector< out_message_t >	process (std::shared_ptr< irsol::server::ClientSession > session, T &&message)=0
	Processes the protocol message for the given session.
Protected Attributes inherited from irsol::server::handlers::internal::HandlerBase< T, >
std::shared_ptr< Context >	ctx
	Handler context (provides access to app and utilities).

Detailed Description

Handler for the gis command (sequence frame acquisition).

Processes the gis command to acquire a sequence of frames from the camera.

Definition at line 24 of file command_gis.hpp.

Constructor & Destructor Documentation

CommandGISHandler()

irsol::server::handlers::CommandGISHandler::CommandGISHandler

(

std::shared_ptr< Context >

ctx

)

Constructs the CommandGISHandler.

Parameters

ctx	Handler context.

Definition at line 9 of file command_gis.cpp.

  : internal::CommandGIBaseHandler(ctx)
{}

Member Function Documentation

getFrameRate()

double irsol::server::handlers::CommandGISHandler::getFrameRate ( const protocol::Command &  message, std::shared_ptr< irsol::server::ClientSession >  session  ) const

overrideprivatevirtual

Returns the frame rate for the gis command.

Parameters

message	The command message.
session	The client session.

Returns

Frame rate for acquisition.

Note

This method picks the frame rate from the irsol::server::ClientSession state.

Implements irsol::server::handlers::internal::CommandGIBaseHandler.

Definition at line 46 of file command_gis.cpp.

{
  const auto& state = session->userData().frameListeningState;
  return state.gisParams.frameRate;
}

getInputSequenceLength()

uint64_t irsol::server::handlers::CommandGISHandler::getInputSequenceLength ( const protocol::Command &  message, std::shared_ptr< irsol::server::ClientSession >  session  ) const

overrideprivatevirtual

Returns the input sequence length for the gis command.

Parameters

message	The command message.
session	The client session.

Returns

Number of frames to acquire.

Note

This method picks the input sequence length from the irsol::server::ClientSession state.

Implements irsol::server::handlers::internal::CommandGIBaseHandler.

Definition at line 38 of file command_gis.cpp.

{
  const auto& state = session->userData().frameListeningState;
  return state.gisParams.inputSequenceLength;
}

validate()

std::vector< irsol::protocol::OutMessage > irsol::server::handlers::CommandGISHandler::validate ( const protocol::Command &  message, std::shared_ptr< irsol::server::ClientSession >  session  ) const

overrideprivatevirtual

Validates the gis command parameters.

Parameters

message	The command message.
session	The client session.

Returns

Vector of outbound error messages (empty if valid).

Implements irsol::server::handlers::internal::CommandGIBaseHandler.

Definition at line 14 of file command_gis.cpp.

{
  auto&                      state = session->userData().frameListeningState;
  std::vector<out_message_t> result;
  // For 'gi' command, no further validation to do.
  if(state.gisParams.inputSequenceLength == 0) {
    IRSOL_NAMED_LOG_WARN(session->id(), "Gis inputSequenceLength param is 0, this is not allowed.");
    result.emplace_back(irsol::protocol::Error::from(
      message, "Gis inputSequenceLength param is 0, this is not allowed"));
    return result;
  }
  if(state.gisParams.frameRate <= 0) {
    IRSOL_NAMED_LOG_WARN(
      session->id(), "Gis frameRate param is non-positive, this is not allowed.");
    result.emplace_back(irsol::protocol::Error::from(
      message, "Gis frameRate param is non-positive, this is not allowed."));
    return result;
  }
  return result;
}

---

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

• src/irsol/include/irsol/server/handlers/command_gis.hpp
• src/irsol/lib/irsol/server/handlers/command_gis.cpp