src/FastResearchInterfaceLibrary/LoggingMethods.cpp

Go to the documentation of this file.

//  ---------------------- Doxygen info ----------------------
//  ----------------------------------------------------------
//   For a convenient reading of this file's source code,
//   please use a tab width of four characters.
//  ----------------------------------------------------------


#include <FastResearchInterface.h>
#include <DataLogging.h>
#include <errno.h>
#include <OSAbstraction.h>


// ****************************************************************
// PrepareLogging()
//
int FastResearchInterface::PrepareLogging(const char *FileIdentifier)
{
    if (this->LoggingState != FastResearchInterface::WriteLoggingDataFileCalled)
    {
        return(EINVAL);
    }
    else
    {
        this->LoggingState = FastResearchInterface::PrepareLoggingCalled;
    }

    return(this->DataLogger->PrepareLogging(this->CurrentControlScheme, FileIdentifier));
}


// ****************************************************************
// StartLogging()
//
int FastResearchInterface::StartLogging(void)
{
    if (this->LoggingState != FastResearchInterface::PrepareLoggingCalled)
    {
        return(EINVAL);
    }
    else
    {
        this->LoggingState = FastResearchInterface::StartLoggingCalled;
    }

    pthread_mutex_lock(&(this->MutexForLogging));
    this->LoggingIsActive   =   true;
    pthread_mutex_unlock(&(this->MutexForLogging));

    return(EOK);
}


// ****************************************************************
// StopLogging()
//
int FastResearchInterface::StopLogging(void)
{
    if (this->LoggingState != FastResearchInterface::StartLoggingCalled)
    {
        return(EINVAL);
    }
    else
    {
        this->LoggingState = FastResearchInterface::StopLoggingCalled;
    }

    pthread_mutex_lock(&(this->MutexForLogging));
    this->LoggingIsActive   =   false;
    pthread_mutex_unlock(&(this->MutexForLogging));

    return(EOK);
}


// ****************************************************************
// WriteLoggingDataFile()
//
int FastResearchInterface::WriteLoggingDataFile(void)
{
    if (this->LoggingState == FastResearchInterface::WriteLoggingDataFileCalled)
    {
        return(EINVAL);
    }

    this->LoggingState = FastResearchInterface::WriteLoggingDataFileCalled;

    if (this->LoggingState == FastResearchInterface::StartLoggingCalled)
    {
        pthread_mutex_lock(&(this->MutexForLogging));
        this->LoggingIsActive   =   false;
        pthread_mutex_unlock(&(this->MutexForLogging));
    }

    return(this->DataLogger->WriteToFile());
}