com.github.wshackle.fanuc.robotserver.ICurPosition Maven / Gradle / Ivy
package com.github.wshackle.fanuc.robotserver ;
import com4j.*;
/**
* Provides access to the current position of the robot for all motion groups.
*/
@IID("{E2686FA8-1E42-11D1-B6FF-00C04FB9C401}")
public interface ICurPosition extends com.github.wshackle.fanuc.robotserver.IRobotObject {
// Methods:
/**
*
* Returns whether the specified group is supported on the controller.
*
*
* Getter method for the COM property "GroupMask"
*
* @param groupNum Mandatory short parameter.
* @return Returns a value of type boolean
*/
@DISPID(201) //= 0xc9. The runtime will prefer the VTID if present
@VTID(8)
boolean groupMask(
short groupNum);
/**
*
* Returns FRCCurGroupPosition object representing the current position of the robot for the specified group and DisplayType.
*
*
* Getter method for the COM property "Group"
*
* @param groupNum Mandatory short parameter.
* @param displayType Mandatory com.github.wshackle.fanuc.robotserver.FRECurPositionConstants parameter.
* @return Returns a value of type com.github.wshackle.fanuc.robotserver.ICurGroupPosition
*/
@DISPID(202) //= 0xca. The runtime will prefer the VTID if present
@VTID(9)
com.github.wshackle.fanuc.robotserver.ICurGroupPosition group(
short groupNum,
com.github.wshackle.fanuc.robotserver.FRECurPositionConstants displayType);
/**
*
* Returns the number of groups defined on the controller.
*
*
* Getter method for the COM property "NumGroups"
*
* @return Returns a value of type short
*/
@DISPID(203) //= 0xcb. The runtime will prefer the VTID if present
@VTID(10)
short numGroups();
/**
*
* Returns if the position is currently being monitored for changes.
*
*
* Getter method for the COM property "IsMonitoring"
*
* @return Returns a value of type boolean
*/
@DISPID(204) //= 0xcc. The runtime will prefer the VTID if present
@VTID(11)
boolean isMonitoring();
/**
*
* Enables the Change event, with specified latency.
*
* @param latency Mandatory int parameter.
*/
@DISPID(250) //= 0xfa. The runtime will prefer the VTID if present
@VTID(12)
void startMonitor(
int latency);
/**
*
* Stops the Change event from occurring.
*
*/
@DISPID(251) //= 0xfb. The runtime will prefer the VTID if present
@VTID(13)
void stopMonitor();
/**
*
* Returns the bit mask representation of the groups supported by this position.
*
*
* Getter method for the COM property "GroupBitMask"
*
* @return Returns a value of type com.github.wshackle.fanuc.robotserver.FREGroupBitMaskConstants
*/
@DISPID(252) //= 0xfc. The runtime will prefer the VTID if present
@VTID(14)
com.github.wshackle.fanuc.robotserver.FREGroupBitMaskConstants groupBitMask();
// Properties:
}