xal.smf.impl

Class Klystron

java.lang.Object

xal.smf.impl.Klystron

All Implemented Interfaces:

DataListener

public class Klystron
extends java.lang.Object
implements DataListener

Field Summary

Fields

Modifier and Type	Field and Description
protected Accelerator	accelerator
protected ChannelSuite	channelSuite
static java.lang.String	KLYS_AMP_RB_HANDLE
static java.lang.String	KLYS_AMP_SET_HANDLE
static java.lang.String	KLYS_PHASE_RB_HANDLE
static java.lang.String	KLYS_PHASE_SET_HANDLE
static java.lang.String	s_strType
protected java.lang.String	strId

Constructor Summary

Constructors

Constructor and Description
Klystron(Accelerator anAccelerator) Constructor for Klystron.

Method Summary

Modifier and Type	Method and Description
java.lang.String	dataLabel() dataLabel() provides the name used to identify the class in an external data source.
Channel	findChannel(java.lang.String handle) Find the channel for the specified handle.
Channel	getAndConnectChannel(java.lang.String handle) Get the channel corresponding to the specified handle and connect it.
Channel	getChannel(java.lang.String handle) Get the channel for the specified handle.
ChannelSuite	getChannelSuite() Get the channel suite.
int[]	getControlFlag() Get predefined control flags.
java.lang.String	getId() Get the unique power supply ID
double	getKlysAmp() Get the klystron's amplitude.
double	getKlysPhase() Get the klystron's phase.
int[]	getPowerFact() Get power distribution factors
boolean	getStatus()
java.lang.String	getType() Get the klystron type.
void	setControlFlag(int[] cFlag) Set control flag.
void	setKlysAmp(double newAmp) Set klystron amplitude.
void	setKlysPhase(double newPhase) Set klystron phase.
void	setPowerFact(int[] pFact) Set Power distribution factors.
void	setStatus(boolean stat)
void	update(DataAdaptor adaptor) Update the data based on the information provided by the data provider.
void	write(DataAdaptor adaptor) Write data to the data adaptor for storage.

Methods inherited from class java.lang.Object

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

Field Detail

KLYS_AMP_SET_HANDLE

public static final java.lang.String KLYS_AMP_SET_HANDLE

See Also:

Constant Field Values

KLYS_PHASE_SET_HANDLE

public static final java.lang.String KLYS_PHASE_SET_HANDLE

See Also:

Constant Field Values

KLYS_AMP_RB_HANDLE

public static final java.lang.String KLYS_AMP_RB_HANDLE

See Also:

Constant Field Values

KLYS_PHASE_RB_HANDLE

public static final java.lang.String KLYS_PHASE_RB_HANDLE

See Also:

Constant Field Values

accelerator

protected Accelerator accelerator

channelSuite

protected ChannelSuite channelSuite

strId

protected java.lang.String strId

s_strType

public static final java.lang.String s_strType

See Also:

Constant Field Values

Constructor Detail

Klystron

public Klystron(Accelerator anAccelerator)

Constructor for Klystron.

Parameters:

anAccelerator - the accelerator object this klystron belongs to

Method Detail

dataLabel

public java.lang.String dataLabel()

Description copied from interface: DataListener

dataLabel() provides the name used to identify the class in an external data source.

Specified by:

dataLabel in interface DataListener

Returns:

a tag that identifies the receiver's type

findChannel

public Channel findChannel(java.lang.String handle)

Find the channel for the specified handle.

Parameters:

handle - The handle for the channel to fetch

Returns:

the channel if found or null if not found

getAndConnectChannel

public Channel getAndConnectChannel(java.lang.String handle)
                             throws NoSuchChannelException,
                                    ConnectionException

Get the channel corresponding to the specified handle and connect it.

Parameters:

handle - The handle for the channel to get.

Returns:

The channel associated with this node and the specified handle or null if there is no match.

Throws:

NoSuchChannelException - if no such channel as specified by the handle is associated with this node.

ConnectionException - if the channel cannot be connected

getChannel

public Channel getChannel(java.lang.String handle)
                   throws NoSuchChannelException

Get the channel for the specified handle.

Parameters:

handle - The handle for the channel to fetch

Returns:

the channel

Throws:

NoSuchChannelException

getChannelSuite

public ChannelSuite getChannelSuite()

Get the channel suite.

Returns:

the channel suite.

getKlysAmp

public double getKlysAmp()
                  throws ConnectionException,
                         GetException

Get the klystron's amplitude.

Returns:

klystron amplitude

Throws:

ConnectionException

GetException

getKlysPhase

public double getKlysPhase()
                    throws ConnectionException,
                           GetException

Get the klystron's phase.

Returns:

klystron phase

Throws:

ConnectionException

GetException

getId

public java.lang.String getId()

Get the unique power supply ID

Returns:

The power supply ID

getControlFlag

public int[] getControlFlag()

Get predefined control flags.

Returns:

control flag in integer array

getPowerFact

public int[] getPowerFact()

Get power distribution factors

Returns:

power distribution flags in integer array

getType

public java.lang.String getType()

Get the klystron type.

Returns:

klystron type

getStatus

public boolean getStatus()

setKlysAmp

public void setKlysAmp(double newAmp)
                throws ConnectionException,
                       PutException

Set klystron amplitude.

Parameters:

newAmp - new klystron amplitude

Throws:

ConnectionException

PutException

setKlysPhase

public void setKlysPhase(double newPhase)
                  throws ConnectionException,
                         PutException

Set klystron phase.

Parameters:

newPhase - new klystron phase

Throws:

ConnectionException

PutException

setControlFlag

public void setControlFlag(int[] cFlag)

Set control flag.

Parameters:

cFlag - control flag in integer array

setPowerFact

public void setPowerFact(int[] pFact)

Set Power distribution factors.

Parameters:

pFact - power distribution factors in integer array

setStatus

public void setStatus(boolean stat)

update

public void update(DataAdaptor adaptor)

Description copied from interface: DataListener

Update the data based on the information provided by the data provider.

Specified by:

update in interface DataListener

Parameters:

adaptor - The adaptor from which to update the data

write

public void write(DataAdaptor adaptor)

Description copied from interface: DataListener

Write data to the data adaptor for storage.

Specified by:

write in interface DataListener

Parameters:

adaptor - The adaptor to which the receiver's data is written