DasAcquisition.h

/*-----------------------------------------------------------------------
Copyright F2I-CONSULTING, (2014-2017)

philippe.verney@f2i-consulting.com

This software is a computer program whose purpose is to access to data formatted using Energistics standards.

This software is governed by the CeCILL-B license under French law and
abiding by the rules of distribution of free software.  You can  use, 
modify and/ or redistribute the software under the terms of the CeCILL-B
license as circulated by CEA, CNRS and INRIA at the following URL
"http://www.cecill.info". 

As a counterpart to the access to the source code and  rights to copy,
modify and redistribute granted by the license, users are provided only
with a limited warranty  and the software's author,  the holder of the
economic rights,  and the successive licensors  have only  limited
liability. 

In this respect, the user's attention is drawn to the risks associated
with loading,  using,  modifying and/or developing or reproducing the
software by the user in light of its specific status of free software,
that may mean  that it is complicated to manipulate,  and  that  also
therefore means  that it is reserved for developers  and  experienced
professionals having in-depth computer knowledge. Users are therefore
encouraged to load and test the software's suitability as regards their
requirements in conditions enabling the security of their systems and/or 
data to be ensured and,  more generally, to use and operate it in the 
same conditions as regards security. 

The fact that you are presently reading this means that you have had
knowledge of the CeCILL-B license and that you accept its terms.
-----------------------------------------------------------------------*/
#pragma once

#include "prodml2_0/AbstractObject.h"
#include "resqml2/AbstractValuesProperty.h"

namespace common {
    class HdfProxy;
}

namespace prodml2_0
{
    class DLL_IMPORT_OR_EXPORT DasAcquisition : public prodml2_0::AbstractObject
    {
    private:
        gsoap_eml2_1::prodml2__DasRaw* pushBackRawXmlOnly(const std::string & uuid, const std::string & rawDataUnit, const ULONG64 & startLocusIndex, const ULONG64 & numberOfLoci, const std::string & rawDescription,
            const std::string & startTime, const std::string endTime, const ULONG64 & timeCount,
            gsoap_eml2_1::prodml2__DasDimensions slowestHdfDimension, gsoap_eml2_1::prodml2__DasDimensions fastestHdfDimension,
            bool datatypeIsInteger,
            common::AbstractHdfProxy* proxy);

    public:
        DasAcquisition() {}

        DasAcquisition(class FiberOpticalPath* fiberOpticalPath, class DasInstrumentBox* dasInstrumentBox,
            const std::string & guid, const std::string & title,
            const std::string & jobUuid, const std::string & facilityId, const std::string & vendorName,
            const double & pulseRate, const gsoap_eml2_1::eml21__FrequencyUom & pulseRateUom,
            const double & pulseWidth, const gsoap_eml2_1::eml21__TimeUom & pulseWidthUom,
            const double & gaugeLength, const gsoap_eml2_1::eml21__LengthUom & gaugeLengthUom,
            const double & spatialSamplingInterval, const gsoap_eml2_1::eml21__LengthUom & spatialSamplingIntervalUom,
            const double & minimumFrequency, const gsoap_eml2_1::eml21__FrequencyUom & minimumFrequencyUom,
            const double & maximumFrequency, const gsoap_eml2_1::eml21__FrequencyUom & maximumFrequencyUom,
            const ULONG64 & lociCount, const ULONG64 & startLocusIndex,
            const std::string & measurementStartIsoTime, bool triggeredMeasurement);

        DasAcquisition(class FiberOpticalPath* fiberOpticalPath, class DasInstrumentBox* dasInstrumentBox,
            prodml2_0::HdfProxy * proxy);

        DasAcquisition(gsoap_eml2_1::_prodml2__DasAcquisition* fromGsoap) : AbstractObject(fromGsoap) {}

        ~DasAcquisition() {}
        
        static const char* XML_TAG;
        virtual std::string getXmlTag() const {return XML_TAG;}

        void setHdfProxy(common::AbstractHdfProxy * proxy);

        gsoap_eml2_1::eml21__DataObjectReference* getFiberOpticalPathDor() const;
        class FiberOpticalPath* getFiberOpticalPath() const;

