AbstractProperty.h

/*-----------------------------------------------------------------------
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"; you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.
-----------------------------------------------------------------------*/
#pragma once

#include "common/AbstractObject.h"

namespace RESQML2_NS
{
    class DLL_IMPORT_OR_EXPORT AbstractProperty: public COMMON_NS::AbstractObject
    {
    public:

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

        AbstractProperty(): local3dCrs(nullptr) {}

        AbstractProperty(gsoap_resqml2_0_1::resqml2__AbstractProperty* fromGsoap) : COMMON_NS::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_NS::AbstractHdfProxy * proxy);

        COMMON_NS::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_NS::EpcDocument * epcDoc);

        class AbstractLocal3dCrs *      local3dCrs;         
    };
}