CommonRobotEnvironment (RoboSuite Java API)

java.lang.Object
- com.kapowtech.robosuite.api.java.rql.construct.CommonRobotEnvironment

All Implemented Interfaces:

Environment, java.io.Serializable
```
public final class CommonRobotEnvironment
extends java.lang.Object
implements Environment
```
The CommonRobotEnvironment is an Environment that applies the following special conditions to the execution of a robot:
- totalTimeLimit is a time limit on the total robot execution time. The time limit is specified in seconds. The time limit is measured from the time the robot starts executing on the server. If a robot exceeds this time it is stopped by RoboServer.
- objectTimeLimit is a time limit on the time between object extractions. The time limit is specified in seconds. The time limit is measured from the time of the last object extraction, or from the time the robot starts executing on the server if no object has yet been extracted.
- minObjectsLimit is a minimum limit on the number of objects extracted by the robot. If the robot extracts fewer objects than specified by this limit, then the robot will generate an error message.
- maxObjectsLimit is a maximum limit on the number of objects extracted by the robot. If the robot extracts more objects than specified by this limit, then the robot will generate an error message.
- stopRobotWhenMaxEntity true if the robot should be stopped when the maximum number of returned objects is reached.
- maxEmails the maximum number of emails the robot is allowed to send, or -1 if there is no limit.
- maxJavaScriptInstructions the maximum number of JavaScripts instruction the robot is allowed to execute, or -1 if there is no limit.
- maxHttpRequests the maximum number of HTTP requests the robot is allowed to perform, or -1 if there is no limit.
- maxLoadedBytes the maximum number of bytes the robot is allowed to load, or -1 if there is no limit.
- maxExecutedSteps the maximum number of steps the robot is allowed to execute, or -1 if there is no limit.
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`DEFAULT_BYPASS_OBJECT_REFINDER` Default setting for the `bypassObjectRefinder` property is `false`.
`static int`	`DEFAULT_MAX_EMAILS` Default setting for maxEmails property is `-1` (no limit).
`static int`	`DEFAULT_MAX_EXECUTED_STEPS` Default setting for maxExecutedSteps property is `-1` (no limit).
`static int`	`DEFAULT_MAX_HTTP_REQUESTS` Default setting for maxHttpRequests property is `-1` (no limit).
`static int`	`DEFAULT_MAX_JAVA_SCRIPT_INSTRUCTIONS` Default setting for maxJavaScriptInstructions property is `-1` (no limit).
`static int`	`DEFAULT_MAX_LOADED_BYTES` Default setting for maxLoadedBytes property is `-1` (no limit).
`static int`	`DEFAULT_MAX_OBJECTS_LIMIT` Default setting for the `maxObjectsLimit` property is 1000000.
`static int`	`DEFAULT_MIN_OBJECTS_LIMIT` Default setting for the `minObjectsLimit` property is 1.
`static int`	`DEFAULT_OBJECT_TIME_LIMIT` Default setting for the `objectTimeLimit` property is 10 minutes.
`static boolean`	`DEFAULT_STOP_ROBOT_WHEN_MAX_OBJECT` Default setting for stopRobotWhenMaxEntity property is `false`.
`static int`	`DEFAULT_TOTAL_TIME_LIMIT` Default setting for the `totalTimeLimit` property is 24 hours.

Constructor Summary