        void setFiberOpticalPath(class FiberOpticalPath* fiberOpticalPath);

        gsoap_eml2_1::eml21__DataObjectReference* getDasInstrumentBoxDor() const;
        class DasInstrumentBox* getDasInstrumentBox() const;

        void setDasInstrumentBox(class DasInstrumentBox* dasInstrumentBox);

        std::string getJobUuid() const;
        std::string getFacilityUuid() const; // only the first one for now
        std::string getVendorName() const;

        double getPulseRate() const;
        gsoap_eml2_1::eml21__FrequencyUom getPulseRateUom() const;

        double getPulseWidth() const;
        gsoap_eml2_1::eml21__TimeUom getPulseWidthUom() const;

        double getGaugeLength() const;
        gsoap_eml2_1::eml21__LengthUom getGaugeLengthUom() const;

        double getSpatialSamplingInterval() const;
        gsoap_eml2_1::eml21__LengthUom getSpatialSamplingIntervalUom() const;

        double getMinimumFrequency() const;
        gsoap_eml2_1::eml21__FrequencyUom getMinimumFrequencyUom() const;

        double getMaximumFrequency() const;
        gsoap_eml2_1::eml21__FrequencyUom getMaximumFrequencyUom() const;

        ULONG64 getLociCount() const;
        LONG64 getStartLocusIndex() const;

        std::string getMeasurementStartIsoTime() const;

        bool isTriggeredMeasurement() const;

        void pushBackRaw(const std::string & guid, bool datatypeIsInteger, const char & datatypeByteCount, const std::string & rawDataUnit, LONG64* timeArray, const ULONG64 & timeCount, common::AbstractHdfProxy* proxy);

        void writeIntoDataset(float * data,
            unsigned long numSampleForAllLoci,
            unsigned long timeStepIndex);
        void writeIntoDataset(double * data,
            unsigned long numSampleForAllLoci,
            unsigned long timeStepIndex);
        void writeIntoDataset(LONG64 * data,
            unsigned long numSampleForAllLoci,
            unsigned long timeStepIndex);
        void writeIntoDataset(int * data,
            unsigned long numSampleForAllLoci,
            unsigned long timeStepIndex);
        void writeIntoDataset(short * data,
            unsigned long numSampleForAllLoci,
            unsigned long timeStepIndex);
        void writeIntoDataset(char * data,
            unsigned long numSampleForAllLoci,
            unsigned long timeStepIndex);

        unsigned int getRawCount() const;

        gsoap_eml2_1::prodml2__DasDimensions getRawDataSlowestDimension(const unsigned int & rawIndex) const;

        gsoap_eml2_1::prodml2__DasDimensions getRawDataFastestDimension(const unsigned int & rawIndex) const;

        std::string getRawDataUnit(const unsigned int & rawIndex) const;
        LONG64 getStartLocusIndex(const unsigned int & rawIndex) const;
        ULONG64 getNumberOfLoci(const unsigned int & rawIndex) const;
        ULONG64 getRawDataTimeCount(const unsigned int & rawIndex) const;

        resqml2::AbstractValuesProperty::hdfDatatypeEnum getRawDataHdfDatatype(const unsigned int & rawIndex) const;

        void getRawDataAsDoubleValues(const unsigned int & rawIndex, double * values);

        void getRawDataAsFloatValues(const unsigned int & rawIndex, float * values);

        void getRawDataAsLongValues(const unsigned int & rawIndex, LONG64 * values);

        void getRawDataAsIntValues(const unsigned int & rawIndex, int * values);

        void getRawDataAsShortValues(const unsigned int & rawIndex, short * values);

        void getRawDataAsCharValues(const unsigned int & rawIndex, char * values);

        void getRawDataTime(const unsigned int & rawIndex, LONG64 * values);

        common::AbstractHdfProxy* getHdfProxy() const;

        std::string getHdfProxyUuid() const;

    private:

        void initHdfAttributes();

        std::vector<epc::Relationship> getAllEpcRelationships() const;
        void importRelationshipSetFromEpc(common::EpcDocument* epcDoc) {}
    };
}