Variable (OTS traffic control 0.12.00 API)

java.lang.Object
- org.opentrafficsim.trafficcontrol.trafcod.Variable

```
class Variable
extends Object
```
Storage for a TrafCOD variable.
Copyright (c) 2013-2016 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Version:

$Revision$, $LastChangedDate$, by $Author$, initial version Oct 5, 2016

Author:

Peter Knoppers

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) org.opentrafficsim.road.network.lane.object.trafficlight.TrafficLightColor`	`color` Output color (if this is an export variable).
`(package private) String`	`endSource` Source of end rule.
`(package private) EnumSet<Flags>`	`flags` Flags.
`(package private) char`	`listPos` Position in the debugging list.
`(package private) String`	`name` Name of this variable (without the traffic stream).
`(package private) int`	`refCount` Number of rules that refer to this variable.
`(package private) String`	`startSource` Source of start rule.
`(package private) short`	`stream` Traffic stream number
`(package private) int`	`timerMax10` Limit value (if this is a timer variable).
`(package private) int`	`updateTime10` Time of last update in tenth of second.
`(package private) int`	`value` The current value.

Constructor Summary

Constructors
Constructor and Description

Variable(String name, short stream)
Construct a new Variable.

Constructors
Constructor and Description
`Variable(String name, short stream)` Construct a new Variable.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addFlag(Flags flag)` Set a flag of this Variable.
`void`	`clearChangedFlag()` Clear the CHANGED flag of this Variable.
`void`	`clearFlag(Flags flag)` Clear one flag.
`org.opentrafficsim.road.network.lane.object.trafficlight.TrafficLightColor`	`getColor()` Retrieve the color for an output Variable.
`String`	`getEndSource()` Describe the rule that ends this variable.
`EnumSet<Flags>`	`getFlags()` Return a safe copy of the flags.
`String`	`getStartSource()` Describe the rule that starts this variable.
`short`	`getStream()` Retrieve the stream to which this variable belongs.
`int`	`getTimerMax()` Retrieve the start value of this timer in units of 0.1 seconds (1 second is represented by the value 10).
`int`	`getValue()` Retrieve the current value of this Variable.
`void`	`incrementReferenceCount()` Increment the reference counter of this variable.
`boolean`	`isDetector()` Report if this Variable is a detector.
`boolean`	`isOutput()` Report whether a change in this variable must be published.
`boolean`	`isTimer()` Report whether this Variable is a timer.
`String`	`selectedFieldsToString(EnumSet<PrintFlags> printFlags)` Print selected fields.
`void`	`setEndSource(String endSource)` Set the description of the rule that ends this variable.
`void`	`setFlag(Flags flag)` Set one flag.
`void`	`setOutput(int colorValue, Set<org.opentrafficsim.road.network.lane.object.trafficlight.TrafficLight> trafficLights)` Make this variable an output variable and set the output value.
`void`	`setStartSource(String startSource)` Set the description of the rule that starts this variable.
`void`	`setTimerMax(int value10)` Set the maximum time of this timer.
`void`	`setValue(int newValue, int timeStamp10)`
`String`	`toString()`

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

- Field Detail
  - flags
```
EnumSet<Flags> flags
```
    Flags.
  - value
```
int value
```
    The current value.
  - timerMax10
```
int timerMax10
```
    Limit value (if this is a timer variable).
  - color
```
org.opentrafficsim.road.network.lane.object.trafficlight.TrafficLightColor color
```
    Output color (if this is an export variable).
  - name
```
final String name
```
    Name of this variable (without the traffic stream).
  - listPos
```
char listPos
```
    Position in the debugging list.
  - stream
```
final short stream
```
    Traffic stream number
  - refCount
```
int refCount
```
    Number of rules that refer to this variable.
  - updateTime10
```
int updateTime10
```
    Time of last update in tenth of second.
  - startSource
```
String startSource
```
    Source of start rule.
  - endSource
```
String endSource
```
    Source of end rule.
- Constructor Detail
  - Variable
```
public Variable(String name,
                short stream)
```
    Construct a new Variable.
    
    Parameters:
    
    name - String; name of the new variable (without the stream number)
    
    stream - short; stream number to which the new Variable is associated
- Method Detail
  - getColor
```
public org.opentrafficsim.road.network.lane.object.trafficlight.TrafficLightColor getColor()
                                                                                    throws Exception
```
    Retrieve the color for an output Variable.
    
    Returns:
    
    int; the color code for this Variable
    
    Throws:
    
    Exception - if this Variable is not an output
  - isOutput
