Package org.epics.pvdata.property
Interface PVTimeStamp
-
- All Known Implementing Classes:
PVTimeStampFactory
public interface PVTimeStampInterface for attaching a TimeStamp to a timeStamp structure.- Author:
- mrk
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description booleanattach(PVField pvField)Attempt to attach to a timeStamp field.voiddetach()Remove attachment to timeStamp field.voidget(TimeStamp timeStamp)Get the time stamp values from the attached time stamp field and write to the specified TimeStamp.booleanisAttached()Is this attached to a timeStamp structure.booleanset(TimeStamp timeStamp)Set the timeStamp.
-
-
-
Method Detail
-
attach
boolean attach(PVField pvField)
Attempt to attach to a timeStamp field. The field must either be an timeStamp field itself or the field must be named value and a timeStamp is found somewhere up the parent tree.- Parameters:
pvField- the field for which to find a timeStamp field- Returns:
- (false,true) if timeStamp field (not found, found)
-
detach
void detach()
Remove attachment to timeStamp field.
-
isAttached
boolean isAttached()
Is this attached to a timeStamp structure.- Returns:
- (false,true) is (not, is) attached to a timeStamp structure.
-
get
void get(TimeStamp timeStamp)
Get the time stamp values from the attached time stamp field and write to the specified TimeStamp.- Parameters:
timeStamp- the TimeStamp to be updated- Throws:
IllegalStateException- if this PVTimeStamp not attached to a time stamp field
-
set
boolean set(TimeStamp timeStamp)
Set the timeStamp.- Parameters:
timeStamp- the new value- Returns:
- (false,true) if the timeStamp field is (immutable,updated)
-
-