Package jmri

Class ConditionalVariable

java.lang.Object

jmri.ConditionalVariable

public class ConditionalVariable
extends Object

The variable used in the antecedent (the 'if' part) of the Conditional. proposition. The states of ConditionalVariables and logic expression of the antecedent determine the state of the Conditional.

ConditionalVariable objects are fully mutable, so use the default equals() operator that checks for identical objects, not identical contents. This file is part of JMRI.

JMRI is free software; you can redistribute it and/or modify it under the terms of version 2 of the GNU General Public License as published by the Free Software Foundation. See the "COPYING" file for a copy of this license.

JMRI is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	EQUAL
static final int	GREATER_THAN
static final int	GREATER_THAN_OR_EQUAL
static final int	LESS_THAN
static final int	LESS_THAN_OR_EQUAL
protected NamedBeanHandleManager	nbhm
static final int	NUM_COMPARE_OPERATIONS
(package private) static final ResourceBundle	rbx

Constructor Summary

Constructors

Constructor	Description
ConditionalVariable()	Create a blank ConditionalVariable, to be filled in later.
ConditionalVariable(boolean not, Conditional.Operator opern, Conditional.Type type, String name, boolean trigger)	Create a ConditionalVariable with a set of given properties.

Method Summary

Modifier and Type	Method	Description
(package private) boolean	compare(String value1, String value2, boolean caseInsensitive)	Compare two values using the comparator set using the comparison instructions in setNum1(int).
boolean	doTriggerActions()	If change of state of this object causes a change of state of the Conditional, should any actions be executed.
boolean	evaluate()	Evaluates this State Variable.
static int	fixMidnight(int time)
NamedBean	getBean()
static String	getCompareOperationString(int index)
static String	getCompareSymbols(int index)
String	getDataString()
String	getGuiName()
static String	getItemTypeString(Conditional.ItemType t)	Convert Variable Type to Text String
String	getName()
NamedBeanHandle<?>	getNamedBean()
NamedBean	getNamedBeanData()
int	getNum1()	Get Data 1.
int	getNum2()	Get Data 2.
Conditional.Operator	getOpern()
String	getOpernString()	Provide a localized text for screen display of the logic operator.
int	getState()
String	getTestTypeString()
Conditional.Type	getType()
boolean	isNegated()
void	setDataString(String data)
void	setGuiName(String guiName)	Set the GUI name for the conditional state variable.
void	setName(String name)
void	setNegation(boolean not)
void	setNum1(int num)	Set Data 1.
void	setNum2(int num)	Set Data 2.
final void	setOpern(Conditional.Operator opern)
void	setState(boolean state)
void	setState(int state)
void	setTriggerActions(boolean trigger)
void	setType(Conditional.Type type)
static Conditional.Type	stringToVariableTest(String str)	Identify action Data from Text String.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

rbx

static final ResourceBundle rbx

NUM_COMPARE_OPERATIONS

public static final int NUM_COMPARE_OPERATIONS

See Also:

• Constant Field Values

LESS_THAN

public static final int LESS_THAN

See Also:

• Constant Field Values

LESS_THAN_OR_EQUAL

public static final int LESS_THAN_OR_EQUAL

See Also:

• Constant Field Values

EQUAL

public static final int EQUAL

See Also:

• Constant Field Values

GREATER_THAN_OR_EQUAL

public static final int GREATER_THAN_OR_EQUAL

See Also:

• Constant Field Values

GREATER_THAN

public static final int GREATER_THAN

See Also:

• Constant Field Values

nbhm

protected NamedBeanHandleManager nbhm

Constructor Details

ConditionalVariable

public ConditionalVariable()

Create a blank ConditionalVariable, to be filled in later.

ConditionalVariable

public ConditionalVariable(boolean not,
 @Nonnull
 Conditional.Operator opern,
 @Nonnull
 Conditional.Type type,
 String name,
 boolean trigger)

