AbstractProperty.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 "common/AbstractObject.h"

namespace resqml2
{
    class DLL_IMPORT_OR_EXPORT AbstractProperty: public common::AbstractObject
    {
    public:

        AbstractProperty(gsoap_resqml2_0_1::eml20__DataObjectReference* partialObject) : common::AbstractObject(partialObject) {}

        AbstractProperty(): local3dCrs(nullptr) {}

        AbstractProperty(gsoap_resqml2_0_1::resqml2__AbstractProperty* fromGsoap) : common::AbstractObject(fromGsoap), local3dCrs(nullptr) {}

        virtual ~AbstractProperty() {}

        void setRepresentation(class AbstractRepresentation * rep);

        gsoap_resqml2_0_1::eml20__DataObjectReference* getRepresentationDor() const;

        class AbstractRepresentation* getRepresentation() const;

        /*
        * Getter for the uuid of the representation which is described by this property
        */
        std::string getRepresentationUuid() const;

        /*
        * Getter for the title of the representation which is described by this property
        */
        std::string getRepresentationTitle() const;

        /*
        * Getter for the content type of the representation which is described by this property
        */
        std::string getRepresentationContentType() const;

        void setTimeSeries(class TimeSeries * ts);

        TimeSeries* getTimeSeries() const;

        gsoap_resqml2_0_1::eml20__DataObjectReference* getTimeSeriesDor() const;

        /*
        * Getter for the uuid of the time series which is associated to this property.
        */
        std::string getTimeSeriesUuid() const;

        /*
        * Getter for the uuid of the time series which is associated to this property.
        */
        std::string getTimeSeriesTitle() const;

        void setTimeIndex(const unsigned int & timeIndex, class TimeSeries * ts);

        void setTimeStep(const unsigned int & timeStep);

        time_t getTimestamp() const;

        unsigned int getTimeIndex() const;

        void setHdfProxy(common::AbstractHdfProxy * proxy);

        common::AbstractHdfProxy* getHdfProxy() const;

        /*
         * Getter for the uuid of the hdf proxy which is used for storing the numerical values of this property.
         * An empty string is returned if no hd fproxy is used for storing the numerical values.
         */
        std::string getHdfProxyUuid() const;

        unsigned int getElementCountPerValue() const;

        gsoap_resqml2_0_1::resqml2__IndexableElements getAttachmentKind() const;

        bool isAssociatedToOneStandardEnergisticsPropertyKind() const;

        //*********************************************
        //****** PROP KIND ****************************
        //*********************************************

        std::string getPropertyKindDescription() const;

        std::string getPropertyKindAsString() const;

        std::string getPropertyKindParentAsString() const;

        gsoap_resqml2_0_1::resqml2__ResqmlPropertyKind getEnergisticsPropertyKind() const;

        void setLocalPropertyKind(class PropertyKind* propKind);

        gsoap_resqml2_0_1::eml20__DataObjectReference* getLocalPropertyKindDor() const;

        std::string getLocalPropertyKindUuid() const;

        std::string getLocalPropertyKindTitle() const;

        class PropertyKind* getLocalPropertyKind() const;

        virtual bool validatePropertyKindAssociation(class PropertyKind* pk) = 0;

        virtual bool validatePropertyKindAssociation(const gsoap_resqml2_0_1::resqml2__ResqmlPropertyKind & pk) = 0;

    protected:

        void setXmlRepresentation(class AbstractRepresentation * rep);
        void setXmlTimeSeries(TimeSeries * ts);
        void setXmlLocalPropertyKind(class PropertyKind* propKind);

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

        class AbstractLocal3dCrs *      local3dCrs;         
    };
}