Package jmri.jmrix.can.cbus.node

Class CbusNodeFromBackup

java.lang.Object

jmri.jmrix.can.cbus.node.CbusBasicNode

jmri.jmrix.can.cbus.node.CbusBasicNodeWithManagers

jmri.jmrix.can.cbus.node.CbusBasicNodeWithMgrsCommandStation

jmri.jmrix.can.cbus.node.CbusNode

jmri.jmrix.can.cbus.node.CbusNodeFromBackup

All Implemented Interfaces:

java.lang.Comparable<CbusNodeFromBackup>

public class CbusNodeFromBackup
extends CbusNode
implements java.lang.Comparable<CbusNodeFromBackup>

Class to represent a node imported from FCU file or CbusNodeXml.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	CbusNodeFromBackup.DoNothingCanListener	Ignores Incoming and Outgoing CAN Frames.

Field Summary

Fields inherited from class jmri.jmrix.can.cbus.node.CbusNode

BOOT_LONG_TIMEOUT_TIME, BOOT_PROG_TIMEOUT_FAST, BOOT_PROG_TIMEOUT_SLOW, SINGLE_MESSAGE_TIMEOUT_TIME

Fields inherited from class jmri.jmrix.can.cbus.node.CbusBasicNodeWithManagers

_fwBuild, _fwMaj, _fwMin

Fields inherited from class jmri.jmrix.can.cbus.node.CbusBasicNode

_listeners, _memo, send

Constructor Summary

Constructors

Constructor	Description
CbusNodeFromBackup(CanSystemConnectionMemo connmemo, int nodenumber)	Create a new CbusNodeFrommBackup by connection type and Node Number
CbusNodeFromBackup(CbusNode node, java.util.Date timeStamp)	Create a new CbusNodeFrommBackup from an existing Node

Method Summary

Modifier and Type	Method	Description
void	addBupEvent(int nn, int en, java.lang.String evVars)	Add an event to the Node in backup format
int	compareTo(CbusNodeFromBackup o)	Compares to the Time Date Stamp of the Backup
java.lang.String	compareWithString(CbusNodeFromBackup toTest)	Get a String comparison with another CbusNodeFromBackup
boolean	equals(java.lang.Object obj)
java.lang.String	getBackupComment()	Get the Backup Comment eg.
CbusNodeConstants.BackupType	getBackupResult()	Get the Backup Result
java.util.Date	getBackupTimeStamp()	Get the Backup DateTime
int	getEventArrayHash()	Get a Hashcode for the Event Array
CbusNodeCanListener	getNewCanListener()	Ignores incoming and outgoing CAN Frames
int	hashCode()
void	setBackupComment(java.lang.String backupComment)	Set the backup comment
protected void	setBackupResult(CbusNodeConstants.BackupType type)	Set the Backup Result
protected void	setBackupTimeStamp(java.util.Date thisDate)	Set the Backup DateTime
java.lang.String	toString()	toString reports the Node Number Name and backup timestamp

Methods inherited from class jmri.jmrix.can.cbus.node.CbusNode

getliveUpdate, getName, getNodeFlags, getNodeNameFromName, getnvWriteInLearnOnly, getResyncName, getsendsWRACKonNVSET, getUserComment, nodeOnNetwork, resetNodeAll, saveForResync, setliveUpdate, setNameIfNoName, setNodeFlags, setNodeNameFromName, setnvWriteInLearnOnly, setsendsWRACKonNVSET, setUserComment

Methods inherited from class jmri.jmrix.can.cbus.node.CbusBasicNodeWithMgrsCommandStation

getCsNum, getStatResponseFlagsAccurate, setCsFlags, setCsNum, setStatResponseFlagsAccurate

Methods inherited from class jmri.jmrix.can.cbus.node.CbusBasicNodeWithManagers

dispose, getCanListener, getNodeBackupManager, getNodeEventManager, getNodeNvManager, getNodeParamManager, getNodeStats, getNodeTimerManager, getPnnManufacturer, getPnnModule, getTableModel, getUserName, setFW, setManuModule, setTableModel, setUserName

Methods inherited from class jmri.jmrix.can.cbus.node.CbusBasicNode

addPropertyChangeListener, getMemo, getNodeCanId, getNodeInFLiMMode, getNodeInLearnMode, getNodeInSetupMode, getNodeNumber, notifyPropertyChangeListener, removePropertyChangeListener, setCanId, setCanId, setNodeInFLiMMode, setNodeInLearnMode, setNodeInSetupMode, setNodeNumber

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CbusNodeFromBackup

public CbusNodeFromBackup(CanSystemConnectionMemo connmemo,
                          int nodenumber)

Create a new CbusNodeFrommBackup by connection type and Node Number

Parameters:

connmemo - CAN Connection

nodenumber - Node Number between 1 and 65535

CbusNodeFromBackup

public CbusNodeFromBackup(CbusNode node,
                          java.util.Date timeStamp)

Create a new CbusNodeFrommBackup from an existing Node

Parameters:

node - The Node to make a copy of

timeStamp - to set the Backup TimeStamp

Method Detail

getNewCanListener

public CbusNodeCanListener getNewCanListener()

Ignores incoming and outgoing CAN Frames

Overrides:

getNewCanListener in class CbusBasicNodeWithManagers

setBackupTimeStamp

protected void setBackupTimeStamp(java.util.Date thisDate)

Set the Backup DateTime

Parameters:

thisDate - Timestamp

getBackupTimeStamp

public java.util.Date getBackupTimeStamp()

Get the Backup DateTime

Returns:

DateTime in format

setBackupResult

protected final void setBackupResult(CbusNodeConstants.BackupType type)

Set the Backup Result

Parameters:

type - Backup Type Enum

getBackupResult

public final CbusNodeConstants.BackupType getBackupResult()

Get the Backup Result

Returns:

enum

setBackupComment

public void setBackupComment(java.lang.String backupComment)

Set the backup comment

Parameters:

backupComment - text representation of the single backup state

getBackupComment

public java.lang.String getBackupComment()

Get the Backup Comment eg. Completed No Issues, 9 NVs, 12 Events with 4 EVs

Returns:

index number, -1 if unset

addBupEvent

public void addBupEvent(int nn,
                        int en,
                        java.lang.String evVars)

Add an event to the Node in backup format

Parameters:

nn - Event Node Number

en - Event Event Number

evVars - Event Variable Hex String eg. "0102DC3AFF"

compareWithString

public java.lang.String compareWithString(CbusNodeFromBackup toTest)

Get a String comparison with another CbusNodeFromBackup

Parameters:

toTest - The CbusNodeFromBackup to test against

Returns:

eg. "Parameters Changed"

compareTo

public int compareTo(CbusNodeFromBackup o)

Compares to the Time Date Stamp of the Backup

Specified by:

compareTo in interface java.lang.Comparable<CbusNodeFromBackup>

equals

public boolean equals(java.lang.Object obj)

Used for highlighting changes to Node Backups, so the Date Time Stamp does NOT need to be equal. checking for Node Number, Parameters, NVs, Events. Events can be in any order, are sorted mid comparison.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getEventArrayHash

public int getEventArrayHash()

Get a Hashcode for the Event Array

Returns:

0 if event array null

toString

public java.lang.String toString()

toString reports the Node Number Name and backup timestamp

Overrides:

toString in class CbusNode

Returns:

string eg "1234 UserName Backup Sun Jul 07 22:41:22". string eg "1234 UserName" or "256 CANPAN" if no UserName. No trailing space.