Package org.epics.pvdata.property
Interface PVEnumerated
-
- All Known Implementing Classes:
PVEnumeratedFactory
public interface PVEnumeratedPVEnumerated. Attach to an enumerated structure.- Author:
- mrk
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description booleanattach(PVField pvField)Attempt to attach to the enumerated field.booleanchoicesMutable()Are the choices mutable.voiddetach()Remove attachment to an enumerated field.StringgetChoice()Get the choice corresponding to the current index.String[]getChoices()Get the current choices.intgetIndex()Get the current index.booleanisAttached()Is this attached to an enumerated structure.booleansetChoices(String[] choices)Set the choices.booleansetIndex(int index)Set the index.
-
-
-
Method Detail
-
attach
boolean attach(PVField pvField)
Attempt to attach to the enumerated field. The field must either be an enumerated field itself or a subfield of the parent of a field named value.- Parameters:
pvField- The field for which to find an enumerated field,- Returns:
- (false,true) if enumerated field (not found, found).
-
detach
void detach()
Remove attachment to an enumerated field.
-
isAttached
boolean isAttached()
Is this attached to an enumerated structure.- Returns:
- false or true.
-
setIndex
boolean setIndex(int index)
Set the index.- Parameters:
index- the value- Returns:
- (false,true) if the index (was not, was) modified.
-
getIndex
int getIndex()
Get the current index.- Returns:
- the value
-
getChoice
String getChoice()
Get the choice corresponding to the current index.- Returns:
- the value
-
choicesMutable
boolean choicesMutable()
Are the choices mutable.- Returns:
- false or true
-
getChoices
String[] getChoices()
Get the current choices.- Returns:
- the choices
-
setChoices
boolean setChoices(String[] choices)
Set the choices.- Parameters:
choices- the choices- Returns:
- (false,true) in choices are (immutable, mutable)
-
-