Create a ConditionalVariable with a set of given properties.

Parameters:

not - true if the ConditionalVariable should be negated

opern - the boolean operator for this ConditionalVariable

type - the type this ConditionalVariable operates on (Turnout, Sensor, ...)

name - the device name

trigger - true if actions should be performed if triggered

Method Details

isNegated

public boolean isNegated()

setNegation

public void setNegation(boolean not)

getOpern

@Nonnull
public Conditional.Operator getOpern()

setOpern

public final void setOpern(@Nonnull
 Conditional.Operator opern)

getType

@Nonnull
public Conditional.Type getType()

setType

public void setType(@Nonnull
 Conditional.Type type)

getName

public String getName()

setName

public void setName(String name)

getNamedBean

@CheckForNull
public NamedBeanHandle<?> getNamedBean()

getBean

@CheckForNull
public NamedBean getBean()

getDataString

public String getDataString()

setDataString

public void setDataString(@CheckForNull
 String data)

getNamedBeanData

@CheckForNull
public NamedBean getNamedBeanData()

getNum1

public int getNum1()

Get Data 1. Used for Fast Clock Start time, and value for Memory expression type, e.g. LESS_THAN or GREATER_THAN

Returns:

value for Data 1.

setNum1

public void setNum1(int num)

Set Data 1. Used for Fast Clock Start time and Memoey expression operator value.

Parameters:

num - the value.

getNum2

public int getNum2()

Get Data 2. Used for Fast Clock Finish time.

Returns:

value for Data 2.

setNum2

public void setNum2(int num)

Set Data 2. Used for Fast Clock Finish time.

Parameters:

num - the value.

getGuiName

public String getGuiName()

Returns:

the GUI name for the referenced conditional.

Since:

4.7.4

setGuiName

public void setGuiName(String guiName)

Set the GUI name for the conditional state variable.

Parameters:

guiName - The referenced Conditional user name.

Since:

4.7.4

doTriggerActions

public boolean doTriggerActions()

If change of state of this object causes a change of state of the Conditional, should any actions be executed.

Returns:

true if actions should be performed if triggered

setTriggerActions

public void setTriggerActions(boolean trigger)

getState

public int getState()

setState

public void setState(int state)

setState

public void setState(boolean state)

getTestTypeString

public String getTestTypeString()

getOpernString

@Nonnull
public String getOpernString()

Provide a localized text for screen display of the logic operator.

Returns:

translated string (from jmri.NamedBeanBundle.properties)

evaluate

public boolean evaluate()

Evaluates this State Variable.

Returns:

true if variable evaluates true, otherwise false.

compare

boolean compare(@CheckForNull
 String value1,
 @CheckForNull
 String value2,
 boolean caseInsensitive)

Compare two values using the comparator set using the comparison instructions in setNum1(int). Note: getNum1() must be one of LESS_THAN, LESS_THAN_OR_EQUAL, EQUAL, GREATER_THAN_OR_EQUAL, or GREATER_THAN.

Parameters:

value1 - left side of the comparison

value2 - right side of the comparison

caseInsensitive - true if comparison should be case insensitive; false otherwise

Returns:

true if values compare per getNum1(); false otherwise

fixMidnight

public static int fixMidnight(int time)

getItemTypeString

@Nonnull
public static String getItemTypeString(@Nonnull
 Conditional.ItemType t)

Convert Variable Type to Text String

Parameters:

t - the type

Returns:

the localized description

getCompareOperationString

@Nonnull
public static String getCompareOperationString(int index)

getCompareSymbols

@Nonnull
public static String getCompareSymbols(int index)

stringToVariableTest

@Nonnull
public static Conditional.Type stringToVariableTest(@Nonnull
 String str)

Identify action Data from Text String.

Parameters:

str - the text to check

Returns:

the conditional action type or -1 if if string does not correspond to an action Data as defined in ConditionalAction

toString

public String toString()

Overrides:

toString in class Object