TimeStampSource Class Reference

#include <mrmtimesrc.h>

Inheritance diagram for TimeStampSource:

Classes
struct	Impl

Public Member Functions
	TimeStampSource (double period)
virtual	~TimeStampSource ()
void	resyncSecond ()
	Call to re-initialize timestamp counter from system time. More...
void	tickSecond ()
	Call just after the start of each second. More...
bool	validSeconds () const
	Whether tickSecond() has been called for the past 5 seconds. More...
double	deltaSeconds () const
	last difference between More...
void	softSecondsSrc (bool enable)
	enable sending of event 125 by software timer. Simulation of external HW clock More...
bool	isSoftSeconds () const
std::string	nextSecond () const

Protected Member Functions
virtual void	setEvtCode (epicsUInt32 evtCode)=0
virtual void	postSoftSecondsSrc ()

Detailed Description

Definition at line 16 of file mrmtimesrc.h.

Constructor & Destructor Documentation

TimeStampSource()

TimeStampSource::TimeStampSource ( double  period )

explicit

Definition at line 143 of file mrmtimesrc.cpp.

    :impl(new Impl(this, period))
{
    resyncSecond();
}

~TimeStampSource()

TimeStampSource::~TimeStampSource ( )

virtual

Definition at line 149 of file mrmtimesrc.cpp.

{
    delete impl;
}

Member Function Documentation

deltaSeconds()

double TimeStampSource::deltaSeconds

(

)

const

last difference between

Definition at line 224 of file mrmtimesrc.cpp.

{
    Guard G(impl->mutex);
    return impl->lastError;
}

isSoftSeconds()

bool TimeStampSource::isSoftSeconds

(

)

const

Definition at line 263 of file mrmtimesrc.cpp.

{
#ifdef HAVE_CNS
    Guard G(impl->mutex);
    return !!impl->softsrc.get();
#else
    return false;
#endif
}

nextSecond()

std::string TimeStampSource::nextSecond

(

)

const

Definition at line 273 of file mrmtimesrc.cpp.

{
    epicsTimeStamp raw;
    {
        Guard G(impl->mutex);
        raw.secPastEpoch = impl->next - POSIX_TIME_AT_EPICS_EPOCH;
        raw.nsec = 0;
    }
    epicsTime time(raw);

    std::vector<char> buf(40);

    buf.resize(time.strftime(&buf[0], buf.size(), "%a, %d %b %Y %H:%M:%S"));
    // buf.size() doesn't include trailing nil

    return std::string(&buf[0], buf.size());
}

postSoftSecondsSrc()

virtual void TimeStampSource::postSoftSecondsSrc ( )

inlineprotectedvirtual

Reimplemented in evgMrm.

Definition at line 45 of file mrmtimesrc.h.

{tickSecond();}

resyncSecond()

void TimeStampSource::resyncSecond

(

)

Call to re-initialize timestamp counter from system time.

Definition at line 154 of file mrmtimesrc.cpp.

{
    Guard G(impl->mutex);
    impl->resync = true;
}

setEvtCode()

virtual void TimeStampSource::setEvtCode ( epicsUInt32  evtCode )

protectedpure virtual

Implemented in EVRMRM, and evgMrm.

softSecondsSrc()

void TimeStampSource::softSecondsSrc

(

bool

enable

)

enable sending of event 125 by software timer. Simulation of external HW clock

Definition at line 231 of file mrmtimesrc.cpp.

{
#ifdef HAVE_CNS
    mrf::auto_ptr<epicsThread> cleanup;
    {
        Guard G(impl->mutex);
        if(enable && !impl->softsrc.get()) {
            // start it
            impl->stopsrc = false;
            impl->softsrc.reset(new epicsThread(impl->softsrcRun,
                                                "SoftTimeSrc",
                                                epicsThreadGetStackSize(epicsThreadStackSmall),
                                                epicsThreadPriorityHigh));
            impl->softsrc->start();

            resyncSecond();

        } else if(!enable && impl->softsrc.get()) {
            impl->stopsrc = true;
            cleanup = PTRMOVE(impl->softsrc);
        }
    }
    if(cleanup.get()) {
        impl->wakeup.signal();
        cleanup->exitWait();
    }
#else
    if(enable)
        throw std::runtime_error("Soft timestamp source not supported");
#endif
}

tickSecond()

void TimeStampSource::tickSecond

(

)

Call just after the start of each second.

Definition at line 160 of file mrmtimesrc.cpp.

{
    epicsUInt32 tosend=0;
    bool ok;

    epicsTimeStamp ts;
    bool valid = epicsTimeOK == generalTimeGetExceptPriority(&ts, 0, ER_PROVIDER_PRIORITY);

    {
        Guard G(impl->mutex);

        ok = impl->okCnt>=5;

        /* delay re-sync request until 1Hz is stable, valid system time is available */
        if(ok && valid && impl->resync)  {
            impl->next = ts.secPastEpoch+POSIX_TIME_AT_EPICS_EPOCH+1;
            impl->resync = false;
        }

        if(ok) {
            tosend = impl->next;
        }

        impl->next++;
        ok &= tosend!=0;

        if(ok && valid) {
            impl->lastError = double(tosend) - (ts.secPastEpoch+POSIX_TIME_AT_EPICS_EPOCH);
        } else {
            impl->lastError = -1.0;
        }

        if(!impl->timeout.get()) {
            // lazy start of timestamp timeout thread
            impl->timeout.reset(new epicsThread(impl->timeoutRun,
                                                "TimeStampTimeout",
                                                epicsThreadGetStackSize(epicsThreadStackSmall)));
            impl->timeout->start();
        }
    }

    impl->wakeup.signal();

    if(!ok) return;

    for(unsigned i = 0; i < 32; tosend <<= 1, i++) {
        try {
            if( tosend & 0x80000000 )
                setEvtCode(MRF_EVENT_TS_SHIFT_1);
            else
                setEvtCode(MRF_EVENT_TS_SHIFT_0);
        }catch(std::exception& e){
            errlogPrintf("Soft timestamp source can't send shift event: %s\n", e.what());
            return;
        }
    }
}

validSeconds()

bool TimeStampSource::validSeconds

(

)

const

Whether tickSecond() has been called for the past 5 seconds.

Definition at line 218 of file mrmtimesrc.cpp.

{
    Guard G(impl->mutex);
    return impl->okCnt>=5;
}

---

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

• mrmtimesrc.h
• mrmtimesrc.cpp