Package org.epics.pvdata.property

Class PVAlarmFactory

java.lang.Object

org.epics.pvdata.property.PVAlarmFactory

All Implemented Interfaces:

PVAlarm

public final class PVAlarmFactory
extends Object
implements PVAlarm

Implementation of PVAlarm.

Author:

mrk

Constructor Summary

Constructors

Constructor	Description
PVAlarmFactory()

Method Summary

Modifier and Type	Method	Description
boolean	attach(PVField pvField)	Attempt to attach to the alarm field.
static PVAlarm	create()	Create a PVAlarm.
void	detach()	Remove attachment to alarm field.
void	get(Alarm alarm)	Get the alarm values from the attached alarm field and write to the specified Alarm.
boolean	isAttached()	Is this attached to an alarm structure?
boolean	set(Alarm alarm)	Set the alarm.

Methods inherited from class java.lang.Object

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

Constructor Detail

PVAlarmFactory

public PVAlarmFactory()

Method Detail

create

public static PVAlarm create()

Create a PVAlarm.

Returns:

the newly created PVAlarm

attach

public boolean attach(PVField pvField)

Description copied from interface: PVAlarm

Attempt to attach to the alarm field. The field must either be an alarm field itself or a subfield of the parent of a field named value.

Specified by:

attach in interface PVAlarm

Parameters:

pvField - the field for which to find an alarm field

Returns:

(false,true) if alarm field (not found, found).

detach

public void detach()

Description copied from interface: PVAlarm

Remove attachment to alarm field.

Specified by:

detach in interface PVAlarm

isAttached

public boolean isAttached()

Description copied from interface: PVAlarm

Is this attached to an alarm structure?

Specified by:

isAttached in interface PVAlarm

Returns:

(false,true) is (not, is) attached to an alarm structure

get

public void get(Alarm alarm)

Description copied from interface: PVAlarm

Get the alarm values from the attached alarm field and write to the specified Alarm.

Specified by:

get in interface PVAlarm

Parameters:

alarm - the Alarm to be updated

set

public boolean set(Alarm alarm)

Description copied from interface: PVAlarm

Set the alarm.

Specified by:

set in interface PVAlarm

Parameters:

alarm - the new value

Returns:

(false,true) if the alarm field is (immutable,updated)