ca.nrc.widar.mccc.crm
Class CrmRecirculatorChip

java.lang.Object
  ca.nrc.widar.mccc.crm.CrmRecirculatorChip

public class CrmRecirculatorChip
extends java.lang.Object

WIDAR/EVLA - CRM: CrmRecirculatorChip Class

A class used to store information pertaining to one of 16 Recirculator chips on board a WIDAR Baseline Board Component. This class is used in the CSD Diagnostic to assist in determining CRC errors on Recirculator chips.

Copyright: National Research Council of Canada and Associated Universities Inc., 2010, 2011, 2012

Since:

1.0

Author:

Dave Del Rizzo (Dave.DelRizzo@nrc.gc.ca)

Field Summary

static java.lang.String	CLASSNAME
static int	N_CHAN
static int	N_CSD_MODES
static int	N_PECHAN
static int	N_TCS
static int	X
static int	Y

Constructor Summary

CrmRecirculatorChip(int ordId, int valId)
The constructor.

Method Summary

void	analyzeCrc()
int	getBbId(int chan) Returns the Baseband ID stored for the specified data channel, or -1 if the data channel ID is out of range.
int	getId()
int	getOrd()
java.lang.String	getRecircId()
int	getSbId(int chan) Returns the Subband ID stored for the specified data channel, or -1 if the data channel ID is out of range.
int	getStId(int chan) Returns the Station ID stored for the specified data channel, or -1 if the data channel ID is out of range.
boolean	getTcsStatus()
boolean	getTcsStatus(int value) Returns the boolean flag corresponding to the supplied TimeCodeSource index, if the TCS index is valid.
boolean	isSetBbId(int chan) Returns a boolean true if the baseband ID is set to a value other than -1 (the initialization default), or false if either the supplied data channel value is invalid or the subband ID is less than 0.
boolean	isSetSbId(int chan) Returns a boolean true if the subband ID is set to a value other than -1 (the initialization default), or false if either the supplied data channel value is invalid or the subband ID is less than 0.
boolean	isSetStId(int chan) Returns a boolean true if the station ID is set to a value other than -1 (the initialization default), or false if either the supplied data channel value is invalid or the subband ID is less than 0.
void	kill() Kills and nullifies all storage variables
void	registerHmReceiverData(ca.nrc.widar.jaxb.crm.CsdModeType mode, int modeId, ca.nrc.widar.jaxb.crm.Recirculator rXml)
void	registerTcs(int value) Sets the boolean flag corresponding to the supplied TimeCodeSource index to true, if the TCS index is valid.
void	setBbId(int chan, int value) Sets the Baseband ID for the specified data channel to the provided value, or makes no change if the data channel ID is out of allowable range.
void	setSbId(int chan, int value) Sets the Subband ID for the specified data channel to the provided value, or makes no change if the data channel ID is out of allowable range.
void	setStId(int chan, int value) Sets the Station ID for the specified data channel to the provided value, or makes no change if the data channel ID is out of allowable range.

Methods inherited from class java.lang.Object

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

Field Detail

CLASSNAME

public static final java.lang.String CLASSNAME

See Also:

Constant Field Values

X

public static final int X

See Also:

Constant Field Values

Y

public static final int Y

See Also:

Constant Field Values

N_CHAN

public static final int N_CHAN

See Also:

Constant Field Values

N_TCS

public static final int N_TCS

See Also:

Constant Field Values

N_PECHAN

public static final int N_PECHAN

See Also:

Constant Field Values

N_CSD_MODES

public static final int N_CSD_MODES

See Also:

Constant Field Values

Constructor Detail

CrmRecirculatorChip

public CrmRecirculatorChip(int ordId,
                           int valId)

The constructor.

Parameters:

xId - The X row ID of this chip within the component

yId - The Y column ID of this chip within the component

Method Detail

kill

public void kill()

Kills and nullifies all storage variables

getOrd

public int getOrd()

Returns:

An integer representing the ordinal part of the chip ID (X=0, Y=1)

