com.github.wshackle.fanuc.robotserver.IAlarm Maven / Gradle / Ivy
package com.github.wshackle.fanuc.robotserver ;
import com4j.*;
/**
* This object contains error and cause data for the item selected from the FRCAlarms collection.
*/
@IID("{7C37F236-A494-11D0-A37F-0020AF39BE5A}")
public interface IAlarm extends com.github.wshackle.fanuc.robotserver.IRobotObject {
// Methods:
/**
*
* Returns the Error Facility Code for the alarm.
*
*
* Getter method for the COM property "ErrorFacility"
*
* @return Returns a value of type int
*/
@DISPID(201) //= 0xc9. The runtime will prefer the VTID if present
@VTID(8)
int errorFacility();
/**
*
* Returns the severity constant of the alarm
*
*
* Getter method for the COM property "ErrorSeverity"
*
* @return Returns a value of type com.github.wshackle.fanuc.robotserver.FREAlarmSeverityConstants
*/
@DISPID(202) //= 0xca. The runtime will prefer the VTID if present
@VTID(9)
com.github.wshackle.fanuc.robotserver.FREAlarmSeverityConstants errorSeverity();
/**
*
* Returns the field of ErrorSeverity that determines how the alarm effects program execution.
*
*
* Getter method for the COM property "ErrorExecution"
*
* @return Returns a value of type int
*/
@DISPID(203) //= 0xcb. The runtime will prefer the VTID if present
@VTID(10)
int errorExecution();
/**
*
* Returns the field of ErrorSeverity that determins how the alarm effects motion.
*
*
* Getter method for the COM property "ErrorMotion"
*
* @return Returns a value of type int
*/
@DISPID(204) //= 0xcc. The runtime will prefer the VTID if present
@VTID(11)
int errorMotion();
/**
*
* Returns the Error Number for the alarm.
*
*
* Getter method for the COM property "ErrorNumber"
*
* @return Returns a value of type int
*/
@DISPID(205) //= 0xcd. The runtime will prefer the VTID if present
@VTID(12)
int errorNumber();
/**
*
* Returns the Error Message for the alarm.
*
*
* Getter method for the COM property "ErrorMessage"
*
* @return Returns a value of type java.lang.String
*/
@DISPID(206) //= 0xce. The runtime will prefer the VTID if present
@VTID(13)
java.lang.String errorMessage();
/**
*
* Returns the Facility Code for the cause of the alarm.
*
*
* Getter method for the COM property "CauseFacility"
*
* @return Returns a value of type int
*/
@DISPID(207) //= 0xcf. The runtime will prefer the VTID if present
@VTID(14)
int causeFacility();
/**
*
* Returns the cause error number for the cause of the alarm.
*
*
* Getter method for the COM property "CauseNumber"
*
* @return Returns a value of type int
*/
@DISPID(208) //= 0xd0. The runtime will prefer the VTID if present
@VTID(15)
int causeNumber();
/**
*
* Returns the message string describing the cause of the alarm.
*
*
* Getter method for the COM property "CauseMessage"
*
* @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 causeMessage();
/**
*
* Returns the time and date of the error as taken from the controller system clock.
*
*
* Getter method for the COM property "TimeStamp"
*
* @return Returns a value of type java.util.Date
*/
@DISPID(210) //= 0xd2. The runtime will prefer the VTID if present
@VTID(17)
java.util.Date timeStamp();
/**
*
* Returns the description of the severity of the alarm.
*
*
* Getter method for the COM property "SeverityMessage"
*
* @return Returns a value of type java.lang.String
*/
@DISPID(211) //= 0xd3. The runtime will prefer the VTID if present
@VTID(18)
java.lang.String severityMessage();
/**
*
* Returns the integer value that represents the alarm?s current position in the log.
*
*
* Getter method for the COM property "Index"
*
* @return Returns a value of type int
*/
@DISPID(212) //= 0xd4. The runtime will prefer the VTID if present
@VTID(19)
int index();
/**
*
* Returns the Error Facility Code Mnemonic string for the alarm.
*
*
* Getter method for the COM property "ErrorMnemonic"
*
* @return Returns a value of type java.lang.String
*/
@DISPID(213) //= 0xd5. The runtime will prefer the VTID if present
@VTID(20)
java.lang.String errorMnemonic();
/**
*
* Returns the Mnemonic code for the cause of the alarm.
*
*
* Getter method for the COM property "CauseMnemonic"
*
* @return Returns a value of type java.lang.String
*/
@DISPID(214) //= 0xd6. The runtime will prefer the VTID if present
@VTID(21)
java.lang.String causeMnemonic();
/**
*
* Returns the type of alarm as FREAlarmSeverityConstants.
*
*
* Getter method for the COM property "ErrorClass"
*
* @return Returns a value of type int
*/
@DISPID(215) //= 0xd7. The runtime will prefer the VTID if present
@VTID(22)
int errorClass();
/**
*
* Returns the name of the robot that generated the alarm.
*
*
* Getter method for the COM property "HostName"
*
* @return Returns a value of type java.lang.String
*/
@DISPID(216) //= 0xd8. The runtime will prefer the VTID if present
@VTID(23)
java.lang.String hostName();
/**
*
* Returns the IP address of the robot that generated the alarm.
*
*
* Getter method for the COM property "IPAddress"
*
* @return Returns a value of type java.lang.String
*/
@DISPID(217) //= 0xd9. The runtime will prefer the VTID if present
@VTID(24)
java.lang.String ipAddress();
// Properties:
}