Class: Roby::Actions::Models::Action::Argument

Inherits:
Struct
  • Object
show all
Includes:
DRoby::V5::Actions::Models::Action::ArgumentDumper
Defined in:
lib/roby/actions/models/action.rb,
lib/roby/droby/enable.rb

Overview

Structure that stores the information about planning method arguments

See MethodDescription

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from DRoby::V5::Actions::Models::Action::ArgumentDumper

#droby_dump, #droby_dump!, #proxy, #proxy!

Instance Attribute Details

#default ⇒ Object

Returns the value of attribute default



14
15
16
 
# File 'lib/roby/actions/models/action.rb', line 14

def default
  @default
end

#doc ⇒ Object

Returns the value of attribute doc



14
15
16
 
# File 'lib/roby/actions/models/action.rb', line 14

def doc
  @doc
end

#example ⇒ Object

Returns the value of attribute example



14
15
16
 
# File 'lib/roby/actions/models/action.rb', line 14

def example
  @example
end

#name ⇒ Object

Returns the value of attribute name



14
15
16
 
# File 'lib/roby/actions/models/action.rb', line 14

def name
  @name
end

#required ⇒ Object

Returns the value of attribute required



14
15
16
 
# File 'lib/roby/actions/models/action.rb', line 14

def required
  @required
end

Instance Method Details

#example_defined? ⇒ Boolean 



22
23
24
 
# File 'lib/roby/actions/models/action.rb', line 22

def example_defined?
    example != Void
end

#pretty_print(pp) ⇒ Object 



15
16
17
18
19
20
 
# File 'lib/roby/actions/models/action.rb', line 15

def pretty_print(pp)
    pp.text "#{name}: #{doc}"
    pp.text required ? " (required)" : " (optional)"
    pp.text " default=#{default}" if default
    pp.text " example=#{example}" if example_defined?
end

#required? ⇒ Boolean 



26
27
28
 
# File 'lib/roby/actions/models/action.rb', line 26

def required?
    required
end