org.robokind.api.motion.sync.SynchronizedJointConfig Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2011 Hanson Robokind LLC.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.robokind.api.motion.sync;

import org.robokind.api.common.position.NormalizedDouble;
import org.robokind.api.motion.Joint;

/**
 * Configuration for initializing a SynchronizedJoint.
 * 
 * @author Matthew Stevenson 
 */
public interface SynchronizedJointConfig {
    /**
     * Returns the local joint id for the Joint to use.
     * @return local joint id for the Joint to use
     */
    public Joint.Id getJointId();
    /**
     * Returns the name for the Joint to use.
     * @return name for the Joint to use
     */
    public String getName();
    /**
     * Returns the default position the the Joint to use.
     * @return default position the the Joint to use
     */
    public NormalizedDouble getDefaultPosition();    
}