com.github.wshackle.fanuc.robotserver.IRegString 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 string registers on the robot controller.
 */
@IID("{CADEF7CB-650F-45B7-BC95-9080FA32640B}")
public interface IRegString 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 string 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 string 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 string register's value.
   * 
   * 
   * Getter method for the COM property "Value"
   * 
   * @return  Returns a value of type java.lang.String
   */

  @DISPID(202) //= 0xca. The runtime will prefer the VTID if present
  @VTID(11)
  java.lang.String value();


  /**
   * 
   * Returns/sets the string register's value.
   * 
   * 
   * Setter method for the COM property "Value"
   * 
   * @param value Mandatory java.lang.String parameter.
   */

  @DISPID(202) //= 0xca. The runtime will prefer the VTID if present
  @VTID(12)
  void value(
    java.lang.String value);


  /**
   * 
   *  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(13)
  com.github.wshackle.fanuc.robotserver.IVar parent();


  // Properties:
}