Class: Roby::Interface::CommandArgument

Inherits:
Object
  • Object
show all
Defined in:
lib/roby/interface/command_argument.rb

Overview

An argument of a Command

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, description) ⇒ CommandArgument

Returns a new instance of CommandArgument.



12
13
14
 
# File 'lib/roby/interface/command_argument.rb', line 12

def initialize(name, description)
    @name, @description = name.to_sym, Array(description)
end

Instance Attribute Details

#description ⇒ Array<String> (readonly)

Returns the argument description.

Returns:

  • (Array<String>) —

    the argument description



10
11
12
 
# File 'lib/roby/interface/command_argument.rb', line 10

def description
  @description
end

#name ⇒ Symbol (readonly)

Returns the argument name.

Returns:

  • (Symbol) —

    the argument name



8
9
10
 
# File 'lib/roby/interface/command_argument.rb', line 8

def name
  @name
end