Package org.scictrl.mp.orbitcorrect.model.optics

Class RFGenerator

java.lang.Object

org.scictrl.mp.orbitcorrect.model.optics.AbstractDataBushElement

org.scictrl.mp.orbitcorrect.model.optics.RFGenerator

All Implemented Interfaces:

Cloneable, ISimpleElement, AbstractUpdateableElement, IApplyableElement, IBindedElement<Double>

public class RFGenerator
extends AbstractDataBushElement
implements IBindedElement<Double>, AbstractUpdateableElement, IApplyableElement

This class represents RF signal generator. It should connect to control system device for generating main RF signal for cavitiesin storage ring. Databush expects and uses frequency in units of MHz.

Author:

igor@scictrl.com

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	dataInvalidated	Data invalidated flag.
double	defaultMaxValue	Default max frequency value.
double	defaultMinValue	Default min frequency value.
static final String	FREQUENCY	Constant FREQUENCY="frequency"
static final int	PR_FREQUENCY	Constant PR_FREQUENCY=2

Fields inherited from class org.scictrl.mp.orbitcorrect.model.optics.AbstractDataBushElement

lastActionResult, owner, PR_ELEMENT_NAME, PR_VIRTUAL

Constructor Summary

Constructors

Constructor	Description
RFGenerator(String name)	Constructs a RFGenerator with specified name and default parameters vaues
RFGenerator(String name, boolean virtual, double frequency)	Constructs a RFGenerator with specified parameters

Method Summary

Modifier and Type	Method	Description
int	applyFrequency()	This method sets current, that PowerSupply currently holds, to PowerSupplyBean.
int	connect()	Binds to remote object.
DBElementDescriptor	descriptor()	Returns the descriptor object for this element.
int	disconnect()	Destroys connection.
int	elType()	Returns the code of element's type.
IWriteConnector<Double>	getConnector()	If RFGenerator is connected, returns control system property for RFGenerator.
double	getFrequency()	Getter for the field frequency.
double	getMaxFrequency()	This method return maximum current, that can power supply safely exceed.
double	getMinFrequency()	This method return minimum current, that can power supply exceed.
void	invalidateData()	Sets DataInvalidated flag to true.
boolean	isConnected()	Returns true if element is binded, false otherwise.
boolean	isDataInvalidated()	Returns true if element's data is not synchronized with associated element or Abean.
boolean	isUseable()	This method tests if power supply is useable.
void	notifyDataUpdate(Double data)	Called by data connection when new value update arrives
void	setFrequency(double value)	Sets local reference for frequency.
void	setWith(Object[] par)	Sets parameters values of this element to those in parameter array.
String	toString()	Returns the string representation of this element.
int	update()	Reads value from associated element or Abean and calculates it's new values.

Methods inherited from class org.scictrl.mp.orbitcorrect.model.optics.AbstractDataBushElement

clone, equals, getLastActionResult, getName, getOwner, getVirtual, hashCode, isInitialized, isVirtual, setVirtual, throwISE

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.scictrl.mp.orbitcorrect.ISimpleElement

clone, getName

Field Details

PR_FREQUENCY

public static final int PR_FREQUENCY

Constant PR_FREQUENCY=2

See Also:

• Constant Field Values

FREQUENCY

public static final String FREQUENCY

Constant FREQUENCY="frequency"

See Also:

• Constant Field Values

defaultMaxValue

public double defaultMaxValue

Default max frequency value.

defaultMinValue

public double defaultMinValue

Default min frequency value.

dataInvalidated

protected boolean dataInvalidated

Data invalidated flag.

Constructor Details

RFGenerator

public RFGenerator(String name)

Constructs a RFGenerator with specified name and default parameters vaues

Parameters:

name - a String object

RFGenerator

public RFGenerator(String name,
 boolean virtual,
 double frequency)

Constructs a RFGenerator with specified parameters

Parameters:

name - a String object

virtual - a boolean

frequency - a double

Method Details

notifyDataUpdate

public void notifyDataUpdate(Double data)

Called by data connection when new value update arrives

Specified by:

notifyDataUpdate in interface IBindedElement<Double>

Parameters:

data - new data, if value is OK, null if last arrive value signals problems and can not be thrusted

applyFrequency

public int applyFrequency()
                   throws IllegalStateException,
DataBushPackedException

This method sets current, that PowerSupply currently holds, to PowerSupplyBean.

Returns:

a int

Throws:

IllegalStateException - if any.

DataBushPackedException - if any.

connect

public int connect()
            throws IllegalStateException,
DataBushPackedException

Binds to remote object. Returns the code indication success of bind. Connects element to InfoServerBean device. Returns the success code of operation.

