Package jmri.jmrix.roco.z21

Class Z21RMBusAddress

java.lang.Object

jmri.jmrix.roco.z21.Z21RMBusAddress

public class Z21RMBusAddress
extends java.lang.Object

Utility Class supporting parsing and testing of addresses for Z21 RMBus

One address format are supported:

• ZSxxxx where: 'S' for sensors,

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static int	MAXSENSORADDRESS
(package private) static int	MINSENSORADDRESS

Method Summary

Modifier and Type	Method	Description
static int	getBitFromSystemName(java.lang.String systemName, java.lang.String prefix)	Public static method to parse a Z21RMBus system name.Note: Bits are numbered from 1.
static java.lang.String	getUserNameFromSystemName(java.lang.String systemName, java.lang.String prefix)	Public static method to check the user name for a valid system name.
static java.lang.String	validateSystemNameFormat(java.lang.String name, Manager<?> manager, java.util.Locale locale)	Validate a system name format.
static Manager.NameValidity	validSystemNameFormat(java.lang.String systemName, char type, java.lang.String prefix)	Public static method to validate system name format.

Methods inherited from class java.lang.Object

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

Field Detail

MINSENSORADDRESS

static final int MINSENSORADDRESS

See Also:

Constant Field Values

MAXSENSORADDRESS

static final int MAXSENSORADDRESS

See Also:

Constant Field Values

Method Detail

getBitFromSystemName

public static int getBitFromSystemName(java.lang.String systemName,
                                       java.lang.String prefix)

Public static method to parse a Z21RMBus system name.Note: Bits are numbered from 1.

Parameters:

systemName - system name.

prefix - system prefix.

Returns:

the hardware address number, return -1 if an error is found

validateSystemNameFormat

public static java.lang.String validateSystemNameFormat(java.lang.String name,
                                                        Manager<?> manager,
                                                        java.util.Locale locale)

Validate a system name format.

Parameters:

name - the name to validate

manager - the manager requesting validation

locale - the locale for user messages

Returns:

name, unchanged

See Also:

Manager.validateSystemNameFormat(java.lang.String, java.util.Locale)

validSystemNameFormat

public static Manager.NameValidity validSystemNameFormat(@Nonnull
                                                         java.lang.String systemName,
                                                         char type,
                                                         java.lang.String prefix)

Public static method to validate system name format. Logging of handled cases no higher than WARN.

Parameters:

systemName - system name.

type - bean type, S for Sensor, T for Turnout.

prefix - system prefix.

Returns:

VALID if system name has a valid format, else return INVALID

getUserNameFromSystemName

public static java.lang.String getUserNameFromSystemName(java.lang.String systemName,
                                                         java.lang.String prefix)

Public static method to check the user name for a valid system name.

Parameters:

systemName - system name.

prefix - system prefix.

Returns:

"" (null string) if the system name is not valid or does not exist