public enum ECavityGeneral extends java.lang.Enum<ECavityGeneral> implements IECavityElement
Enumeration ECavityGeneral | Description |
---|---|
TINE_CONTEXT | TINE context. |
PROPERTY | TINE property. |
Enum Constant and Description |
---|
NEAR
TINE construct of the transmitter near operation.
|
PROPERTY
TINE property name.
|
STATUS
TINE construct of the transmitter status.
|
TINE_CONTEXT
TINE context name.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getName(EName description_)
Returns according to the enumeration of the description the corresponding
string value.
|
boolean |
isAdjusting()
Returns a logical value if the data component is adjusting its parameter
just by dragging it around or not.
|
boolean |
isCDI()
Tells the caller if this data element is part of a CDI server or not.
|
boolean |
isFireEvent()
Normally all elements of these enumeration interface will fire an event
to modified it in the CDI server and therefore in the hardware and not
only on screen.
|
void |
putName(EName description_,
java.lang.String name_)
DON'T DELETE THIS CONTENT BECAUSE IT IS NEEDED BY SOME CALLS!
|
int |
size()
Returns the size of values each data component can get.
|
static ECavityGeneral |
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.
|
static ECavityGeneral[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final ECavityGeneral TINE_CONTEXT
public static final ECavityGeneral PROPERTY
public static final ECavityGeneral NEAR
public static final ECavityGeneral STATUS
public static ECavityGeneral[] values()
for (ECavityGeneral c : ECavityGeneral.values()) System.out.println(c);
public static ECavityGeneral valueOf(java.lang.String name)
name
- the name of the enum constant to be returned.java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is nullpublic java.lang.String getName(EName description_) throws EnumerationNotUsedException
IEEnum
null
value
is returned, except the enumeration of ID
which will always
return a value.getName
in interface IEEnum
description_
- The corresponding enumeration type which you wanted
to get. For more information see at the EName
enumeration.EnumerationNotUsedException
- If the enumeration indeed exists but
is not used these exception is thrown.public void putName(EName description_, java.lang.String name_) throws EnumerationNotUsedException
putName
in interface IEEnum
description_
- Is the EName enumeration one wants to set.name_
- Is the name of the string value. This can also be
null.EnumerationNotUsedException
- Is thrown if the enumeration is known
but not used.public int size()
IEData
public boolean isAdjusting()
IEData
Returns a logical value if the data component is adjusting its parameter just by dragging it around or not. With the word drag I mean that you take the component and drag it with the mouse button pressed down and push it to another location.
isAdjusting
in interface IEData
false
value while
it can also return on some data components a true
value
(for example with a slider component). You can also ignore this
value, which is in most of the cases okay!public boolean isCDI()
IEData
Tells the caller if this data element is part of a CDI server or not.
public boolean isFireEvent()
IEData
Normally all elements of these enumeration interface will fire an event
to modified it in the CDI server and therefore in the hardware and not
only on screen. This is currently done if this method returns a
true
value. If not it will return a false
.
isFireEvent
in interface IEData
true
if the value should be set on hardware,
otherwise a false
is returned.14-September-2016 18:23 Deutsches Elektronen-Synchrotron DESY in der Helmholtz-Gemeinschaft