com.github.wshackle.fanuc.robotserver.IPacket Maven / Gradle / Ivy
package com.github.wshackle.fanuc.robotserver ;
import com4j.*;
/**
* Provides access to the information received in a ROS packet.
*/
@IID("{7B125AAE-9330-11D1-B751-00C04FB99C75}")
public interface IPacket extends com.github.wshackle.fanuc.robotserver.IRobotObject {
// Methods:
/**
*
* Returns the contents of a ROS packet minus the standard ROS header.
*
*
* Getter method for the COM property "Body"
*
* @return Returns a value of type byte[]
*/
@DISPID(101) //= 0x65. The runtime will prefer the VTID if present
@VTID(8)
byte[] body();
/**
*
* Returns the itr_depth packet parameter used by the Interpreter
*
*
* Getter method for the COM property "ItrDepth"
*
* @return Returns a value of type byte
*/
@DISPID(102) //= 0x66. The runtime will prefer the VTID if present
@VTID(9)
byte itrDepth();
/**
*
* Returns the ROS Packet ID sent as the argument to osxsndpkt and received in the osrcvpkt argument list.
*
*
* Getter method for the COM property "PacketID"
*
* @return Returns a value of type int
*/
@DISPID(103) //= 0x67. The runtime will prefer the VTID if present
@VTID(10)
int packetID();
/**
*
* Returns the ROS packet type.
*
*
* Getter method for the COM property "PacketType"
*
* @return Returns a value of type byte
*/
@DISPID(104) //= 0x68. The runtime will prefer the VTID if present
@VTID(11)
byte packetType();
/**
*
* Returns the request code from the header of the ROS packet.
*
*
* Getter method for the COM property "RequestCode"
*
* @return Returns a value of type byte
*/
@DISPID(105) //= 0x69. The runtime will prefer the VTID if present
@VTID(12)
byte requestCode();
/**
*
* Returns the requestor ID from the header of the ROS packet.
*
*
* Getter method for the COM property "RequestorID"
*
* @return Returns a value of type int
*/
@DISPID(106) //= 0x6a. The runtime will prefer the VTID if present
@VTID(13)
int requestorID();
/**
*
* Returns the status received with each ROS packet.
*
*
* Getter method for the COM property "Status"
*
* @return Returns a value of type int
*/
@DISPID(107) //= 0x6b. The runtime will prefer the VTID if present
@VTID(14)
int status();
/**
*
* Returns the subsystem code from the header of the ROS packet.
*
*
* Getter method for the COM property "SubSystemCode"
*
* @return Returns a value of type byte
*/
@DISPID(108) //= 0x6c. The runtime will prefer the VTID if present
@VTID(15)
byte subSystemCode();
/**
*
* Extracts data from the Body of the packet if the data was inserted using the companion KAREL Add_xxxPC built-ins.
*
* @param item Mandatory int parameter.
* @return Returns a value of type java.lang.Object
*/
@DISPID(151) //= 0x97. The runtime will prefer the VTID if present
@VTID(16)
@ReturnValue(type=NativeType.VARIANT)
java.lang.Object decodeBody(
int item);
// Properties:
}