org.opentrafficsim.trafficcontrol.trafcod

Class Variable

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) 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	newColor Output color (if this is an export variable).
(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.

Method Summary

Modifier and Type	Method and Description
String	getEndSource() Describe the rule that ends this variable.
String	getStartSource() Describe the rule that starts this variable.
short	getStream() Retrieve the stream to which this variable belongs.
String	selectedFieldsToString(EnumSet<PrintFlags> printFlags) Print selected fields.
void	setEndSource(String endSource) Set the description of the rule that ends this variable.
void	setOutput(int outputValue) 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.
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).

newColor

int newColor

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

setOutput

public void setOutput(int outputValue)

Make this variable an output variable and set the output value.

Parameters:

outputValue - int; the output value

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)

Set the description of the rule that starts this variable.

Parameters:

startSource - String; description of the rule that starts this variable

getEndSource

public String getEndSource()

Describe the rule that ends this variable.

Returns:

String

setEndSource

public void setEndSource(String endSource)

Set the description of the rule that ends this variable.

Parameters:

endSource - String; description of the rule that ends this variable

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