Package intera_io :: Module io_interface :: Class IOInterface
[hide private]
[frames] | no frames]

Class IOInterface

source code

object --+
         |
        IOInterface
Known Subclasses:

Base class for IO interfaces.

Instance Methods [hide private]
 
__init__(self, path_root, config_msg_type, status_msg_type)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
invalidate_config(self)
mark the config topic data as invalid
source code
 
invalidate_state(self)
mark the state topic data as invalid
source code
 
is_config_valid(self)
return true if the config topic data is valid
source code
 
is_state_valid(self)
return true if the state topic data is valid
source code
 
is_valid(self)
return true if both the state and config topic data are valid
source code
 
revalidate(self, timeout, invalidate_state=True, invalidate_config=True)
invalidate the state and config topics, then wait up to timeout seconds for them to become valid again.
source code
 
handle_config(self, msg)
config topic callback
source code
 
load_state(self, current_state, incoming_state) source code
 
handle_state(self, msg)
state topic callback
source code
 
publish_command(self, op, args, timeout=2.0)
publish on the command topic return true if the command is acknowleged within the timeout
source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, path_root, config_msg_type, status_msg_type)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__
(inherited documentation)

revalidate(self, timeout, invalidate_state=True, invalidate_config=True)

source code 

invalidate the state and config topics, then wait up to timeout seconds for them to become valid again. return true if both the state and config topic data are valid