```
public boolean isOutput()
```
    Report whether a change in this variable must be published.
    
    Returns:
    
    boolean; true if this Variable is an output; false if this Variable is not an output
  - isDetector
```
public boolean isDetector()
```
    Report if this Variable is a detector.
    
    Returns:
    
    boolean; true if this Variable is a detector; false if this Variable is not a detector
  - setValue
```
public void setValue(int newValue,
                     int timeStamp10)
```
    Parameters:
    
    newValue - int; the new value of this Variable
    
    timeStamp10 - int; the time stamp of this update
  - getTimerMax
```
public int getTimerMax()
                throws Exception
```
    Retrieve the start value of this timer in units of 0.1 seconds (1 second is represented by the value 10).
    
    Returns:
    
    int; the timerMax10 value
    
    Throws:
    
    Exception
  - getValue
```
public int getValue()
```
    Retrieve the current value of this Variable.
    
    Returns:
    
    int; the value of this Variable
  - setFlag
```
public void setFlag(Flags flag)
```
    Set one flag.
    
    Parameters:
    
    flag - Flags
  - clearFlag
```
public void clearFlag(Flags flag)
```
    Clear one flag.
    
    Parameters:
    
    flag - Flags; the flag to clear
  - isTimer
```
public boolean isTimer()
```
    Report whether this Variable is a timer.
    
    Returns:
    
    boolean; true if this Variable is a timer; false if this variable is not a timer
  - clearChangedFlag
```
public void clearChangedFlag()
```
    Clear the CHANGED flag of this Variable.
  - incrementReferenceCount
```
public void incrementReferenceCount()
```
    Increment the reference counter of this variable. The reference counter counts the number of rules where this variable occurs on the right hand side of the assignment operator.
  - getFlags
```
public EnumSet<Flags> getFlags()
```
    Return a safe copy of the flags.
    
    Returns:
    
    EnumSet<Flags>
  - addFlag
```
public void addFlag(Flags flag)
```
    Set a flag of this Variable.
    
    Parameters:
    
    flag - Flags; the flag to set
  - setOutput
```
public void setOutput(int colorValue,
                      Set<org.opentrafficsim.road.network.lane.object.trafficlight.TrafficLight> trafficLights)
               throws Exception
```
    Make this variable an output variable and set the output value.
    
    Parameters:
    
    colorValue - int; the output value
    
    trafficLights - Set<TrafficLight>; the traffic light that must be update when this output becomes active
    
    Throws:
    
    Exception - when the colorValue is invalid
  - setTimerMax
```
public void setTimerMax(int value10)
                 throws Exception
```
    Set the maximum time of this timer.
    
    Parameters:
    
    value10 - int; the maximum time in 0.1 s
    
    Throws:
    
    Exception - when this Variable is not a timer
  - getStartSource
```
public String getStartSource()
```
    Describe the rule that starts this variable.
    
    Returns:
    
    String
  - setStartSource
```
public void setStartSource(String startSource)
                    throws Exception
```
    Set the description of the rule that starts this variable.
    
    Parameters:
    
    startSource - String; description of the rule that starts this variable
    
    Throws:
    
    Exception - when a start source has already been set
  - getEndSource
```
public String getEndSource()
```
    Describe the rule that ends this variable.
    
    Returns:
    
    String
  - setEndSource
```
public void setEndSource(String endSource)
                  throws Exception
```
    Set the description of the rule that ends this variable.
    
    Parameters:
    
    endSource - String; description of the rule that ends this variable
    
    Throws:
    
    Exception - when an end source has already been set
  - getStream
```
public short getStream()
```
    Retrieve the stream to which this variable belongs.
    
    Returns:
    
    short; the stream to which this variable belongs
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - selectedFieldsToString
```
public String selectedFieldsToString(EnumSet<PrintFlags> printFlags)
```
    Print selected fields.
    
    Parameters:
    
    printFlags - EnumSet<PrintFlags>; the set of fields to print
    
    Returns:
    
    String

Class Variable

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

flags

value

timerMax10

color

name

listPos

stream

refCount

updateTime10

startSource

endSource

Constructor Detail

Variable

Method Detail

getColor

isOutput

isDetector

setValue

getTimerMax

getValue

setFlag

clearFlag

isTimer

clearChangedFlag

incrementReferenceCount

getFlags

addFlag

setOutput

setTimerMax

getStartSource

setStartSource

getEndSource

setEndSource

getStream

toString

selectedFieldsToString