org.robokind.api.motion.jointgroup
Class RobotJointGroupConfig

java.lang.Object
  org.robokind.api.common.property.PropertyChangeNotifier
      org.robokind.api.motion.jointgroup.DefaultJointGroupConfig<Robot.JointId,RobotJointGroupConfig>
          org.robokind.api.motion.jointgroup.RobotJointGroupConfig

All Implemented Interfaces:

PropertyChangeSource, JointGroupConfig<Robot.JointId,RobotJointGroupConfig>

public class RobotJointGroupConfig
extends DefaultJointGroupConfig<Robot.JointId,RobotJointGroupConfig>

Config for a RobotJointGroup which identifies the Robot the JointGroup should use.

Author:

Matthew Stevenson

Field Summary

Fields inherited from interface org.robokind.api.motion.jointgroup.JointGroupConfig

PROP_ADD_JOINT_GROUP, PROP_ADD_JOINT_ID, PROP_ENABLED, PROP_NAME, PROP_REMOVE_JOINT_GROUP, PROP_REMOVE_JOINT_ID

Constructor Summary

RobotJointGroupConfig(String name, Robot.Id robotId)
Creates an empty RobotJointGroupConfig.

RobotJointGroupConfig(String name, Robot.Id robotId, List<? extends Robot.JointId> ids, List<? extends RobotJointGroupConfig> groups)
Creates a RobotJointGroupConfig with the given JointIds and sub-groups.

Method Summary

Robot.Id

getRobotId() Returns the Robot Id to be used by the JointGroup.

Methods inherited from class org.robokind.api.motion.jointgroup.DefaultJointGroupConfig

addGroup, addJointId, getEnabled, getGroupCount, getJointCount, getJointGroup, getJointGroups, getJointId, getJointIds, getName, insertGroup, insertJointId, removeGroup, removeGroupAt, removeJointId, removeJointIdAt, setEnabled, setName, toString

Methods inherited from class org.robokind.api.common.property.PropertyChangeNotifier

addPropertyChangeListener, addPropertyChangeListener, fireIndexedPropertyChange, fireIndexedPropertyChange, fireIndexedPropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.robokind.api.common.property.PropertyChangeSource

addPropertyChangeListener, addPropertyChangeListener, removePropertyChangeListener, removePropertyChangeListener

Constructor Detail

RobotJointGroupConfig

public RobotJointGroupConfig(String name,
                             Robot.Id robotId)

Creates an empty RobotJointGroupConfig.

Parameters:

name - JointGroup name

robotId - robot for the JointGroup to use

RobotJointGroupConfig

public RobotJointGroupConfig(String name,
                             Robot.Id robotId,
                             List<? extends Robot.JointId> ids,
                             List<? extends RobotJointGroupConfig> groups)

Creates a RobotJointGroupConfig with the given JointIds and sub-groups.

Parameters:

name - JointGroup name

robotId - robot for the JointGroup to use

ids - JointIds belonging to the JointGroup

groups - sub-groups of the JointGroup

Method Detail

getRobotId

public Robot.Id getRobotId()

Returns the Robot Id to be used by the JointGroup.

Returns:

Robot Id to be used by the JointGroup