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

Instance Method Details

#attribute(name) ⇒ Object

Returns an Attribute object representing the given attribute

Raises:


130
131
132
# File 'lib/orocos/task_context_base.rb', line 130

def attribute(name)
    raise Orocos::NotFound, "#attribute is not implemented in #{self.class}"
end

#attribute_namesObject

Returns the array of the names of available attributes on this task context

Raises:

  • (NotImplementedError)

153
154
155
# File 'lib/orocos/task_context_base.rb', line 153

def attribute_names
    raise NotImplementedError
end

#operation(name) ⇒ Object

Returns an Operation object that represents the given method on the remote component.

Raises:


141
142
143
# File 'lib/orocos/task_context_base.rb', line 141

def operation(name)
    raise Orocos::NotFound, "#operation is not implemented in #{self.class}"
end

#operation_namesObject

Returns the array of the names of available operations on this task context

Raises:

  • (NotImplementedError)

159
160
161
# File 'lib/orocos/task_context_base.rb', line 159

def operation_names
    raise NotImplementedError
end

#pingObject

raises an runtime error if the task is not reachable

Raises:

  • (NotImplementedError)

175
176
177
# File 'lib/orocos/task_context_base.rb', line 175

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

Raises:


125
126
127
# File 'lib/orocos/task_context_base.rb', line 125

def port(name)
    raise Orocos::NotFound, "#port is not implemented in #{self.class}"
end

#port_namesObject

Returns the names of all the ports defined on this task context

Raises:

  • (NotImplementedError)

164
165
166
# File 'lib/orocos/task_context_base.rb', line 164

def port_names
    raise NotImplementedError
end

#property(name) ⇒ Object

Returns a Property object representing the given property

Raises:


135
136
137
# File 'lib/orocos/task_context_base.rb', line 135

def property(name)
    raise Orocos::NotFound, "#property is not implemented in #{self.class}"
end

#property_namesObject

Returns the array of the names of available properties on this task context

Raises:

  • (NotImplementedError)

147
148
149
# File 'lib/orocos/task_context_base.rb', line 147

def property_names
    raise NotImplementedError
end

#rtt_stateObject

Reads the state

Raises:

  • (NotImplementedError)

169
170
171
# File 'lib/orocos/task_context_base.rb', line 169

def rtt_state
    raise NotImplementedError
end