Specified by:

connect in interface IBindedElement<Double>

Returns:

the code indication success of bind.

Throws:

DataBushPackedException - if bind exception occurs.

IllegalStateException

See Also:

• disconnect()

descriptor

public DBElementDescriptor descriptor()

Returns the descriptor object for this element. DBElementDescriptor helps manipulating DataBush elements dynamically. Returns the descriptor object for this element. DBElementDescriptor helps manipulating DataBush elements dynamically.

Specified by:

descriptor in class AbstractDataBushElement

Returns:

the descriptor object for this element.

See Also:

• DBElementDescriptor

disconnect

public int disconnect()
               throws IllegalStateException

Destroys connection. Returns the code indication success of destroy. Disconnects element from InfoServerBean device. Returns the success code of operation.

Specified by:

disconnect in interface IBindedElement<Double>

Returns:

the code indication success of destroy.

Throws:

IllegalStateException

See Also:

• connect()

elType

public int elType()

Returns the code of element's type. Returns the code of element's type.

Specified by:

elType in class AbstractDataBushElement

Returns:

the code of element's type.

See Also:

• DBConst
• DBElementDescriptor

getFrequency

public double getFrequency()

Getter for the field frequency.

Returns:

a double

getConnector

public IWriteConnector<Double> getConnector()

If RFGenerator is connected, returns control system property for RFGenerator.

Returns:

a IWriteConnector object

getMaxFrequency

public double getMaxFrequency()
                       throws IllegalStateException,
ControlSystemException

This method return maximum current, that can power supply safely exceed.

Returns:

a double

Throws:

IllegalStateException - if any.

ControlSystemException - if any.

getMinFrequency

public double getMinFrequency()
                       throws IllegalStateException,
ControlSystemException

This method return minimum current, that can power supply exceed.

Returns:

a double

Throws:

IllegalStateException - if any.

ControlSystemException - if any.

invalidateData

public void invalidateData()

Sets DataInvalidated flag to true. This method invalidate data which means that at least one data in this object is not consistent with other object's data. It is necessary to update this object or apply (if possible).

Specified by:

invalidateData in interface AbstractUpdateableElement

Specified by:

invalidateData in interface IApplyableElement

See Also:

• AbstractUpdateableElement.isDataInvalidated()

isConnected

public boolean isConnected()

Returns true if element is binded, false otherwise. This method tests if PowerSupply is connected.

Specified by:

isConnected in interface IBindedElement<Double>

Returns:

true if element is binded, false otherwise.

See Also:

• connect()
• disconnect()

isDataInvalidated

public boolean isDataInvalidated()

Returns true if element's data is not synchronized with associated element or Abean. This fag goes to false after update or apply. This method tests if data is invalidated.

Specified by:

isDataInvalidated in interface AbstractUpdateableElement

Specified by:

isDataInvalidated in interface IApplyableElement

Returns:

true if element's data is not synchronized with associated element or Abean.

See Also:

• invalidateData()

setFrequency

public void setFrequency(double value)

Sets local reference for frequency.

Parameters:

value - a double

setWith

public void setWith(Object[] par)
             throws IllegalStateException

Sets parameters values of this element to those in parameter array. As parameter must be used such array as for dynamical construction of new instance of this class. Current values are overriden for each not null object in array.

setWith.

Overrides:

setWith in class AbstractDataBushElement

Parameters:

par - an array of Object objects

Throws:

IllegalStateException - if element is initialized and inside DataBush.

See Also:

• AbstractDataBushElement.setWith(java.lang.Object[])

toString

public String toString()

Returns the string representation of this element. Returns string describing this element. String is formated in input-file code. Returns a String that represents the value of this object.

Specified by:

toString in interface ISimpleElement

Overrides:

toString in class AbstractDataBushElement

update

public int update()
           throws IllegalStateException,
DataBushPackedException

Reads value from associated element or Abean and calculates it's new values. Metod reads data from other databush elements or from remote devices represented with Abean. Metod also checks isDataInvalidated() on depending databush elements, if value has changed. Return value is identification code of error. Note! Update is performed only if virtual flag is set to false. Note! All update methods are synchronized, so only one update is called at time. For update od group of elements call update on appropriate element-list or DataBush. This method read current from PowerSupplyBean and save it to field current

Specified by:

update in interface AbstractUpdateableElement

Returns:

a int the return code indicating success

Throws:

IllegalStateException - thrown if status of DataBush equals DB_EMPTY

DataBushPackedException - contains all exception thrown or caught during updating element

isUseable

public boolean isUseable()

This method tests if power supply is useable.

Returns:

True if is.