Constructors
Constructor and Description
`CommonRobotEnvironment()` Creates a `CommonRobotEnvironment` where the `totalTimeLimit` is set to `86400` (24 hours), `objectTimeLimit` is set to `600` (10 minutes), `minObjectsLimit` is set to `1`, and `maxObjectsLimit` is set to `1000000` (one million).
`CommonRobotEnvironment(boolean bypassObjectRefinder, int totalTimeLimit, int objectTimeLimit, int minObjectsLimit, int maxObjectsLimit)` Creates a `CommonRobotEnvironment` with the specified property values.
`CommonRobotEnvironment(boolean bypassObjectRefinder, int totalTimeLimit, int objectTimeLimit, int minObjectsLimit, int maxObjectsLimit, boolean stopRobotWhenMaxObject, int maxEmails, int maxJavaScriptInstructions, int maxHttpRequests, int maxLoadedBytes, int maxExecutedSteps, boolean stopOnAPIException, boolean stopIfConnectionLost)` Creates a `CommonRobotEnvironment` with the specified property values.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)` Returns `true` if this object and the specified object have the same property values, and `false` otherwise.
`boolean`	`getBypassObjectRefinder()` Returns whether the robot shall bypass the Object Refinder tag.
`int`	`getMaxEmails()` Returns the maximum number of emails the robot is allowed to send.
`int`	`getMaxExecutedSteps()` Returns the maximum number of steps the robot is allowed to execute.
`int`	`getMaxHttpRequests()` Returns the maximum number of HTTP requests the robot is allowed to perform. -1 is returned if there is no limit.
`int`	`getMaxJavaScriptInstructions()` Returns the maximum number of JavaScripts instruction the robot is allowed to execute. -1 is returned if there is no limit.
`int`	`getMaxLoadedBytes()` Returns the maximum number of bytes the robot is allowed to load. -1 is returned if there is no limit.
`int`	`getMaxObjectsLimit()` Returns the maximum objects limit.
`int`	`getMinObjectsLimit()` Returns the minimum objects limit.
`int`	`getObjectTimeLimit()` Returns the object time limit.
`boolean`	`getStopIfConnectionLost()` get the value of the stopIfClientDies property
`boolean`	`getStopOnAPIException()` get the value of the stopRobotOnAPIException property
`boolean`	`getStopRobotWhenMaxObject()` Returns true if the robot should be stopped when the maximum number of returned objects is reached.
`int`	`getTotalTimeLimit()` Returns the total time limit.
`int`	`hashCode()` Returns the hash code of this object based on property values.
`java.lang.String`	`toString()` Returns a human readable string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_BYPASS_OBJECT_REFINDER
```
public static final boolean DEFAULT_BYPASS_OBJECT_REFINDER
```
    Default setting for the bypassObjectRefinder property is false.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_TOTAL_TIME_LIMIT
```
public static final int DEFAULT_TOTAL_TIME_LIMIT
```
    Default setting for the totalTimeLimit property is 24 hours.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_OBJECT_TIME_LIMIT
```
public static final int DEFAULT_OBJECT_TIME_LIMIT
```
    Default setting for the objectTimeLimit property is 10 minutes.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MIN_OBJECTS_LIMIT
```
public static final int DEFAULT_MIN_OBJECTS_LIMIT
```
    Default setting for the minObjectsLimit property is 1.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_OBJECTS_LIMIT
```
public static final int DEFAULT_MAX_OBJECTS_LIMIT
```
    Default setting for the maxObjectsLimit property is 1000000.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_STOP_ROBOT_WHEN_MAX_OBJECT
```
public static final boolean DEFAULT_STOP_ROBOT_WHEN_MAX_OBJECT
```
    Default setting for stopRobotWhenMaxEntity property is false.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_EMAILS
```
public static final int DEFAULT_MAX_EMAILS
```
    Default setting for maxEmails property is -1 (no limit).
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_JAVA_SCRIPT_INSTRUCTIONS
```
public static final int DEFAULT_MAX_JAVA_SCRIPT_INSTRUCTIONS
```
    Default setting for maxJavaScriptInstructions property is -1 (no limit).
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_HTTP_REQUESTS
```
public static final int DEFAULT_MAX_HTTP_REQUESTS
```
    Default setting for maxHttpRequests property is -1 (no limit).
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_LOADED_BYTES
```
public static final int DEFAULT_MAX_LOADED_BYTES
```
    Default setting for maxLoadedBytes property is -1 (no limit).
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_EXECUTED_STEPS
```
public static final int DEFAULT_MAX_EXECUTED_STEPS
```
    Default setting for maxExecutedSteps property is -1 (no limit).
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CommonRobotEnvironment
```
public CommonRobotEnvironment()
```
    Creates a CommonRobotEnvironment where the totalTimeLimit is set to 86400 (24 hours), objectTimeLimit is set to 600 (10 minutes), minObjectsLimit is set to 1, and maxObjectsLimit is set to 1000000 (one million).
  - CommonRobotEnvironment
```
public CommonRobotEnvironment(boolean bypassObjectRefinder,
                              int totalTimeLimit,
                              int objectTimeLimit,
                              int minObjectsLimit,
                              int maxObjectsLimit)
