SMORES Robot Platform Simulation
Modlab at Penn, ASL at Cornell
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends
Connection.Connection Class Reference

The class that has all the information about a connection between two modules. More...

Public Member Functions

def __init__
 Constructor. More...
 
def __len__
 len definition More...
 
def __init__
 Constructor. More...
 
def __len__
 len definition More...
 
def GetConnectModuleAndNode
 Giving one of the connected module, return the name and node index of the other connected module. More...
 

Public Attributes

 Module1
 
 Module2
 
 Node1
 
 Node2
 
 Distance
 
 Angle
 

Detailed Description

The class that has all the information about a connection between two modules.

Constructor & Destructor Documentation

def Connection.Connection.__init__ (   self,
  model1,
  model2,
  node1,
  node2,
  distance = 0,
  angle = 0 
)

Constructor.

Parameters
selfObject pointer
model1A Module object of one connected module
model2A module object of the other connected module
node1Connected node index of module1
node2Connected node index of module2
distanceConnection distance offset, default: 0
angleConnection angle offset, default: 0
def Connection.Connection.__init__ (   self,
  model1,
  model2,
  node1,
  node2,
  distance = 0,
  angle = 0 
)

Constructor.

Parameters
selfObject pointer
model1A Module object of one connected module
model2A module object of the other connected module
node1Connected node index of module1
node2Connected node index of module2
distanceConnection distance offset, default: 0
angleConnection angle offset, default: 0

Member Function Documentation

def Connection.Connection.__len__ (   self)

len definition

Parameters
selfObject pointer
def Connection.Connection.__len__ (   self)

len definition

Parameters
selfObject pointer
def Connection.Connection.GetConnectModuleAndNode (   self,
  module_name 
)

Giving one of the connected module, return the name and node index of the other connected module.

Parameters
selfObject pointer Name string of one of the connected module
Returns
If the name given is one of the module, then return the Module object of the other module; other wise return (False, False)

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