Class: Cosmos::LimitsResponse

Inherits:
Object
  • Object
show all
Includes:
Api
Defined in:
lib/cosmos/packets/limits_response.rb

Overview

This class defines a #call method which is called when a PacketItem goes out of limits. This class must be subclassed and the call method implemented. Do NOT use this class directly.

Constant Summary

Constants included from Extract

Extract::SCANNING_REGULAR_EXPRESSION

Instance Method Summary collapse

Methods included from Api

#cmd, #cmd_no_checks, #cmd_no_hazardous_check, #cmd_no_range_check, #cmd_raw, #cmd_raw_no_checks, #cmd_raw_no_hazardous_check, #cmd_raw_no_range_check, #connect_interface, #connect_router, #disable_limits, #disable_limits_group, #disconnect_interface, #disconnect_router, #enable_limits, #enable_limits_group, #get_cmd_hazardous, #get_cmd_list, #get_cmd_log_filename, #get_cmd_param_list, #get_cmd_time, #get_cmd_value, #get_interface_names, #get_limits, #get_limits_event, #get_limits_groups, #get_limits_set, #get_limits_sets, #get_out_of_limits, #get_overall_limits_state, #get_packet_data, #get_router_names, #get_server_message_log_filename, #get_stale, #get_target_list, #get_tlm_details, #get_tlm_item_list, #get_tlm_list, #get_tlm_log_filename, #get_tlm_packet, #get_tlm_values, #initialize, #interface_state, #limits_enabled?, #map_target_to_interface, #router_state, #send_raw, #set_limits, #set_limits_set, #set_tlm, #set_tlm_raw, #start_cmd_log, #start_logging, #start_new_server_message_log, #start_raw_logging_interface, #start_raw_logging_router, #start_tlm_log, #stop_cmd_log, #stop_logging, #stop_raw_logging_interface, #stop_raw_logging_router, #stop_tlm_log, #subscribe_limits_events, #subscribe_packet_data, #tlm, #tlm_formatted, #tlm_raw, #tlm_variable, #tlm_with_units, #unsubscribe_limits_events, #unsubscribe_packet_data

Instance Method Details

#call(packet, item, old_limits_state) ⇒ Object

Parameters:

  • packet (Packet) —

    Packet the limits response is assigned to

  • item (PacketItem) —

    PacketItem the limits response is assigned to

  • old_limits_state (Symbol) —

    Previous value of the limit. One of nil, :GREEN_HIGH, :GREEN_LOW, :YELLOW, :YELLOW_HIGH, :YELLOW_LOW, :RED, :RED_HIGH, :RED_LOW. nil if the previous limit state has not yet been established.



29
30
31
 
# File 'lib/cosmos/packets/limits_response.rb', line 29

def call(packet, item, old_limits_state)
  raise "call method must be defined by subclass"
end

#to_s ⇒ Object 



33
34
35
 
# File 'lib/cosmos/packets/limits_response.rb', line 33

def to_s
  self.class.to_s.split('::')[-1]
end