```
    Creates a CommonRobotEnvironment with the specified property values.
    
    Parameters:
    
    bypassObjectRefinder - whether the Object Refinder tag should be ignored.
    
    totalTimeLimit - the total time limit.
    
    objectTimeLimit - the object time limit.
    
    minObjectsLimit - the minimum number of extracted objects limit.
    
    maxObjectsLimit - the maximum number of extracted objects limit.
  - CommonRobotEnvironment
```
public CommonRobotEnvironment(boolean bypassObjectRefinder,
                              int totalTimeLimit,
                              int objectTimeLimit,
                              int minObjectsLimit,
                              int maxObjectsLimit,
                              boolean stopRobotWhenMaxObject,
                              int maxEmails,
                              int maxJavaScriptInstructions,
                              int maxHttpRequests,
                              int maxLoadedBytes,
                              int maxExecutedSteps,
                              boolean stopOnAPIException,
                              boolean stopIfConnectionLost)
```
    Creates a CommonRobotEnvironment with the specified property values.
    
    Parameters:
    
    bypassObjectRefinder - whether the Object Refinder step should be ignored.
    
    totalTimeLimit - the total time limit. -1 to ignore
    
    objectTimeLimit - the object time limit. -1 to ignore
    
    minObjectsLimit - the minimum number of extracted objects limit.
    
    maxObjectsLimit - the maximum number of extracted objects limit, -1 to ignore
    
    stopRobotWhenMaxObject - true if the robot should be stopped when the maximum number of returned objects is reached.
    
    maxEmails - the maximum number of emails the robot is allowed to send, or -1 if there is no limit.
    
    maxJavaScriptInstructions - the maximum number of JavaScripts instruction the robot is allowed to execute, or -1 if there is no limit.
    
    maxHttpRequests - the maximum number of HTTP requests the robot is allowed to perform, or -1 if there is no limit.
    
    maxLoadedBytes - the maximum number of bytes the robot is allowed to load, or -1 if there is no limit.
    
    maxExecutedSteps - the maximum number of steps the robot is allowed to execute, or -1 if there is no limit.
    
    stopOnAPIException - if true the robot will be stopped if RoboServer looses connection to the client
    
    stopIfConnectionLost - if true the robot will be stopped after the first API exception is returned by the robot
- Method Detail
  - getBypassObjectRefinder
```
public boolean getBypassObjectRefinder()
```
    Returns whether the robot shall bypass the Object Refinder tag. See the RoboSuite help for details on this setting. Defaults to false.
    
    Returns:
    
    whether the robot shall bypass the Object Refinder tag.
  - getTotalTimeLimit
```
public int getTotalTimeLimit()
```
    Returns the total time limit.
    
    Returns:
    
    the total time limit.
  - getObjectTimeLimit
```
public int getObjectTimeLimit()
```
    Returns the object time limit.
    
    Returns:
    
    the object time limit.
  - getMinObjectsLimit
```
public int getMinObjectsLimit()
```
    Returns the minimum objects limit.
    
    Returns:
    
    the minimum objects limit.
  - getMaxObjectsLimit
```
public int getMaxObjectsLimit()
```
    Returns the maximum objects limit.
    
    Returns:
    
    the maximum objects limit.
  - getStopRobotWhenMaxObject
```
public boolean getStopRobotWhenMaxObject()
```
    Returns true if the robot should be stopped when the maximum number of returned objects is reached. If false the robot will log a warning message.
    
    Returns:
    
    true if the robot should be stopped when the maximum number of returned objects is reached.
    
    See Also:
    
    getMaxObjectsLimit()
  - getMaxEmails
```
public int getMaxEmails()
```
    Returns the maximum number of emails the robot is allowed to send.
    -1 is returned if there is no limit.
    
    Returns:
    
    the maximum number of emails the robot is allowed to send.
  - getMaxJavaScriptInstructions
```
public int getMaxJavaScriptInstructions()
```
    Returns the maximum number of JavaScripts instruction the robot is allowed to execute.
    -1 is returned if there is no limit.
    
    Returns:
    
    the maximum number of JavaScripts instruction the robot is allowed to execute.
  - getMaxHttpRequests
```
public int getMaxHttpRequests()
```
    Returns the maximum number of HTTP requests the robot is allowed to perform.
    -1 is returned if there is no limit.
    
    Returns:
    
    the maximum number of HTTP requests the robot is allowed to perform.
  - getMaxLoadedBytes
```
public int getMaxLoadedBytes()
```
    Returns the maximum number of bytes the robot is allowed to load.
    -1 is returned if there is no limit.
    
    Returns:
    
    the maximum number of bytes the robot is allowed to load.
  - getMaxExecutedSteps
```
public int getMaxExecutedSteps()
```
    Returns the maximum number of steps the robot is allowed to execute. -1 is returned if there is no limit.
    
    Returns:
    
    the maximum number of steps the robot is allowed to execute.
  - getStopOnAPIException
```
public boolean getStopOnAPIException()
```
    get the value of the stopRobotOnAPIException property
    
    Returns:
    
    true if the robot should be stopped after the first api exception, false if the robot should continue even if API exceptions are encountered
  - getStopIfConnectionLost
```
public boolean getStopIfConnectionLost()
```
    get the value of the stopIfClientDies property
    
    Returns:
    
    true if RoboServer should stop the robot if it looses connection to the client
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Returns true if this object and the specified object have the same property values, and false otherwise.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    obj - the object to test for equality.
    
    Returns:
    
    true if this object and the specified object have the same property values, and false otherwise.
  - hashCode
```
public int hashCode()
```
    Returns the hash code of this object based on property values.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    the hash code of this object based on property values.
  - toString
```
public java.lang.String toString()
```
    Returns a human readable string representation of this object.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a human readable string representation of this object.

Class CommonRobotEnvironment

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_BYPASS_OBJECT_REFINDER

DEFAULT_TOTAL_TIME_LIMIT

DEFAULT_OBJECT_TIME_LIMIT

DEFAULT_MIN_OBJECTS_LIMIT

DEFAULT_MAX_OBJECTS_LIMIT

DEFAULT_STOP_ROBOT_WHEN_MAX_OBJECT

DEFAULT_MAX_EMAILS

DEFAULT_MAX_JAVA_SCRIPT_INSTRUCTIONS

DEFAULT_MAX_HTTP_REQUESTS

DEFAULT_MAX_LOADED_BYTES

DEFAULT_MAX_EXECUTED_STEPS

Constructor Detail

CommonRobotEnvironment

CommonRobotEnvironment

CommonRobotEnvironment

Method Detail

getBypassObjectRefinder

getTotalTimeLimit

getObjectTimeLimit

getMinObjectsLimit

getMaxObjectsLimit

getStopRobotWhenMaxObject

getMaxEmails

getMaxJavaScriptInstructions

getMaxHttpRequests

getMaxLoadedBytes

getMaxExecutedSteps

getStopOnAPIException

getStopIfConnectionLost

equals

hashCode

toString