com.github.wshackle.fanuc.robotserver.ITPProgram Maven / Gradle / Ivy
package com.github.wshackle.fanuc.robotserver ;
import com4j.*;
/**
* Represents a TP program on the robot controller.
*/
@IID("{D42AB5D3-8FFB-11D0-94CC-0020AF68F0A3}")
public interface ITPProgram extends com.github.wshackle.fanuc.robotserver.IRobotObject {
// Methods:
/**
*
* Returns the program name for the object.
*
*
* Getter method for the COM property "Name"
*
* @return Returns a value of type java.lang.String
*/
@DISPID(0) //= 0x0. The runtime will prefer the VTID if present
@VTID(8)
@DefaultMethod
java.lang.String name();
/**
*
* Returns a reference to the top level of the variables defined for the program.
*
*
* Getter method for the COM property "Variables"
*
* @return Returns a value of type com.github.wshackle.fanuc.robotserver.IVars
*/
@DISPID(101) //= 0x65. The runtime will prefer the VTID if present
@VTID(9)
com.github.wshackle.fanuc.robotserver.IVars variables();
/**
*
* Returns the current access mode for the program.
*
*
* Getter method for the COM property "AccessMode"
*
* @return Returns a value of type com.github.wshackle.fanuc.robotserver.FREAccessModeConstants
*/
@DISPID(102) //= 0x66. The runtime will prefer the VTID if present
@VTID(10)
com.github.wshackle.fanuc.robotserver.FREAccessModeConstants accessMode();
/**
*
* Returns the current reject mode for the program.
*
*
* Getter method for the COM property "RejectMode"
*
* @return Returns a value of type com.github.wshackle.fanuc.robotserver.FRERejectModeConstants
*/
@DISPID(103) //= 0x67. The runtime will prefer the VTID if present
@VTID(11)
com.github.wshackle.fanuc.robotserver.FRERejectModeConstants rejectMode();
/**
*
* Returns the parent FRCPrograms?collection.
*
*
* Getter method for the COM property "Parent"
*
* @return Returns a value of type com.github.wshackle.fanuc.robotserver.IPrograms
*/
@DISPID(104) //= 0x68. The runtime will prefer the VTID if present
@VTID(12)
com.github.wshackle.fanuc.robotserver.IPrograms parent();
/**
*
* Returns/sets the comment associated with the program.
*
*
* Getter method for the COM property "Comment"
*
* @return Returns a value of type java.lang.String
*/
@DISPID(105) //= 0x69. The runtime will prefer the VTID if present
@VTID(13)
java.lang.String comment();
/**
*
* Returns/sets the comment associated with the program.
*
*
* Setter method for the COM property "Comment"
*
* @param comment Mandatory java.lang.String parameter.
*/
@DISPID(105) //= 0x69. The runtime will prefer the VTID if present
@VTID(14)
void comment(
java.lang.String comment);
/**
*
* Returns the date the program was created as a Variant.
*
*
* Getter method for the COM property "Created"
*
* @return Returns a value of type java.lang.Object
*/
@DISPID(106) //= 0x6a. The runtime will prefer the VTID if present
@VTID(15)
@ReturnValue(type=NativeType.VARIANT)
java.lang.Object created();
/**
*
* Returns the date the program was last modified as a Variant.
*
*
* Getter method for the COM property "LastModified"
*
* @return Returns a value of type java.lang.Object
*/
@DISPID(107) //= 0x6b. The runtime will prefer the VTID if present
@VTID(16)
@ReturnValue(type=NativeType.VARIANT)
java.lang.Object lastModified();
/**
*
* Returns the original name of the program.
*
*
* Getter method for the COM property "OriginalName"
*
* @return Returns a value of type java.lang.String
*/
@DISPID(108) //= 0x6c. The runtime will prefer the VTID if present
@VTID(17)
java.lang.String originalName();
/**
*
* Returns the version of the program.
*
*
* Getter method for the COM property "Version"
*
* @return Returns a value of type short
*/
@DISPID(109) //= 0x6d. The runtime will prefer the VTID if present
@VTID(18)
short version();
/**
*
* Returns the size of the program in memory.
*
*
* Getter method for the COM property "Size"
*
* @return Returns a value of type int
*/
@DISPID(110) //= 0x6e. The runtime will prefer the VTID if present
@VTID(19)
int size();
/**
*
* Returns/sets the current level of protection for the program.
*
*
* Getter method for the COM property "Protection"
*
* @return Returns a value of type com.github.wshackle.fanuc.robotserver.FREProtectionConstants
*/
@DISPID(111) //= 0x6f. The runtime will prefer the VTID if present
@VTID(20)
com.github.wshackle.fanuc.robotserver.FREProtectionConstants protection();
/**
*
* Returns/sets the current level of protection for the program.
*
*
* Setter method for the COM property "Protection"
*
* @param protection Mandatory com.github.wshackle.fanuc.robotserver.FREProtectionConstants parameter.
*/
@DISPID(111) //= 0x6f. The runtime will prefer the VTID if present
@VTID(21)
void protection(
com.github.wshackle.fanuc.robotserver.FREProtectionConstants protection);
/**
*
* Returns/sets the stack size for the program.
*
*
* Getter method for the COM property "StackSize"
*
* @return Returns a value of type int
*/
@DISPID(112) //= 0x70. The runtime will prefer the VTID if present
@VTID(22)
int stackSize();
/**
*
* Returns/sets the stack size for the program.
*
*
* Setter method for the COM property "StackSize"
*
* @param stackSize Mandatory int parameter.
*/
@DISPID(112) //= 0x70. The runtime will prefer the VTID if present
@VTID(23)
void stackSize(
int stackSize);
/**
*
* Returns/sets the current priority of the program.
*
*
* Getter method for the COM property "Priority"
*
* @return Returns a value of type int
*/
@DISPID(113) //= 0x71. The runtime will prefer the VTID if present
@VTID(24)
int priority();
/**
*
* Returns/sets the current priority of the program.
*
*
* Setter method for the COM property "Priority"
*
* @param priority Mandatory int parameter.
*/
@DISPID(113) //= 0x71. The runtime will prefer the VTID if present
@VTID(25)
void priority(
int priority);
/**
*
* Returns the required time slice for the program.
*
*
* Getter method for the COM property "TimeSlice"
*
* @return Returns a value of type int
*/
@DISPID(114) //= 0x72. The runtime will prefer the VTID if present
@VTID(26)
int timeSlice();
/**
*
* Returns the required time slice for the program.
*
*
* Setter method for the COM property "TimeSlice"
*
* @param timeSlice Mandatory int parameter.
*/
@DISPID(114) //= 0x72. The runtime will prefer the VTID if present
@VTID(27)
void timeSlice(
int timeSlice);
/**
*
* Returns/sets the state of the busy lamp during program execution. True if the busy lamp is off during execution.
*
*
* Getter method for the COM property "BusyLampOff"
*
* @return Returns a value of type boolean
*/
@DISPID(115) //= 0x73. The runtime will prefer the VTID if present
@VTID(28)
boolean busyLampOff();
/**
*
* Returns/sets the state of the busy lamp during program execution. True if the busy lamp is off during execution.
*
*
* Setter method for the COM property "BusyLampOff"
*
* @param busyLampOff Mandatory boolean parameter.
*/
@DISPID(115) //= 0x73. The runtime will prefer the VTID if present
@VTID(29)
void busyLampOff(
boolean busyLampOff);
/**
*
* Returns/sets the group numbers for the program. True if the motion group is used.
*
*
* Getter method for the COM property "DefaultGroup"
*
* @param groupNumber Mandatory short parameter.
* @return Returns a value of type boolean
*/
@DISPID(116) //= 0x74. The runtime will prefer the VTID if present
@VTID(30)
boolean defaultGroup(
short groupNumber);
/**
*
* Returns/sets the group numbers for the program. True if the motion group is used.
*
*
* Setter method for the COM property "DefaultGroup"
*
* @param groupNumber Mandatory short parameter.
* @param defaultGroup Mandatory boolean parameter.
*/
@DISPID(116) //= 0x74. The runtime will prefer the VTID if present
@VTID(31)
void defaultGroup(
short groupNumber,
boolean defaultGroup);
/**
*
* Returns/sets the state of the IgnoreAbort attribute.
*
*
* Getter method for the COM property "IgnoreAbort"
*
* @param ignoreConstant Mandatory com.github.wshackle.fanuc.robotserver.FRETaskIgnoreConstants parameter.
* @return Returns a value of type boolean
*/
@DISPID(117) //= 0x75. The runtime will prefer the VTID if present
@VTID(32)
boolean ignoreAbort(
com.github.wshackle.fanuc.robotserver.FRETaskIgnoreConstants ignoreConstant);
/**
*
* Returns/sets the state of the IgnoreAbort attribute.
*
*
* Setter method for the COM property "IgnoreAbort"
*
* @param ignoreConstant Mandatory com.github.wshackle.fanuc.robotserver.FRETaskIgnoreConstants parameter.
* @param ignoreAbort Mandatory boolean parameter.
*/
@DISPID(117) //= 0x75. The runtime will prefer the VTID if present
@VTID(33)
void ignoreAbort(
com.github.wshackle.fanuc.robotserver.FRETaskIgnoreConstants ignoreConstant,
boolean ignoreAbort);
/**
*
* Returns/sets the state of the IgnorePause attribute.
*
*
* Getter method for the COM property "IgnorePause"
*
* @param ignoreConstant Mandatory com.github.wshackle.fanuc.robotserver.FRETaskIgnoreConstants parameter.
* @return Returns a value of type boolean
*/
@DISPID(118) //= 0x76. The runtime will prefer the VTID if present
@VTID(34)
boolean ignorePause(
com.github.wshackle.fanuc.robotserver.FRETaskIgnoreConstants ignoreConstant);
/**
*
* Returns/sets the state of the IgnorePause attribute.
*
*
* Setter method for the COM property "IgnorePause"
*
* @param ignoreConstant Mandatory com.github.wshackle.fanuc.robotserver.FRETaskIgnoreConstants parameter.
* @param ignorePause Mandatory boolean parameter.
*/
@DISPID(118) //= 0x76. The runtime will prefer the VTID if present
@VTID(35)
void ignorePause(
com.github.wshackle.fanuc.robotserver.FRETaskIgnoreConstants ignoreConstant,
boolean ignorePause);
/**
*
* Returns/sets the state of the invisible attribute. True will make the program invisible.
*
*
* Getter method for the COM property "Invisible"
*
* @return Returns a value of type boolean
*/
@DISPID(119) //= 0x77. The runtime will prefer the VTID if present
@VTID(36)
boolean invisible();
/**
*
* Returns/sets the state of the invisible attribute. True will make the program invisible.
*
*
* Setter method for the COM property "Invisible"
*
* @param invisible Mandatory boolean parameter.
*/
@DISPID(119) //= 0x77. The runtime will prefer the VTID if present
@VTID(37)
void invisible(
boolean invisible);
/**
*
* Returns/sets the owner name of the program.
*
*
* Getter method for the COM property "Owner"
*
* @return Returns a value of type java.lang.String
*/
@DISPID(120) //= 0x78. The runtime will prefer the VTID if present
@VTID(38)
java.lang.String owner();
/**
*
* Returns/sets the owner name of the program.
*
*
* Setter method for the COM property "Owner"
*
* @param owner Mandatory java.lang.String parameter.
*/
@DISPID(120) //= 0x78. The runtime will prefer the VTID if present
@VTID(39)
void owner(
java.lang.String owner);
/**
*
* Reopens the program with different access or reject mode attributes.
*
* @param accessMode Mandatory com.github.wshackle.fanuc.robotserver.FREAccessModeConstants parameter.
* @param rejectMode Mandatory com.github.wshackle.fanuc.robotserver.FRERejectModeConstants parameter.
*/
@DISPID(150) //= 0x96. The runtime will prefer the VTID if present
@VTID(40)
void reOpen(
com.github.wshackle.fanuc.robotserver.FREAccessModeConstants accessMode,
com.github.wshackle.fanuc.robotserver.FRERejectModeConstants rejectMode);
/**
*
* Saves the TP program and/or the variables associated with the program from memory to the specified file device. KAREL program executable statements can not be saved using this mechanism.
*
* @param fileName Mandatory java.lang.String parameter.
* @param option Optional parameter. Default value is com4j.Variant.getMissing()
* @param saveClass Optional parameter. Default value is com4j.Variant.getMissing()
*/
@DISPID(151) //= 0x97. The runtime will prefer the VTID if present
@VTID(41)
void save(
java.lang.String fileName,
@Optional @MarshalAs(NativeType.VARIANT) java.lang.Object option,
@Optional @MarshalAs(NativeType.VARIANT) java.lang.Object saveClass);
/**
*
* Returns a reference to the position collection associated with the TP program.
*
*
* Getter method for the COM property "Positions"
*
* @return Returns a value of type com.github.wshackle.fanuc.robotserver.ITPPositions
*/
@DISPID(201) //= 0xc9. The runtime will prefer the VTID if present
@VTID(42)
com.github.wshackle.fanuc.robotserver.ITPPositions positions();
/**
*
* Returns a reference to the lines collection associated with the TP program.
*
*
* Getter method for the COM property "Lines"
*
* @return Returns a value of type com.github.wshackle.fanuc.robotserver.ITPLines
*/
@DISPID(202) //= 0xca. The runtime will prefer the VTID if present
@VTID(43)
com.github.wshackle.fanuc.robotserver.ITPLines lines();
/**
*
* Returns/sets the sub-type of the program (macro, procedure, etc.).
*
*
* Getter method for the COM property "SubType"
*
* @return Returns a value of type com.github.wshackle.fanuc.robotserver.FRETPSubTypeConstants
*/
@DISPID(203) //= 0xcb. The runtime will prefer the VTID if present
@VTID(44)
com.github.wshackle.fanuc.robotserver.FRETPSubTypeConstants subType();
/**
*
* Returns/sets the sub-type of the program (macro, procedure, etc.).
*
*
* Setter method for the COM property "SubType"
*
* @param subType Mandatory com.github.wshackle.fanuc.robotserver.FRETPSubTypeConstants parameter.
*/
@DISPID(203) //= 0xcb. The runtime will prefer the VTID if present
@VTID(45)
void subType(
com.github.wshackle.fanuc.robotserver.FRETPSubTypeConstants subType);
/**
*
* Returns a reference to the application data collection associated with the TP program.
*
*
* Getter method for the COM property "ApplData"
*
* @return Returns a value of type com.github.wshackle.fanuc.robotserver.ITPApplDataCollection
*/
@DISPID(204) //= 0xcc. The runtime will prefer the VTID if present
@VTID(46)
com.github.wshackle.fanuc.robotserver.ITPApplDataCollection applData();
/**
*
* Returns a reference to the label collection associated with the TP program.
*
*
* Getter method for the COM property "Labels"
*
* @return Returns a value of type com.github.wshackle.fanuc.robotserver.ITPLabels
*/
@DISPID(205) //= 0xcd. The runtime will prefer the VTID if present
@VTID(47)
com.github.wshackle.fanuc.robotserver.ITPLabels labels();
/**
*
* Runs the TP program by creating a task for the program.
*
* @param stepType Optional parameter. Default value is com4j.Variant.getMissing()
* @param lineNum Optional parameter. Default value is com4j.Variant.getMissing()
* @param direction Optional parameter. Default value is com4j.Variant.getMissing()
*/
@DISPID(250) //= 0xfa. The runtime will prefer the VTID if present
@VTID(48)
void run(
@Optional @MarshalAs(NativeType.VARIANT) java.lang.Object stepType,
@Optional @MarshalAs(NativeType.VARIANT) java.lang.Object lineNum,
@Optional @MarshalAs(NativeType.VARIANT) java.lang.Object direction);
/**
* @param newProgName Mandatory java.lang.String parameter.
*/
@DISPID(251) //= 0xfb. The runtime will prefer the VTID if present
@VTID(49)
void rename(
java.lang.String newProgName);
/**
*
* Returns at bit mask representing the motion groups used by this program.
*
*
* Getter method for the COM property "DefaultGroupBitMask"
*
* @return Returns a value of type com.github.wshackle.fanuc.robotserver.FREGroupBitMaskConstants
*/
@DISPID(252) //= 0xfc. The runtime will prefer the VTID if present
@VTID(50)
com.github.wshackle.fanuc.robotserver.FREGroupBitMaskConstants defaultGroupBitMask();
/**
*
* Close program.
*
*/
@DISPID(253) //= 0xfd. The runtime will prefer the VTID if present
@VTID(51)
void close();
/**
*
* Selects a line for editing by internal editor.
*
* @param lineNum Mandatory int parameter.
* @param colNum Optional parameter. Default value is com4j.Variant.getMissing()
*/
@DISPID(254) //= 0xfe. The runtime will prefer the VTID if present
@VTID(52)
void editLine(
int lineNum,
@Optional @MarshalAs(NativeType.VARIANT) java.lang.Object colNum);
/**
*
* Returns/sets the storage-type of the program (CMOS, File, Shadow, etc.).
*
*
* Getter method for the COM property "StorageType"
*
* @return Returns a value of type com.github.wshackle.fanuc.robotserver.FRETPStorageTypeConstants
*/
@DISPID(255) //= 0xff. The runtime will prefer the VTID if present
@VTID(53)
com.github.wshackle.fanuc.robotserver.FRETPStorageTypeConstants storageType();
/**
*
* Returns/sets the storage-type of the program (CMOS, File, Shadow, etc.).
*
*
* Setter method for the COM property "StorageType"
*
* @param storageType Mandatory com.github.wshackle.fanuc.robotserver.FRETPStorageTypeConstants parameter.
*/
@DISPID(255) //= 0xff. The runtime will prefer the VTID if present
@VTID(54)
void storageType(
com.github.wshackle.fanuc.robotserver.FRETPStorageTypeConstants storageType);
// Properties:
}