com.quinncurtis.spcchartjava
Class SPCControlLimitAlarmArgs

java.lang.Object
  com.quinncurtis.spcchartjava.SPCControlLimitAlarmArgs

public class SPCControlLimitAlarmArgs
extends java.lang.Object

This class is used to pass event information to a SPCControlLimitAlarmEventDelegate alarm processing delegate.

Constructor Summary

SPCControlLimitAlarmArgs()
The default SPCControlLimitAlarmArgs constructor.

SPCControlLimitAlarmArgs(SPCCalculatedValueRecord pv, SPCControlLimitRecord alarm, int channel)
This constructor creates a SPCControlLimitAlarmArgs object that is used to pass data associated with alarm events.

Method Summary

void	copy(SPCControlLimitAlarmArgs source) Copies the source SPCControlLimitAlarmArgs object.
int	errorCheck(int nerror) Checks the SPCControlLimitAlarmArgs object for common errors.
int	getAlarmChannel() Get the alarm channel associated with the alarm.
SPCControlLimitRecord	getEventAlarm() Get the SPCControlLimitRecord object.
SPCCalculatedValueRecord	getSPCSource() Get the SPCCalculatedValueRecord object associated with the alarm.
void	setAlarmChannel(int value) Set the alarm channel associated with the alarm.
void	setEventAlarm(SPCControlLimitRecord value) Set the SPCControlLimitRecord object.
void	setSPCSource(SPCCalculatedValueRecord value) Set the SPCCalculatedValueRecord object associated with the alarm.

Methods inherited from class java.lang.Object

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

Constructor Detail

SPCControlLimitAlarmArgs

public SPCControlLimitAlarmArgs()

The default SPCControlLimitAlarmArgs constructor.

SPCControlLimitAlarmArgs

public SPCControlLimitAlarmArgs(SPCCalculatedValueRecord pv,
                                SPCControlLimitRecord alarm,
                                int channel)

This constructor creates a SPCControlLimitAlarmArgs object that is used to pass data associated with alarm events.

Parameters:

pv - The SPCCalculatedValueRecord object associated with the alarm event.

alarm - The SPCControlLimitRecord object associated with the alarm event.

channel - The channel number associated with the alarm event.

Method Detail

copy

public void copy(SPCControlLimitAlarmArgs source)

Copies the source SPCControlLimitAlarmArgs object.

Parameters:

source - The source SPCControlLimitAlarmArgs object.

errorCheck

public int errorCheck(int nerror)

Checks the SPCControlLimitAlarmArgs object for common errors.

Parameters:

nerror - Current error state.

Returns:

Returns an error code.

getAlarmChannel

public int getAlarmChannel()

Get the alarm channel associated with the alarm.

getEventAlarm

public SPCControlLimitRecord getEventAlarm()

Get the SPCControlLimitRecord object.

getSPCSource

public SPCCalculatedValueRecord getSPCSource()

Get the SPCCalculatedValueRecord object associated with the alarm.

setAlarmChannel

public void setAlarmChannel(int value)

Set the alarm channel associated with the alarm.

setEventAlarm

public void setEventAlarm(SPCControlLimitRecord value)

Set the SPCControlLimitRecord object.

setSPCSource

public void setSPCSource(SPCCalculatedValueRecord value)

Set the SPCCalculatedValueRecord object associated with the alarm.