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

A class used to manage each node, in this case is the part has connectable face. More...

#include <SmoresNode.hh>

Public Member Functions

 SmoresNode ()
 Constructor.
 
 SmoresNode (int nodeID, int jtype, int jvalue, SmoresModulePtr parent, SmoresEdgePtr edge)
 Constructor. More...
 
 SmoresNode (int nodeID, int jtype, int jvalue, SmoresModulePtr parent)
 Constructor. More...
 
 SmoresNode (int nodeID, int jtype, int jvalue)
 Constructor. More...
 
 ~SmoresNode ()
 Destructor.
 
void NodeInit (int nodeID, int jtype, int jvalue, SmoresModulePtr parent, SmoresEdgePtr edge)
 Node initilization functions. More...
 
void NodeInit (int nodeID, int jtype, int jvalue, SmoresModulePtr parent)
 Node initilization functions. More...
 
void SetParent (SmoresModulePtr mparent)
 Set the parent object. More...
 
int GetAxis (void)
 Get axis of the norm vector of connectable face. More...
 
void ConnectOnEdge (SmoresEdgePtr edge)
 Connect the current node to one edge. More...
 
void Disconnect (void)
 Disconnect the current node from any edge.
 
SmoresEdgePtr GetEdge (void)
 Get the edge that current node connects to. More...
 

Public Attributes

int NodeID
 Node ID specify which node the current node is, 0 is the base node.
 
int JointType
 0 for revolute or 1 for prismatic
 
int JointValue
 Revolute joint: angle value; prismatic joint: distance value.
 
math::Vector3 RelativePosition
 Position of the current node relative to base node.
 
SmoresModulePtr Parent
 A pointer to its parent.
 
SmoresEdgePtr Edge
 A pointer to the existing edge.
 

Detailed Description

A class used to manage each node, in this case is the part has connectable face.

Constructor & Destructor Documentation

gazebo::SmoresNode::SmoresNode ( int  nodeID,
int  jtype,
int  jvalue,
SmoresModulePtr  parent,
SmoresEdgePtr  edge 
)

Constructor.

Parameters
nodeIDId number for the current node
jtypeJoint type of the current node, relative to module
jvalueCurrent joint angle
parentPointer to its parent SmoresModule object
edgePointer to the SmoresEdge object
gazebo::SmoresNode::SmoresNode ( int  nodeID,
int  jtype,
int  jvalue,
SmoresModulePtr  parent 
)

Constructor.

Parameters
nodeIDId number for the current node
jtypeJoint type of the current node, relative to module
jvalueCurrent joint angle
parentPointer to its parent SmoresModule object
gazebo::SmoresNode::SmoresNode ( int  nodeID,
int  jtype,
int  jvalue 
)

Constructor.

Parameters
nodeIDId number for the current node
jtypeJoint type of the current node, relative to module
jvalueCurrent joint angle

Member Function Documentation

void gazebo::SmoresNode::ConnectOnEdge ( SmoresEdgePtr  edge)

Connect the current node to one edge.

The edge that current node connect to

int gazebo::SmoresNode::GetAxis ( void  )

Get axis of the norm vector of connectable face.

Returns
Axis id
SmoresEdgePtr gazebo::SmoresNode::GetEdge ( void  )

Get the edge that current node connects to.

Returns
SmoresEdgePtr The edge this node connected to or empty pointer
void gazebo::SmoresNode::NodeInit ( int  nodeID,
int  jtype,
int  jvalue,
SmoresModulePtr  parent,
SmoresEdgePtr  edge 
)

Node initilization functions.

Parameters
nodeIDId number for the current node
jtypeJoint type of the current node, relative to module
jvalueCurrent joint angle
parentPointer to its parent SmoresModule object
edgePointer to the SmoresEdge object
void gazebo::SmoresNode::NodeInit ( int  nodeID,
int  jtype,
int  jvalue,
SmoresModulePtr  parent 
)

Node initilization functions.

Parameters
nodeIDId number for the current node
jtypeJoint type of the current node, relative to module
jvalueCurrent joint angle
parentPointer to its parent SmoresModule object
void gazebo::SmoresNode::SetParent ( SmoresModulePtr  mparent)

Set the parent object.

Parameters
mparentPointer to its parent, which is a SmoresModule object

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