Class: DSP::OutputEvent

Inherits:
DSPBase show all
Defined in:
lib/dsp/dsp_protocol.rb

Overview

interface OutputEvent extends Event {

    body: {
        /** The output category. If not specified, 'console' is assumed.
            Values: 'console', 'stdout', 'stderr', 'telemetry', etc.
        */
        category?: string;
        /** The output to report. */
        output: string;
        /** Support for keeping an output log organized by grouping related messages.
            'start': Start a new group in expanded mode. Subsequent output events are members of the group and should be shown indented.
            The 'output' attribute becomes the name of the group and is not indented.
            'startCollapsed': Start a new group in collapsed mode. Subsequent output events are members of the group and should be shown indented (as soon as the group is expanded).
            The 'output' attribute becomes the name of the group and is not indented.
            'end': End the current group and decreases the indentation of subsequent output events.
            A non empty 'output' attribute is shown as the unindented end of the group.
        */
        group?: 'start' | 'startCollapsed' | 'end';
        /** If an attribute 'variablesReference' exists and its value is > 0, the output contains objects which can be retrieved by passing 'variablesReference' to the 'variables' request. The value should be less than or equal to 2147483647 (2^31 - 1). */
        variablesReference?: number;
        /** An optional source location where the output was produced. */
        source?: Source;
        /** An optional source location line where the output was produced. */
        line?: number;
        /** An optional source location column where the output was produced. */
        column?: number;
        /** Optional data to report. For the 'telemetry' category the data will be sent to telemetry, for the other categories the data is shown in JSON format. */
        data?: any;
    };
}

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from DSPBase

#initialize, #to_h, #to_json

Constructor Details

This class inherits a constructor from DSP::DSPBase

Instance Attribute Details

#body ⇒ Object

type: {



440
441
442
 
# File 'lib/dsp/dsp_protocol.rb', line 440

def body
  @body
end

#event ⇒ Object

/** The output category. If not specified, ‘console’ is assumed.

        Values: 'console', 'stdout', 'stderr', 'telemetry', etc.
    */
    category?: string;
    /** The output to report. */
    output: string;
    /** Support for keeping an output log organized by grouping related messages.
        'start': Start a new group in expanded mode. Subsequent output events are members of the group and should be shown indented.
        The 'output' attribute becomes the name of the group and is not indented.
        'startCollapsed': Start a new group in collapsed mode. Subsequent output events are members of the group and should be shown indented (as soon as the group is expanded).
        The 'output' attribute becomes the name of the group and is not indented.
        'end': End the current group and decreases the indentation of subsequent output events.
        A non empty 'output' attribute is shown as the unindented end of the group.
    */
    group?: 'start' | 'startCollapsed' | 'end';
    /** If an attribute 'variablesReference' exists and its value is > 0, the output contains objects which can be retrieved by passing 'variablesReference' to the 'variables' request. The value should be less than or equal to 2147483647 (2^31 - 1). */
    variablesReference?: number;
    /** An optional source location where the output was produced. */
    source?: Source;
    /** An optional source location line where the output was produced. */
    line?: number;
    /** An optional source location column where the output was produced. */
    column?: number;
    /** Optional data to report. For the 'telemetry' category the data will be sent to telemetry, for the other categories the data is shown in JSON format. */
    data?: any;
}



467
468
469
 
# File 'lib/dsp/dsp_protocol.rb', line 467

def event
  @event
end

#seq ⇒ Object

type: {



440
441
442
 
# File 'lib/dsp/dsp_protocol.rb', line 440

def seq
  @seq
end

#type ⇒ Object

type: {



440
441
442
 
# File 'lib/dsp/dsp_protocol.rb', line 440

def type
  @type
end

Instance Method Details

#from_h!(value) ⇒ Object 



469
470
471
472
473
474
475
476
 
# File 'lib/dsp/dsp_protocol.rb', line 469

def from_h!(value)
  value = {} if value.nil?
  self.body = value['body'] # Unknown type
  self.event = value['event']
  self.seq = value['seq']
  self.type = value['type']
  self
end