Package jmri.jmrix.can.cbus

Enum CbusFilterType

java.lang.Object

java.lang.Enum<CbusFilterType>

jmri.jmrix.can.cbus.CbusFilterType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CbusFilterType>

public enum CbusFilterType
extends java.lang.Enum<CbusFilterType>

ENUM to represent various CBUS OPC Filters.

Enum Constant Summary

Enum Constants

Enum Constant	Description
CFACDAT
CFARDAT
CFCABDAT
CFCLOCK
CFCS
CFCSAQRL
CFCSC
CFCSDSPD
CFCSFUNC
CFCSKA
CFCSLC
CFCSPROG
CFDATA
CFDDES
CFDDRS
CFED0
CFED1
CFED2
CFED3
CFEVENT
CFEVENTMAX
CFEVENTMIN
CFEXTRTR
CFIN
CFLONG
CFMISC
CFNDCONFIG
CFNDEV
CFNDNUM
CFNDSETUP
CFNDVAR
CFNETWK
CFNODE
CFNODEMAX
CFNODEMIN
CFNODES
CFOF
CFON
CFOTHER
CFOUT
CFREQUEST
CFRESPONSE
CFRQDAT
CFRQDDS
CFSHORT
CFSTD
CFUNKNOWN

Method Summary

Modifier and Type	Method	Description
int	action(AbstractMessage m, CbusFilter cf)	Perform Filter check for a particular message.
static java.util.EnumSet<CbusFilterType>	allFilters(int opc)	Get All Filters for a particular OPC
boolean	alwaysDisplay()	Should the Filter always be displayed?
CbusFilterType	getCategory()	Get Filter Category
static java.util.EnumSet<CbusFilterType>	getCatHeads()	Get an EnumSet of Category Heads
java.lang.String	getName()	Get Filter Name
java.lang.String	getToolTip()	Get ToolTip Text for the Filter
boolean	isCategoryHead()	Is the Filter a parent of a category?
boolean	showSpinners()	Get if the Filter needs to display a number spinner
static CbusFilterType	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static CbusFilterType[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CFIN

public static final CbusFilterType CFIN

CFOUT

public static final CbusFilterType CFOUT

CFEVENT

public static final CbusFilterType CFEVENT

CFEVENTMIN

public static final CbusFilterType CFEVENTMIN

CFEVENTMAX

public static final CbusFilterType CFEVENTMAX

CFON

public static final CbusFilterType CFON

CFOF

public static final CbusFilterType CFOF

CFSHORT

public static final CbusFilterType CFSHORT

CFLONG

public static final CbusFilterType CFLONG

CFSTD

public static final CbusFilterType CFSTD

CFREQUEST

public static final CbusFilterType CFREQUEST

CFRESPONSE

public static final CbusFilterType CFRESPONSE

CFED0

public static final CbusFilterType CFED0

CFED1

public static final CbusFilterType CFED1

CFED2

public static final CbusFilterType CFED2

CFED3

public static final CbusFilterType CFED3

CFNODE

public static final CbusFilterType CFNODE

CFNODEMIN

public static final CbusFilterType CFNODEMIN

CFNODEMAX

public static final CbusFilterType CFNODEMAX

CFNODES

public static final CbusFilterType CFNODES

CFDATA

public static final CbusFilterType CFDATA

CFACDAT

public static final CbusFilterType CFACDAT

CFDDES

public static final CbusFilterType CFDDES

CFRQDAT

public static final CbusFilterType CFRQDAT

CFARDAT

public static final CbusFilterType CFARDAT

CFDDRS

public static final CbusFilterType CFDDRS

CFRQDDS

public static final CbusFilterType CFRQDDS

CFCABDAT

public static final CbusFilterType CFCABDAT

CFCS

public static final CbusFilterType CFCS

CFCSAQRL

public static final CbusFilterType CFCSAQRL

CFCSKA

public static final CbusFilterType CFCSKA

CFCSDSPD

public static final CbusFilterType CFCSDSPD

CFCSFUNC

public static final CbusFilterType CFCSFUNC

CFCSPROG

public static final CbusFilterType CFCSPROG

CFCSLC

public static final CbusFilterType CFCSLC

CFCSC

public static final CbusFilterType CFCSC

CFNDCONFIG

public static final CbusFilterType CFNDCONFIG

CFNDSETUP

public static final CbusFilterType CFNDSETUP

CFNDVAR

public static final CbusFilterType CFNDVAR

CFNDEV

public static final CbusFilterType CFNDEV

CFNDNUM

public static final CbusFilterType CFNDNUM

CFMISC

public static final CbusFilterType CFMISC

CFEXTRTR

public static final CbusFilterType CFEXTRTR

CFNETWK

public static final CbusFilterType CFNETWK

CFCLOCK

public static final CbusFilterType CFCLOCK

CFOTHER

public static final CbusFilterType CFOTHER

CFUNKNOWN

public static final CbusFilterType CFUNKNOWN

Method Detail

values

public static CbusFilterType[] 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 (CbusFilterType c : CbusFilterType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CbusFilterType valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

action

public int action(AbstractMessage m,
                  CbusFilter cf)

Perform Filter check for a particular message. Can be overridden by specific filters.

Parameters:

m - CanMessage or CanReply

cf - main CbusFilter instance

Returns:

Filter category which blocked, else -1 or -2 if passed

getName

public final java.lang.String getName()

Get Filter Name

Returns:

Filter Name

getCategory

@CheckForNull
public final CbusFilterType getCategory()

Get Filter Category

Returns:

Filter Category, else null if Category Head

getCatHeads

public static final java.util.EnumSet<CbusFilterType> getCatHeads()

Get an EnumSet of Category Heads

Returns:

set

isCategoryHead

public final boolean isCategoryHead()

Is the Filter a parent of a category?

Returns:

true if category parent

alwaysDisplay

public final boolean alwaysDisplay()

Should the Filter always be displayed?

Returns:

true if category head or in / out filter.

showSpinners

public final boolean showSpinners()

Get if the Filter needs to display a number spinner

Returns:

true to display a spinner

allFilters

@Nonnull
public static final java.util.EnumSet<CbusFilterType> allFilters(int opc)

Get All Filters for a particular OPC

Parameters:

opc - OPC to get Filter List for

Returns:

set of Filters to use for the OPC.

getToolTip

@CheckForNull
public final java.lang.String getToolTip()

Get ToolTip Text for the Filter

Returns:

HMTL list of OPCs with description, may be null if no ToolTip