Module: Orocos::TaskContextBaseAbstract
- Included in:
- TaskContextBase
- Defined in:
- lib/orocos/task_context_base.rb
Overview
This methods must be implemented by the child class of TaskContextBase
Instance Method Summary collapse
-
#attribute(name) ⇒ Object
Returns an Attribute object representing the given attribute.
-
#attribute_names ⇒ Object
Returns the array of the names of available attributes on this task context.
-
#operation(name) ⇒ Object
Returns an Operation object that represents the given method on the remote component.
-
#operation_names ⇒ Object
Returns the array of the names of available operations on this task context.
-
#ping ⇒ Object
raises an runtime error if the task is not reachable.
-
#port(name) ⇒ Object
Returns an object that represents the given port on the task context.
-
#port_names ⇒ Object
Returns the names of all the ports defined on this task context.
-
#property(name) ⇒ Object
Returns a Property object representing the given property.
-
#property_names ⇒ Object
Returns the array of the names of available properties on this task context.
-
#rtt_state ⇒ Object
Reads the state.
Instance Method Details
#attribute(name) ⇒ Object
Returns an Attribute object representing the given attribute
131 132 133 |
# File 'lib/orocos/task_context_base.rb', line 131 def attribute(name) raise Orocos::NotFound, "#attribute is not implemented in #{self.class}" end |
#attribute_names ⇒ Object
Returns the array of the names of available attributes on this task context
154 155 156 |
# File 'lib/orocos/task_context_base.rb', line 154 def attribute_names raise NotImplementedError end |
#operation(name) ⇒ Object
Returns an Operation object that represents the given method on the remote component.
142 143 144 |
# File 'lib/orocos/task_context_base.rb', line 142 def operation(name) raise Orocos::NotFound, "#operation is not implemented in #{self.class}" end |
#operation_names ⇒ Object
Returns the array of the names of available operations on this task context
160 161 162 |
# File 'lib/orocos/task_context_base.rb', line 160 def operation_names raise NotImplementedError end |
#ping ⇒ Object
raises an runtime error if the task is not reachable
176 177 178 |
# File 'lib/orocos/task_context_base.rb', line 176 def ping raise NotImplementedError end |
#port(name) ⇒ Object
Returns an object that represents the given port on the task context. The returned object is either an InputPort or an OutputPort
126 127 128 |
# File 'lib/orocos/task_context_base.rb', line 126 def port(name) raise Orocos::NotFound, "#port is not implemented in #{self.class}" end |
#port_names ⇒ Object
Returns the names of all the ports defined on this task context
165 166 167 |
# File 'lib/orocos/task_context_base.rb', line 165 def port_names raise NotImplementedError end |
#property(name) ⇒ Object
Returns a Property object representing the given property
136 137 138 |
# File 'lib/orocos/task_context_base.rb', line 136 def property(name) raise Orocos::NotFound, "#property is not implemented in #{self.class}" end |
#property_names ⇒ Object
Returns the array of the names of available properties on this task context
148 149 150 |
# File 'lib/orocos/task_context_base.rb', line 148 def property_names raise NotImplementedError end |
#rtt_state ⇒ Object
Reads the state
170 171 172 |
# File 'lib/orocos/task_context_base.rb', line 170 def rtt_state raise NotImplementedError end |