Class: PFM::Message::Instructions::Marker

Inherits:

Object

• Object
• PFM::Message::Instructions::Marker

Defined in:

docs/4_Systems_004_Message.rb

Overview

Class that describes a Marker

Instance Attribute Summary

• #data ⇒ String readonly

  Get the marker data.

• #id ⇒ Integer readonly

  Get the marker ID.

• #width ⇒ Integer readonly

  Get the width of the marker.

Instance Method Summary

• #initialize(id, data, width = 0) ⇒ Marker constructor

  Create a new Marker.

Constructor Details

#initialize(id, data, width = 0) ⇒ Marker

Create a new Marker

Parameters:

• id (Integer) —

  ID of the marker

• data (String) —

  data of the marker

• width (Integer) (defaults to: 0) —

  width of the marker

# File 'docs/4_Systems_004_Message.rb', line 299

def initialize(id, data, width = 0)
end

Instance Attribute Details

#data ⇒ String (readonly)

Get the marker data

Returns:

• (String)

# File 'docs/4_Systems_004_Message.rb', line 291

def data
  @data
end

#id ⇒ Integer (readonly)

Get the marker ID

Returns:

• (Integer)

# File 'docs/4_Systems_004_Message.rb', line 288

def id
  @id
end

#width ⇒ Integer (readonly)

Get the width of the marker

Returns:

• (Integer)

# File 'docs/4_Systems_004_Message.rb', line 294

def width
  @width
end