com.github.wshackle.fanuc.robotserver.IPipe Maven / Gradle / Ivy
package com.github.wshackle.fanuc.robotserver ;
import com4j.*;
/**
* Provides access to a pipe defined on the controller.
*/
@IID("{B475BC94-3AF1-11D4-9F66-00105AE428C3}")
public interface IPipe extends com.github.wshackle.fanuc.robotserver.IRobotObject {
// Methods:
/**
*
* Tells the controller to flush the pipe.
*
*/
@DISPID(201) //= 0xc9. The runtime will prefer the VTID if present
@VTID(8)
void flush();
/**
*
* Returns the ID number of the pipe.
*
*
* Getter method for the COM property "Id"
*
* @return Returns a value of type com.github.wshackle.fanuc.robotserver.FREPipeIDConstants
*/
@DISPID(202) //= 0xca. The runtime will prefer the VTID if present
@VTID(9)
com.github.wshackle.fanuc.robotserver.FREPipeIDConstants id();
/**
*
* Returns True if the Robot Server is monitoring this pipe.
*
*
* Getter method for the COM property "IsMonitoring"
*
* @return Returns a value of type boolean
*/
@DISPID(203) //= 0xcb. The runtime will prefer the VTID if present
@VTID(10)
boolean isMonitoring();
/**
*
* Returns True if the pipe has overflowed and is no longer sending data.
*
*
* Getter method for the COM property "IsOverflowed"
*
* @return Returns a value of type boolean
*/
@DISPID(204) //= 0xcc. The runtime will prefer the VTID if present
@VTID(11)
boolean isOverflowed();
/**
*
* Returns the parent object.
*
*
* Getter method for the COM property "Parent"
*
* @return Returns a value of type com.github.wshackle.fanuc.robotserver.IPipes
*/
@DISPID(205) //= 0xcd. The runtime will prefer the VTID if present
@VTID(12)
com.github.wshackle.fanuc.robotserver.IPipes parent();
/**
*
* Starts monitoring data put into the pipe.
*
* @param flushTime Mandatory int parameter.
*/
@DISPID(206) //= 0xce. The runtime will prefer the VTID if present
@VTID(13)
void startMonitor(
int flushTime);
/**
*
* Stops monitoring data put into the pipe.
*
*/
@DISPID(207) //= 0xcf. The runtime will prefer the VTID if present
@VTID(14)
void stopMonitor();
/**
*
* Returns a string type name for the pipe.
*
*
* Getter method for the COM property "TypeName"
*
* @return Returns a value of type java.lang.String
*/
@DISPID(208) //= 0xd0. The runtime will prefer the VTID if present
@VTID(15)
java.lang.String typeName();
/**
*
* Returns a string that identifies the KAREL program which defined the type.
*
*
* Getter method for the COM property "TypeProgName"
*
* @return Returns a value of type java.lang.String
*/
@DISPID(209) //= 0xd1. The runtime will prefer the VTID if present
@VTID(16)
java.lang.String typeProgName();
// Properties:
}