com.github.wshackle.fanuc.robotserver.ITPPositions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of fanucCom4JBase Show documentation
The newest version!
package com.github.wshackle.fanuc.robotserver  ;

import com4j.*;

/**
 * Provides access to the collection of positions in a TP program. 
 */
@IID("{A16AD1C6-F45A-11CF-8901-0020AF68F0A3}")
public interface ITPPositions extends com.github.wshackle.fanuc.robotserver.IRobotObject,Iterable {
  // Methods:
  /**
   * 
   * Returns the owning program object.
   * 
   * 
   * Getter method for the COM property "Program"
   * 
   * @return  Returns a value of type com.github.wshackle.fanuc.robotserver.IProgram
   */

  @DISPID(101) //= 0x65. The runtime will prefer the VTID if present
  @VTID(8)
  com.github.wshackle.fanuc.robotserver.IProgram program();


  /**
   * 
   * Getter method for the COM property "_NewEnum"
   * 
   */

  @DISPID(-4) //= 0xfffffffc. The runtime will prefer the VTID if present
  @VTID(9)
  java.util.Iterator iterator();

  /**
   * 
   * Returns a TP position from the collection. 
   * 
   * 
   * Getter method for the COM property "Item"
   * 
   * @param id Optional parameter. Default value is com4j.Variant.getMissing()
   * @param index Optional parameter. Default value is com4j.Variant.getMissing()
   * @return  Returns a value of type com.github.wshackle.fanuc.robotserver.ITPPosition
   */

  @DISPID(0) //= 0x0. The runtime will prefer the VTID if present
  @VTID(10)
  @DefaultMethod
  com.github.wshackle.fanuc.robotserver.ITPPosition item(
    @Optional @MarshalAs(NativeType.VARIANT) java.lang.Object id,
    @Optional @MarshalAs(NativeType.VARIANT) java.lang.Object index);


  /**
   * 
   * Returns the number of TP positions contained in the collection (and therefore, in the TP program).
   * 
   * 
   * Getter method for the COM property "Count"
   * 
   * @return  Returns a value of type int
   */

  @DISPID(201) //= 0xc9. The runtime will prefer the VTID if present
  @VTID(11)
  int count();


  /**
   * 
   * Returns the first empty position ID from the TP position collection
   * 
   * 
   * Getter method for the COM property "NewPosID"
   * 
   * @return  Returns a value of type int
   */

  @DISPID(202) //= 0xca. The runtime will prefer the VTID if present
  @VTID(12)
  int newPosID();


  /**
   */

  @DISPID(251) //= 0xfb. The runtime will prefer the VTID if present
  @VTID(13)
  void renumberAll();


  /**
   * 
   * Returns a TP position from the collection. 
   * 
   * @param groupNum Mandatory short parameter.
   * @param index Mandatory int parameter.
   * @param x Mandatory Holder parameter.
   * @param y Mandatory Holder parameter.
   * @param z Mandatory Holder parameter.
   * @param w Mandatory Holder parameter.
   * @param p Mandatory Holder parameter.
   * @param r Mandatory Holder parameter.
   * @return  Returns a value of type boolean
   */

  @DISPID(203) //= 0xcb. The runtime will prefer the VTID if present
  @VTID(14)
  boolean getGroupXyzWprByIndex(
    short groupNum,
    int index,
    Holder x,
    Holder y,
    Holder z,
    Holder w,
    Holder p,
    Holder r);


  // Properties:
}