Class: SlowBlink::Message::STRING Abstract

Inherits:
Object
  • Object
show all
Defined in:
lib/slow_blink/message/string.rb

Overview

This class is abstract.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(value) ⇒ STRING

Note:

calls #set(value)

Returns a new instance of STRING.



71
72
73
 
# File 'lib/slow_blink/message/string.rb', line 71

def initialize(value)
    set(value)
end

Class Method Details

.size ⇒ Integer?

Returns maximum size of string in bytes.

Returns:

  • (Integer, nil) —

    maximum size of string in bytes



45
46
47
 
# File 'lib/slow_blink/message/string.rb', line 45

def self.size
    @type.size
end

.type ⇒ Object 



27
28
29
 
# File 'lib/slow_blink/message/string.rb', line 27

def self.type
    @type
end

Instance Method Details

#get ⇒ String

Returns:

  • (String) 


50
51
52
 
# File 'lib/slow_blink/message/string.rb', line 50

def get
    @value
end

#set(value) ⇒ Object

Set a string value

Parameters:

  • value (String)

Raises:

  • (TypeError)
  • (RangeError) —

    value is larger than size



58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/slow_blink/message/string.rb', line 58

def set(value)
    if value.kind_of? String 
        if !self.class.size or value.size <= self.class.size
            @value = value.to_s
        else
            raise RangeError.new "String instance cannot be larger than #{self.class.size} bytes"
        end
    else
        raise TypeError.new "expecting a String instance"
    end            
end

#to_tag ⇒ Object 



80
81
82
 
# File 'lib/slow_blink/message/string.rb', line 80

def to_tag
    @value
end