com.github.wshackle.fanuc.robotserver.ISysGroupPosition Maven / Gradle / Ivy
package com.github.wshackle.fanuc.robotserver ;
import com4j.*;
/**
* Provides access to the positional data of a controller system position for a specific motion group.
*/
@IID("{DC2FA0C7-FFAB-11D0-B6F4-00C04FB9C401}")
public interface ISysGroupPosition extends com.github.wshackle.fanuc.robotserver.IPosition {
// Methods:
/**
*
* Returns the parent object.
*
*
* Getter method for the COM property "Parent"
*
* @return Returns a value of type com.github.wshackle.fanuc.robotserver.ISysPosition
*/
@DISPID(301) //= 0x12d. The runtime will prefer the VTID if present
@VTID(32)
com.github.wshackle.fanuc.robotserver.ISysPosition parent();
/**
*
* Returns/sets the comment associated with the position.
*
*
* Getter method for the COM property "Comment"
*
* @return Returns a value of type java.lang.String
*/
@DISPID(302) //= 0x12e. The runtime will prefer the VTID if present
@VTID(33)
java.lang.String comment();
/**
*
* Returns/sets the comment associated with the position.
*
*
* Setter method for the COM property "Comment"
*
* @param comment Mandatory java.lang.String parameter.
*/
@DISPID(302) //= 0x12e. The runtime will prefer the VTID if present
@VTID(34)
void comment(
java.lang.String comment);
/**
*
* Returns a boolean value that indicates if the positional data contained in the current object is 'almost equal to' the positional data of another object.
*
*
* Getter method for the COM property "IsEqualTo"
*
* @param targetPos Mandatory com4j.Com4jObject parameter.
* @return Returns a value of type boolean
*/
@DISPID(303) //= 0x12f. The runtime will prefer the VTID if present
@VTID(35)
boolean isEqualTo(
@MarshalAs(NativeType.Dispatch) com4j.Com4jObject targetPos);
/**
*
* Returns a Boolean indicating if the robot can reach the position or not.
*
*
* Getter method for the COM property "IsReachable"
*
* @param from Optional parameter. Default value is com4j.Variant.getMissing()
* @param moType Optional parameter. Default value is 6
* @param orientType Optional parameter. Default value is 2
* @param destination Optional parameter. Default value is com4j.Variant.getMissing()
* @param motionErrorInfo Optional parameter. Default value is 0
* @return Returns a value of type boolean
*/
@DISPID(304) //= 0x130. The runtime will prefer the VTID if present
@VTID(36)
boolean isReachable(
@Optional @MarshalAs(NativeType.VARIANT) java.lang.Object from,
@Optional @DefaultValue("6") com.github.wshackle.fanuc.robotserver.FREMotionTypeConstants moType,
@Optional @DefaultValue("2") com.github.wshackle.fanuc.robotserver.FREOrientTypeConstants orientType,
@Optional @MarshalAs(NativeType.VARIANT) java.lang.Object destination,
@Optional @DefaultValue("0") Holder motionErrorInfo);
/**
*
* Copies the positional data from another object into this one.
*
* @param position Mandatory com4j.Com4jObject parameter.
*/
@DISPID(305) //= 0x131. The runtime will prefer the VTID if present
@VTID(37)
void copy(
@MarshalAs(NativeType.Dispatch) com4j.Com4jObject position);
/**
*
* Returns a Boolean indicating if the robot can reach the position or not.
*
* @param from Optional parameter. Default value is com4j.Variant.getMissing()
* @param moType Optional parameter. Default value is 6
* @param orientType Optional parameter. Default value is 2
* @param destination Optional parameter. Default value is com4j.Variant.getMissing()
* @param motionErrorInfo Optional parameter. Default value is 0
* @return Returns a value of type boolean
*/
@DISPID(306) //= 0x132. The runtime will prefer the VTID if present
@VTID(38)
boolean checkReach(
@Optional @MarshalAs(NativeType.VARIANT) java.lang.Object from,
@Optional @DefaultValue("6") com.github.wshackle.fanuc.robotserver.FREMotionTypeConstants moType,
@Optional @DefaultValue("2") com.github.wshackle.fanuc.robotserver.FREOrientTypeConstants orientType,
@Optional @MarshalAs(NativeType.VARIANT) java.lang.Object destination,
@Optional @DefaultValue("0") Holder motionErrorInfo);
// Properties:
}