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

The class that has all the information about associations. More...

Public Member Functions

def __init__
 Constructor. More...
 
def ToString
 Current object to string. More...
 
def NodeToString
 Find node string name given node index. More...
 
def CorrelationToStr
 Correlation boolean value to string. More...
 

Public Attributes

 ModuleName
 Module name string.
 
 Node
 Node index.
 
 Correlation
 Correlation boolean value.
 
 Ratio
 Correlation ratio.
 

Detailed Description

The class that has all the information about associations.

Constructor & Destructor Documentation

def AssociateJoint.AssociateJoint.__init__ (   self,
  module,
  node,
  corr,
  ratio 
)

Constructor.

Parameters
selfObject pointer
moduleModule name string
nodeNode index
corrBool, correaltion: True for positive; False for negtive
ratioCorrelation ratio

Member Function Documentation

def AssociateJoint.AssociateJoint.CorrelationToStr (   self,
  corr 
)

Correlation boolean value to string.

Parameters
selfObject pointer
corrCorrelation boolean
def AssociateJoint.AssociateJoint.NodeToString (   self,
  node 
)

Find node string name given node index.

Parameters
selfObject pointer
nodeInteger, node indez
def AssociateJoint.AssociateJoint.ToString (   self)

Current object to string.

Parameters
selfObject pointer

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