rocon_gateway.utils.Connection Class Reference

Rule. More...

Public Member Functions
def	__eq__ (self, other)
def	__hash__ (self)
def	__init__ (self, rule, type_msg, type_info, xmlrpc_uri)
def	__ne__ (self, other)
def	__repr__ (self)
def	__str__ (self)
def	hasSameRule (self, connection)
def	inConnectionList (self, connection_list)

Public Attributes
	rule
	type_info
	type_msg
	xmlrpc_uri

Private Attributes
	__dict__

Detailed Description

Rule.

  An object that represents a connection containing all the gory details
  about a connection, allowing a connection to be passed through to a
  foreign gateway

   - rule (gateway_msgs.msg.Rule) (containing type,name,node)
   - type_info              (msg type for pubsub or service api for services)
   - xmlrpc_uri             (the xmlrpc node uri for the connection)

Definition at line 39 of file utils.py.

Constructor & Destructor Documentation

def rocon_gateway.utils.Connection.__init__	(		self,
			rule,
			type_msg,
			type_info,
			xmlrpc_uri
	)

@param type_msg : message type of the topic or service
@param type_info : either topic_type (pubsub), service api (service) or ??? (action)
@type string

Definition at line 51 of file utils.py.

Member Function Documentation

def rocon_gateway.utils.Connection.__eq__	(		self,
			other
	)

Definition at line 62 of file utils.py.

def rocon_gateway.utils.Connection.__hash__

(

self

)

Definition at line 71 of file utils.py.

def rocon_gateway.utils.Connection.__ne__	(		self,
			other
	)

Definition at line 68 of file utils.py.

def rocon_gateway.utils.Connection.__repr__

(

self

)

Definition at line 82 of file utils.py.

def rocon_gateway.utils.Connection.__str__

(

self

)

Definition at line 74 of file utils.py.

def rocon_gateway.utils.Connection.hasSameRule	(		self,
			connection
	)

  Checks for equivalency regardless of type_info and xmlrpc_uri.

  @param connection : connection to compare with
  @type utils.Connection
  @return true if equivalent, false otherwise
  @rtype Bool

Definition at line 100 of file utils.py.

def rocon_gateway.utils.Connection.inConnectionList	(		self,
			connection_list
	)

  Checks to see if this connection has the same rule
  as an item in the given connection_list

  @param connection_list : connection list to trawl.
  @type utils.Connection[]
  @return true if this connection rule matches a connection rule in the list
  @rtype Bool

Definition at line 85 of file utils.py.

Member Data Documentation

rocon_gateway.utils.Connection.__dict__

private

Definition at line 64 of file utils.py.

rocon_gateway.utils.Connection.rule

Definition at line 57 of file utils.py.

rocon_gateway.utils.Connection.type_info

Definition at line 59 of file utils.py.

rocon_gateway.utils.Connection.type_msg

Definition at line 58 of file utils.py.

rocon_gateway.utils.Connection.xmlrpc_uri

Definition at line 60 of file utils.py.

---

The documentation for this class was generated from the following file:

• utils.py