epics::pvData::PVTimeStamp Class Reference

Methods for accessing a timeStamp structure. More...

#include "pvTimeStamp.h"

Public Member Functions
	PVTimeStamp ()
bool	attach (PVFieldPtr const &pvField)
void	detach ()
bool	isAttached ()
void	get (TimeStamp &timeStamp) const
bool	set (TimeStamp const &timeStamp)

Detailed Description

Methods for accessing a timeStamp structure.

A timeStamp structure has the following fields:

structure
    long secondsPastEpoch
    int nanoseconds
    int userTag

This class can be attached to a timeStamp structure field of any PVData object. The methods provide access to the fields in the attached structure, via an instance of class TimeStamp. This class should not be extended.

Definition at line 38 of file pvTimeStamp.h.

Constructor & Destructor Documentation

epics::pvData::PVTimeStamp::PVTimeStamp ( )

inline

Constructor

Definition at line 44 of file pvTimeStamp.h.

{}

Member Function Documentation

bool epics::pvData::PVTimeStamp::attach

(

PVFieldPtr const &

pvField

)

Definition at line 26 of file pvTimeStamp.cpp.

{
    if(pvField->getField()->getType()!=structure) return false;
    PVStructurePtr xxx = static_pointer_cast<PVStructure>(pvField);
    PVStructure* pvStructure = xxx.get();
    while(true) {
        PVLongPtr pvLong = pvStructure->getSubField<PVLong>("secondsPastEpoch");
        if(pvLong) {
            pvSecs = pvLong;
            pvNano = pvStructure->getSubField<PVInt>("nanoseconds");
            pvUserTag = pvStructure->getSubField<PVInt>("userTag");
        }
        if(pvSecs
        && pvNano
        && pvUserTag) return true;
        detach();
        // look up the tree for a timeSyamp
        pvStructure = pvStructure->getParent();
        if(pvStructure==NULL) break;
    }
    return false;
}

void epics::pvData::PVTimeStamp::detach

(

)

Detach for pvField.

Definition at line 49 of file pvTimeStamp.cpp.

{
    pvSecs.reset();
    pvUserTag.reset();
    pvNano.reset();
}

void epics::pvData::PVTimeStamp::get

(

TimeStamp &

timeStamp

)

const

copy the timeStamp structure values to TimeStamp

Parameters

timeStamp

An instance of class TimeStamp

Exceptions

If	not attached to a pvField.

Definition at line 61 of file pvTimeStamp.cpp.

{
    if(pvSecs.get()==NULL) {
        throw std::logic_error(notAttached);
    }
    timeStamp.put(pvSecs->get(),pvNano->get());
    timeStamp.setUserTag(pvUserTag->get());
}

bool epics::pvData::PVTimeStamp::isAttached

(

)

Is the PVTimeStamp attached to a pvField?

Returns

(false,true) (is not,is) attached to a pvField.

Definition at line 56 of file pvTimeStamp.cpp.

                             {
    if(pvSecs.get()==NULL) return false;
    return true;
}

bool epics::pvData::PVTimeStamp::set

(

TimeStamp const &

timeStamp

)

copy the values from TimeStamp to the timeStamp structure.

Parameters

timeStamp

An instance of class TimeStamp

Returns

(false,true) if pvField (immutable, mutable)

Exceptions

If	not attached to a pvField.

Definition at line 70 of file pvTimeStamp.cpp.

{
    if(pvSecs.get()==NULL) {
        throw std::logic_error(notAttached);
    }
    if(pvSecs->isImmutable() || pvNano->isImmutable()) return false;
    TimeStamp current;
    get(current);
    bool returnValue = false;
    if(current.getSecondsPastEpoch()!=timeStamp.getSecondsPastEpoch())
    {
        pvSecs->put(timeStamp.getSecondsPastEpoch());
        returnValue = true;
    }
    if(current.getNanoseconds()!=timeStamp.getNanoseconds())
    {
        pvNano->put(timeStamp.getNanoseconds());
        returnValue = true;
    }
    if(current.getUserTag()!=timeStamp.getUserTag())
    {
        pvUserTag->put(timeStamp.getUserTag());
        returnValue = true;
    }
    return returnValue;
}

---

The documentation for this class was generated from the following files:

• modules/pvData/src/property/pv/pvTimeStamp.h
• modules/pvData/src/property/pvTimeStamp.cpp