getId

public int getId()

Returns:

An integer representing the numerical part of the chip ID (0-7)

getRecircId

public java.lang.String getRecircId()

Returns:

A String representing the ID of the chip

setSbId

public void setSbId(int chan,
                    int value)

Sets the Subband ID for the specified data channel to the provided value, or makes no change if the data channel ID is out of allowable range.

Parameters:

chan - The integer data channel ID (0-7)

value - The integer value for the Subband ID at the specified data channel

getSbId

public int getSbId(int chan)

Returns the Subband ID stored for the specified data channel, or -1 if the data channel ID is out of range.

Parameters:

chan - The integer data channel ID (0-7)

Returns:

The integer subband ID at the specified data channel, -1 if chan is out of range (0-7)

isSetSbId

public boolean isSetSbId(int chan)

Returns a boolean true if the subband ID is set to a value other than -1 (the initialization default), or false if either the supplied data channel value is invalid or the subband ID is less than 0.

Parameters:

chan - The integer data channel ID (0-7)

Returns:

Boolean true if the value is set, false if it is not, or if the channel ID is out of range

setBbId

public void setBbId(int chan,
                    int value)

Sets the Baseband ID for the specified data channel to the provided value, or makes no change if the data channel ID is out of allowable range.

Parameters:

chan - The integer data channel ID (0-7)

value - The integer value for the Baseband ID at the specified data channel

getBbId

public int getBbId(int chan)

Returns the Baseband ID stored for the specified data channel, or -1 if the data channel ID is out of range.

Parameters:

chan - The integer data channel ID (0-7)

Returns:

The integer baseband ID at the specified data channel, -1 if chan is out of range (0-7)

isSetBbId

public boolean isSetBbId(int chan)

Returns a boolean true if the baseband ID is set to a value other than -1 (the initialization default), or false if either the supplied data channel value is invalid or the subband ID is less than 0.

Parameters:

chan - The integer data channel ID (0-7)

Returns:

Boolean true if the value is set, false if it is not, or if the channel ID is out of range

setStId

public void setStId(int chan,
                    int value)

Sets the Station ID for the specified data channel to the provided value, or makes no change if the data channel ID is out of allowable range.

Parameters:

chan - The integer data channel ID (0-7)

value - The integer value for the Station ID at the specified data channel

getStId

public int getStId(int chan)

Returns the Station ID stored for the specified data channel, or -1 if the data channel ID is out of range.

Parameters:

chan - The integer data channel ID (0-7)

Returns:

The integer station ID at the specified data channel, -1 if chan is out of range (0-7)

isSetStId

public boolean isSetStId(int chan)

Returns a boolean true if the station ID is set to a value other than -1 (the initialization default), or false if either the supplied data channel value is invalid or the subband ID is less than 0.

Parameters:

chan - The integer data channel ID (0-7)

Returns:

Boolean true if the value is set, false if it is not, or if the channel ID is out of range

registerTcs

public void registerTcs(int value)

Sets the boolean flag corresponding to the supplied TimeCodeSource index to true, if the TCS index is valid. This indicates that the chip has accumulated data under the supplied TCS index. If the TCS is out of range, no registration takes place

Parameters:

value - The integer value for Time Code Source config

getTcsStatus

public boolean getTcsStatus(int value)

Returns the boolean flag corresponding to the supplied TimeCodeSource index, if the TCS index is valid. This indicates whether or not a chip has accumulated and stored information under the supplied TCS index. If the TCS is out of range, a false is returned.

Parameters:

chan - The integer value for Time Code Source config

Returns:

A boolean true if the chip is accumulated data, false otherwise, false if the supplied TCS is out of range

getTcsStatus

public boolean getTcsStatus()

registerHmReceiverData

public void registerHmReceiverData(ca.nrc.widar.jaxb.crm.CsdModeType mode,
                                   int modeId,
                                   ca.nrc.widar.jaxb.crm.Recirculator rXml)

analyzeCrc

public void analyzeCrc()