Package org.epics.pvdata.property

Class PVTimeStampFactory

java.lang.Object

org.epics.pvdata.property.PVTimeStampFactory

All Implemented Interfaces:

PVTimeStamp

public class PVTimeStampFactory
extends Object
implements PVTimeStamp

Implementation of PVTimeStamp.

Author:

mrk

Constructor Summary

Constructors

Constructor	Description
PVTimeStampFactory()

Method Summary

Modifier and Type	Method	Description
boolean	attach(PVField pvField)	Attempt to attach to a timeStamp field.
static PVTimeStamp	create()	Create a PVTimeStamp.
void	detach()	Remove attachment to timeStamp field.
void	get(TimeStamp timeStamp)	Get the time stamp values from the attached time stamp field and write to the specified TimeStamp.
boolean	isAttached()	Is this attached to a timeStamp structure.
boolean	set(TimeStamp timeStamp)	Set the timeStamp.

Methods inherited from class java.lang.Object

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

Constructor Detail

PVTimeStampFactory

public PVTimeStampFactory()

Method Detail

create

public static PVTimeStamp create()

Create a PVTimeStamp.

Returns:

the newly created PVTimeStamp

attach

public boolean attach(PVField pvField)

Description copied from interface: PVTimeStamp

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.

Specified by:

attach in interface PVTimeStamp

Parameters:

pvField - the field for which to find a timeStamp field

Returns:

(false,true) if timeStamp field (not found, found)

detach

public void detach()

Description copied from interface: PVTimeStamp

Remove attachment to timeStamp field.

Specified by:

detach in interface PVTimeStamp

isAttached

public boolean isAttached()

Description copied from interface: PVTimeStamp

Is this attached to a timeStamp structure.

Specified by:

isAttached in interface PVTimeStamp

Returns:

(false,true) is (not, is) attached to a timeStamp structure.

get

public void get(TimeStamp timeStamp)

Description copied from interface: PVTimeStamp

Get the time stamp values from the attached time stamp field and write to the specified TimeStamp.

Specified by:

get in interface PVTimeStamp

Parameters:

timeStamp - the TimeStamp to be updated

set

public boolean set(TimeStamp timeStamp)

Description copied from interface: PVTimeStamp

Set the timeStamp.

Specified by:

set in interface PVTimeStamp

Parameters:

timeStamp - the new value

Returns:

(false,true) if the timeStamp field is (immutable,updated)