org.robokind.api.motion.jointgroup
Interface JointGroupConfig<Id,GroupConfig extends JointGroupConfig<Id,? extends GroupConfig>>

Type Parameters:

Id - type of identifier for this JointGroup's Joints

GroupConfig - type of JointGroupConfiguration used by children JointGroups

All Superinterfaces:

PropertyChangeSource

All Known Implementing Classes:

DefaultJointGroupConfig, RobotJointGroupConfig

public interface JointGroupConfig<Id,GroupConfig extends JointGroupConfig<Id,? extends GroupConfig>>
extends PropertyChangeSource

Common interface for JointGroup configurations.

Author:

Matthew Stevenson

Field Summary

static String	PROP_ADD_JOINT_GROUP Property String for adding a child JointGroup
static String	PROP_ADD_JOINT_ID Property String for adding a JointId
static String	PROP_ENABLED Property String for enabled
static String	PROP_NAME Property String for name
static String	PROP_REMOVE_JOINT_GROUP Property String for removing a child JointGroup
static String	PROP_REMOVE_JOINT_ID Property String for removing a JointId

Method Summary

void	addGroup(GroupConfig group) Add a child JointGroupConfig.
void	addJointId(Id jointId) Adds a JointId to the JointGroupConfig
boolean	getEnabled() Returns the default enabled state
int	getGroupCount() Return the number of child JointGroupConfigs.
int	getJointCount() Returns the number of JointIds for this JointGroupConfig.
GroupConfig	getJointGroup(int index) Returns the child JointGroupConfig at the given index.
List<GroupConfig>	getJointGroups() Returns a List of the children JointGroupConfigs.
Id	getJointId(int index) Returns the JointId at the given index.
List<Id>	getJointIds() Returns a List of JointIds for this JointGroup
String	getName() Returns the name to use
void	insertGroup(GroupConfig group, int index) Add a child JointGroupConfig at the given index.
void	insertJointId(Id jointId, int index) Adds a JointId at the given index
void	removeGroup(GroupConfig group) Removes a child JointGroupConfig.
void	removeGroupAt(int index) Removes a child JointGroupConfig at the given index.
void	removeJointId(Id jointId) Removes a JointId
void	removeJointIdAt(int index) Removes the JointId with the given index.
void	setEnabled(boolean enabled) Sets the default enabled state of the JointGroup
void	setName(String name) Sets the name of the JointGroup

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

addPropertyChangeListener, addPropertyChangeListener, removePropertyChangeListener, removePropertyChangeListener

Field Detail

PROP_NAME

static final String PROP_NAME

Property String for name

See Also:

Constant Field Values

PROP_ENABLED

static final String PROP_ENABLED

Property String for enabled

See Also:

Constant Field Values

PROP_ADD_JOINT_ID

static final String PROP_ADD_JOINT_ID

Property String for adding a JointId

See Also:

Constant Field Values

PROP_REMOVE_JOINT_ID

static final String PROP_REMOVE_JOINT_ID

Property String for removing a JointId

See Also:

Constant Field Values

PROP_ADD_JOINT_GROUP

static final String PROP_ADD_JOINT_GROUP

Property String for adding a child JointGroup

See Also:

Constant Field Values

PROP_REMOVE_JOINT_GROUP

static final String PROP_REMOVE_JOINT_GROUP

Property String for removing a child JointGroup

See Also:

Constant Field Values

Method Detail

setName

void setName(String name)

Sets the name of the JointGroup

Parameters:

name - new name to use

getName

String getName()

Returns the name to use

Returns:

the name to use

setEnabled

void setEnabled(boolean enabled)

Sets the default enabled state of the JointGroup

Parameters:

enabled - default enabled state to use

getEnabled

boolean getEnabled()

Returns the default enabled state

Returns:

the default enabled state

addJointId

void addJointId(Id jointId)

Adds a JointId to the JointGroupConfig

Parameters:

jointId - id to add

insertJointId

void insertJointId(Id jointId,
                   int index)

Adds a JointId at the given index

Parameters:

jointId - id to add

index - index for the jointId

removeJointId

void removeJointId(Id jointId)

Removes a JointId

Parameters:

jointId - id to remove

removeJointIdAt

void removeJointIdAt(int index)

Removes the JointId with the given index.

Parameters:

index - position of the JointId in this JointGroupConfig's JointIds

getJointIds

List<Id> getJointIds()

Returns a List of JointIds for this JointGroup

Returns:

a List of JointIds for this JointGroup

getJointId

Id getJointId(int index)

Returns the JointId at the given index.

Parameters:

index - position of the JointId in the JointGroupConfig's JointIds

Returns:

the JointId at the given index

getJointCount

int getJointCount()

Returns the number of JointIds for this JointGroupConfig.

Returns:

the number of JointIds for this JointGroupConfig

addGroup

void addGroup(GroupConfig group)

Add a child JointGroupConfig.

Parameters:

group - child JointGroupConfig to add

insertGroup

void insertGroup(GroupConfig group,
                 int index)

Add a child JointGroupConfig at the given index.

Parameters:

group - child JointGroupConfig to add

index - position to add the child

removeGroup

void removeGroup(GroupConfig group)

Removes a child JointGroupConfig.

Parameters:

group - the child to remove

removeGroupAt

void removeGroupAt(int index)

Removes a child JointGroupConfig at the given index.

Parameters:

index - position of the child to remove

getJointGroups

List<GroupConfig> getJointGroups()

Returns a List of the children JointGroupConfigs.

Returns:

a List of the children JointGroupConfigs

getJointGroup

GroupConfig getJointGroup(int index)

Returns the child JointGroupConfig at the given index.

Parameters:

index - position to the child to remove

Returns:

the child JointGroupConfig removed

getGroupCount

int getGroupCount()

Return the number of child JointGroupConfigs.

Returns:

the number of child JointGroupConfigs