com.github.wshackle.fanuc.robotserver.IRegNumeric 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.*;

/**
 * This object allows access to numeric registers on the robot controller.
 */
@IID("{6B51A440-212A-11D0-959F-00A024329125}")
public interface IRegNumeric extends com.github.wshackle.fanuc.robotserver.IRobotObject {
  // 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();


  /**
   * 
   * Returns/sets the comment associated with the numeric register.
   * 
   * 
   * Getter method for the COM property "Comment"
   * 
   * @return  Returns a value of type java.lang.String
   */

  @DISPID(201) //= 0xc9. The runtime will prefer the VTID if present
  @VTID(9)
  java.lang.String comment();


  /**
   * 
   * Returns/sets the comment associated with the numeric register.
   * 
   * 
   * Setter method for the COM property "Comment"
   * 
   * @param comment Mandatory java.lang.String parameter.
   */

  @DISPID(201) //= 0xc9. The runtime will prefer the VTID if present
  @VTID(10)
  void comment(
    java.lang.String comment);


  /**
   * 
   * Returns/sets the long value for the numeric register.
   * 
   * 
   * Getter method for the COM property "RegLong"
   * 
   * @return  Returns a value of type int
   */

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


  /**
   * 
   * Returns/sets the long value for the numeric register.
   * 
   * 
   * Setter method for the COM property "RegLong"
   * 
   * @param regLong Mandatory int parameter.
   */

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


  /**
   * 
   * Returns/sets the float value for the numeric register.
   * 
   * 
   * Getter method for the COM property "RegFloat"
   * 
   * @return  Returns a value of type float
   */

  @DISPID(203) //= 0xcb. The runtime will prefer the VTID if present
  @VTID(13)
  float regFloat();


  /**
   * 
   * Returns/sets the float value for the numeric register.
   * 
   * 
   * Setter method for the COM property "RegFloat"
   * 
   * @param regFloat Mandatory float parameter.
   */

  @DISPID(203) //= 0xcb. The runtime will prefer the VTID if present
  @VTID(14)
  void regFloat(
    float regFloat);


  /**
   * 
   * Returns the type of numeric value currently contained in the register.
   * 
   * 
   * Getter method for the COM property "Type"
   * 
   * @return  Returns a value of type com.github.wshackle.fanuc.robotserver.FRETypeCodeConstants
   */

  @DISPID(204) //= 0xcc. The runtime will prefer the VTID if present
  @VTID(15)
  com.github.wshackle.fanuc.robotserver.FRETypeCodeConstants type();


  /**
   * 
   *  Returns the owning variable object.
   * 
   * 
   * Getter method for the COM property "Parent"
   * 
   * @return  Returns a value of type com.github.wshackle.fanuc.robotserver.IVar
   */

  @DISPID(205) //= 0xcd. The runtime will prefer the VTID if present
  @VTID(16)
  com.github.wshackle.fanuc.robotserver.IVar parent();


  // Properties:
}