TurtleKit.Option (TurtleKit 3.0.0.4)

java.lang.Object
- java.lang.Enum<TurtleKit.Option>
- - turtlekit.kernel.TurtleKit.Option

All Implemented Interfaces:

Serializable, Comparable<TurtleKit.Option>

Enclosing class:

TurtleKit
```
public static enum TurtleKit.Option
extends Enum<TurtleKit.Option>
```

Enum Constant Summary

Enum Constants
Enum Constant and Description
`community` Specify the name of the community which should be used.
`cuda` If set to `true`, TurtleKit will try to use Nvidia Cuda for computing pheromones dynamics and random numbers, thus optimizing the simulation performances, especially when several pheromones are used.
`endTime` Specify the time at which the simulation should stop and quit
`envDimension` Should be used like this on the command line: --envDimension 100,100
`envHeight`
`environment` Specify the environment class which has to be used.
`envWidth`
`fastRendering` If set to `true`, viewers will be launched in asynchronous display mode : faster viewing
`launcher` Specify the launcher agent class which has to be used.
`model` Could be used to specify a .mdk properties file that will be used to automatically launch a TK simulation.
`noWrap` If set to `true`, the world is not wrapped.
`patch` Specify the patch class that should be used for creating the environment's grid.
`renderingInterval` Set the rendering interval time, e.g.
`scheduler` Specify the scheduler class which has to be used.
`startSimu` If set to `true`, the simulation is started automatically.
`turtles` Used to launch turtles.
`viewers` Specify the viewer classes to launch.

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`toString()`
`static TurtleKit.Option`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static TurtleKit.Option[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

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

- Enum Constant Detail
  - turtles
```
public static final TurtleKit.Option turtles
```
    Used to launch turtles. This option can be used from the command line or using the main method of TurtleKit.
```
 SYNOPSIS
 
```
    --turtles TURTLE_CLASS_NAME[,NB][;OTHERS]
    - TURTLE_CLASS_NAME: the turtle class to launch
    - NB (integer optional): number of desired instances
```
 DESCRIPTION
 
```
    The optional parameters could be used to (1) launch several different types of turtles and (2) specify the number of desired instances of each type.
```
 DEFAULT VALUE100000
 
```
    Default value is "null", meaning that no turtle has to be launched.
    Default values for the optional parameters are
    - NB : 1
```
 EXAMPLES
 
```
    - --turtles myPackage.MyTurtle
    - --turtles myPackage.MyTurtle,2000
    - --turtles myPackage.MyTurtle,30000;other.OtherTurtle,40000
  - envWidth
```
public static final TurtleKit.Option envWidth
```
  - envHeight
```
public static final TurtleKit.Option envHeight
```
  - envDimension
```
public static final TurtleKit.Option envDimension
```
    Should be used like this on the command line: --envDimension 100,100
  - model
```
public static final TurtleKit.Option model
```
    Could be used to specify a .mdk properties file that will be used to automatically launch a TK simulation.
  - community
```
public static final TurtleKit.Option community
```
    Specify the name of the community which should be used. If not specified, the name of the model is used instead.
  - noWrap
```
public static final TurtleKit.Option noWrap
```
    If set to true, the world is not wrapped. Default value is false
  - launcher
```
public static final TurtleKit.Option launcher
```
    Specify the launcher agent class which has to be used.
  - environment
```
public static final TurtleKit.Option environment
```
    Specify the environment class which has to be used. Default is Environment
  - scheduler
```
public static final TurtleKit.Option scheduler
```
    Specify the scheduler class which has to be used. Default is TKScheduler
  - startSimu
```
public static final TurtleKit.Option startSimu
```
    If set to true, the simulation is started automatically. Default is Environment
  - viewers
```
public static final TurtleKit.Option viewers
```
    Specify the viewer classes to launch. If set to null, no viewer will be launched. Several viewers could be set by separating their name with a ";"
  - patch
```
public static final TurtleKit.Option patch
```
    Specify the patch class that should be used for creating the environment's grid. Default is "turtlekit.kernel.Patch", that is Patch.
  - fastRendering
```
public static final TurtleKit.Option fastRendering
```
    If set to true, viewers will be launched in asynchronous display mode : faster viewing
  - renderingInterval
```
public static final TurtleKit.Option renderingInterval
```
    Set the rendering interval time, e.g. --renderingInterval 500
  - cuda
```
public static final TurtleKit.Option cuda
```
    If set to true, TurtleKit will try to use Nvidia Cuda for computing pheromones dynamics and random numbers, thus optimizing the simulation performances, especially when several pheromones are used. This requires the Cuda toolkit to be installed on the host. See https://developer.nvidia.com/cuda-downloads for more information
  - endTime
```
public static final TurtleKit.Option endTime
```
    Specify the time at which the simulation should stop and quit
- Method Detail
  - values
```
public static TurtleKit.Option[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (TurtleKit.Option c : TurtleKit.Option.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static TurtleKit.Option valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    name - the name of the enum constant to be returned.
    
    Returns:
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Enum<TurtleKit.Option>

Enum TurtleKit.Option

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

turtles

envWidth

envHeight

envDimension

model

community

noWrap

launcher

environment

scheduler

startSimu

viewers

patch

fastRendering

renderingInterval

cuda

endTime

Method Detail

values

valueOf

toString