com.github.wshackle.fanuc.robotneighborhood.IRobotNeighborhood Maven / Gradle / Ivy
package com.github.wshackle.fanuc.robotneighborhood ;
import com4j.*;
/**
* Provides root access to the Robot Neighborhood.
*/
@IID("{27EF444E-5706-4BAD-8BAA-01610A602C37}")
public interface IRobotNeighborhood extends Com4jObject {
// Methods:
/**
*
* Returns the top level FRCRNRobots object for accessing the neighborhood.
*
*
* Getter method for the COM property "Robots"
*
* @return Returns a value of type com.github.wshackle.fanuc.robotneighborhood.IRNRobots
*/
@DISPID(1) //= 0x1. The runtime will prefer the VTID if present
@VTID(7)
com.github.wshackle.fanuc.robotneighborhood.IRNRobots robots();
/**
*
* Sets/returns the amount of time that the Robot Neighborhood will tolerate for the virtual robot to shut down.
*
*
* Getter method for the COM property "VirtualRestartTolerance"
*
* @return Returns a value of type int
*/
@DISPID(2) //= 0x2. The runtime will prefer the VTID if present
@VTID(8)
int virtualRestartTolerance();
/**
*
* Sets/returns the amount of time that the Robot Neighborhood will tolerate for the virtual robot to shut down.
*
*
* Setter method for the COM property "VirtualRestartTolerance"
*
* @param virtualRestartTolerance Mandatory int parameter.
*/
@DISPID(2) //= 0x2. The runtime will prefer the VTID if present
@VTID(9)
void virtualRestartTolerance(
int virtualRestartTolerance);
/**
*
* Sets/returns the time to delay after the robot responds to a ping to begin reconnecting.
*
*
* Getter method for the COM property "PingDelay"
*
* @return Returns a value of type int
*/
@DISPID(3) //= 0x3. The runtime will prefer the VTID if present
@VTID(10)
int pingDelay();
/**
*
* Sets/returns the time to delay after the robot responds to a ping to begin reconnecting.
*
*
* Setter method for the COM property "PingDelay"
*
* @param pingDelay Mandatory int parameter.
*/
@DISPID(3) //= 0x3. The runtime will prefer the VTID if present
@VTID(11)
void pingDelay(
int pingDelay);
/**
*
* Sets/returns the delay that the Robot Server will tolerate when waiting for the robot controller to respond to a request.
*
*
* Getter method for the COM property "RSResponseTolerance"
*
* @return Returns a value of type int
*/
@DISPID(4) //= 0x4. The runtime will prefer the VTID if present
@VTID(12)
int rsResponseTolerance();
/**
*
* Sets/returns the delay that the Robot Server will tolerate when waiting for the robot controller to respond to a request.
*
*
* Setter method for the COM property "RSResponseTolerance"
*
* @param rsResponseTolerance Mandatory int parameter.
*/
@DISPID(4) //= 0x4. The runtime will prefer the VTID if present
@VTID(13)
void rsResponseTolerance(
int rsResponseTolerance);
/**
*
* Sets/returns the default setting for AutoReconnectEnable.
*
*
* Getter method for the COM property "DefaultAutoReconnectEnable"
*
* @return Returns a value of type boolean
*/
@DISPID(5) //= 0x5. The runtime will prefer the VTID if present
@VTID(14)
boolean defaultAutoReconnectEnable();
/**
*
* Sets/returns the default setting for AutoReconnectEnable.
*
*
* Setter method for the COM property "DefaultAutoReconnectEnable"
*
* @param defaultAutoReconnectEnable Mandatory boolean parameter.
*/
@DISPID(5) //= 0x5. The runtime will prefer the VTID if present
@VTID(15)
void defaultAutoReconnectEnable(
boolean defaultAutoReconnectEnable);
/**
*
* Sets/returns the default setting for AutoReconnectPeriod
*
*
* Getter method for the COM property "DefaultAutoReconnectPeriod"
*
* @return Returns a value of type int
*/
@DISPID(6) //= 0x6. The runtime will prefer the VTID if present
@VTID(16)
int defaultAutoReconnectPeriod();
/**
*
* Sets/returns the default setting for AutoReconnectPeriod
*
*
* Setter method for the COM property "DefaultAutoReconnectPeriod"
*
* @param defaultAutoReconnectPeriod Mandatory int parameter.
*/
@DISPID(6) //= 0x6. The runtime will prefer the VTID if present
@VTID(17)
void defaultAutoReconnectPeriod(
int defaultAutoReconnectPeriod);
/**
*
* Sets/returns the default setting for AutoReconnectNumRetries
*
*
* Getter method for the COM property "DefaultAutoReconnectNumRetries"
*
* @return Returns a value of type int
*/
@DISPID(7) //= 0x7. The runtime will prefer the VTID if present
@VTID(18)
int defaultAutoReconnectNumRetries();
/**
*
* Sets/returns the default setting for AutoReconnectNumRetries
*
*
* Setter method for the COM property "DefaultAutoReconnectNumRetries"
*
* @param pVal Mandatory int parameter.
*/
@DISPID(7) //= 0x7. The runtime will prefer the VTID if present
@VTID(19)
void defaultAutoReconnectNumRetries(
int pVal);
/**
*
* Sets/returns the default setting for HeartbeatEnable
*
*
* Getter method for the COM property "DefaultHeartbeatEnable"
*
* @return Returns a value of type boolean
*/
@DISPID(8) //= 0x8. The runtime will prefer the VTID if present
@VTID(20)
boolean defaultHeartbeatEnable();
/**
*
* Sets/returns the default setting for HeartbeatEnable
*
*
* Setter method for the COM property "DefaultHeartbeatEnable"
*
* @param defaultHeartbeatEnable Mandatory boolean parameter.
*/
@DISPID(8) //= 0x8. The runtime will prefer the VTID if present
@VTID(21)
void defaultHeartbeatEnable(
boolean defaultHeartbeatEnable);
/**
*
* Sets/returns the default setting for HeartbeatPeriod
*
*
* Getter method for the COM property "DefaultHeartbeatPeriod"
*
* @return Returns a value of type int
*/
@DISPID(9) //= 0x9. The runtime will prefer the VTID if present
@VTID(22)
int defaultHeartbeatPeriod();
/**
*
* Sets/returns the default setting for HeartbeatPeriod
*
*
* Setter method for the COM property "DefaultHeartbeatPeriod"
*
* @param defaultHeartbeatPeriod Mandatory int parameter.
*/
@DISPID(9) //= 0x9. The runtime will prefer the VTID if present
@VTID(23)
void defaultHeartbeatPeriod(
int defaultHeartbeatPeriod);
/**
*
* Sets/returns the default setting for KeepAliveDuration
*
*
* Getter method for the COM property "DefaultKeepAliveEnable"
*
* @return Returns a value of type boolean
*/
@DISPID(10) //= 0xa. The runtime will prefer the VTID if present
@VTID(24)
boolean defaultKeepAliveEnable();
/**
*
* Sets/returns the default setting for KeepAliveDuration
*
*
* Setter method for the COM property "DefaultKeepAliveEnable"
*
* @param defaultKeepAliveEnable Mandatory boolean parameter.
*/
@DISPID(10) //= 0xa. The runtime will prefer the VTID if present
@VTID(25)
void defaultKeepAliveEnable(
boolean defaultKeepAliveEnable);
/**
*
* Sets/returns the default setting for KeepAliveEnable
*
*
* Getter method for the COM property "DefaultKeepAliveDuration"
*
* @return Returns a value of type int
*/
@DISPID(11) //= 0xb. The runtime will prefer the VTID if present
@VTID(26)
int defaultKeepAliveDuration();
/**
*
* Sets/returns the default setting for KeepAliveEnable
*
*
* Setter method for the COM property "DefaultKeepAliveDuration"
*
* @param defaultKeepAliveDuration Mandatory int parameter.
*/
@DISPID(11) //= 0xb. The runtime will prefer the VTID if present
@VTID(27)
void defaultKeepAliveDuration(
int defaultKeepAliveDuration);
/**
*
* Sets/returns the amount of time that the Robot Neighborhood delays when automatically switching between start modes.
*
*
* Getter method for the COM property "StartModeAutoDelay"
*
* @return Returns a value of type int
*/
@DISPID(12) //= 0xc. The runtime will prefer the VTID if present
@VTID(28)
int startModeAutoDelay();
/**
*
* Sets/returns the amount of time that the Robot Neighborhood delays when automatically switching between start modes.
*
*
* Setter method for the COM property "StartModeAutoDelay"
*
* @param startModeAutoDelay Mandatory int parameter.
*/
@DISPID(12) //= 0xc. The runtime will prefer the VTID if present
@VTID(29)
void startModeAutoDelay(
int startModeAutoDelay);
/**
*
* Returns the FRCRDMResponses object from which you can monitor and control FANUC's Robot Discovery Method.
*
*
* Getter method for the COM property "RDMResponses"
*
* @return Returns a value of type com.github.wshackle.fanuc.robotneighborhood.IRNRDMResponses
*/
@DISPID(13) //= 0xd. The runtime will prefer the VTID if present
@VTID(30)
com.github.wshackle.fanuc.robotneighborhood.IRNRDMResponses rdmResponses();
// Properties:
}