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 EML2_NS
{
    class AbstractHdfProxy;
    class PropertyKind;
    class TimeSeries;
}
 
namespace RESQML2_NS
{
    class AbstractRepresentation;
 
    class AbstractProperty: public COMMON_NS::AbstractObject
    {
    public:
 
        virtual ~AbstractProperty() = default;
 
        DLL_IMPORT_OR_EXPORT void setRepresentation(AbstractRepresentation * rep);
 
        DLL_IMPORT_OR_EXPORT COMMON_NS::DataObjectReference getRepresentationDor() const;
 
        DLL_IMPORT_OR_EXPORT AbstractRepresentation* getRepresentation() const;
 
        DLL_IMPORT_OR_EXPORT unsigned int getElementCountPerValue() const;
 
        DLL_IMPORT_OR_EXPORT gsoap_eml2_3::resqml22__IndexableElement getAttachmentKind() const;
 
        DLL_IMPORT_OR_EXPORT virtual unsigned int getPatchCount() const = 0;
 
        DLL_IMPORT_OR_EXPORT COMMON_NS::AbstractObject::hdfDatatypeEnum getValuesHdfDatatype() const;
 
        DLL_IMPORT_OR_EXPORT unsigned int getValuesCountOfPatch(unsigned int patchIndex) const;
 
        DLL_IMPORT_OR_EXPORT unsigned int getValuesCountOfDimensionOfPatch(unsigned int dimIndex, unsigned int patchIndex) const;
 
        DLL_IMPORT_OR_EXPORT unsigned int getDimensionsCountOfPatch(unsigned int patchIndex) const;
 
        //*********************************************
        //************* PROPERTY SET ******************
        //*********************************************
 
        DLL_IMPORT_OR_EXPORT std::vector<RESQML2_NS::PropertySet *> getPropertySets() const;
 
        DLL_IMPORT_OR_EXPORT unsigned int getPropertySetCount() const;
 
        DLL_IMPORT_OR_EXPORT RESQML2_NS::PropertySet * getPropertySet(unsigned int index) const;
        
        //*********************************************
        //****************** CRS **********************
        //*********************************************
 
        DLL_IMPORT_OR_EXPORT void setLocalCrs(class AbstractLocal3dCrs * crs);
 
        DLL_IMPORT_OR_EXPORT class AbstractLocal3dCrs* getLocalCrs() const;
 
        DLL_IMPORT_OR_EXPORT COMMON_NS::DataObjectReference getLocalCrsDor() const;
 
        //*********************************************
        //********** REALIZATION DIMENSION ************
        //*********************************************
 
        DLL_IMPORT_OR_EXPORT bool hasRealizationIndices() const;
 
        DLL_IMPORT_OR_EXPORT std::vector<unsigned int> getRealizationIndices() const;
 
        DLL_IMPORT_OR_EXPORT void setRealizationIndices(int64_t startRealizationIndex, int64_t countRealizationIndices);
 
        DLL_IMPORT_OR_EXPORT void setRealizationIndices(const std::vector<unsigned int> & realizationIndices, EML2_NS::AbstractHdfProxy* hdfProxy = nullptr);
 
        //*********************************************
        //************ TIME DIMENSION *****************
        //*********************************************
 
        DLL_IMPORT_OR_EXPORT void setTimeSeries(EML2_NS::TimeSeries * ts);
 
        DLL_IMPORT_OR_EXPORT EML2_NS::TimeSeries* getTimeSeries() const;
 
        DLL_IMPORT_OR_EXPORT COMMON_NS::DataObjectReference getTimeSeriesDor() const;
 
        DLL_IMPORT_OR_EXPORT void setTimeIndices(uint64_t startTimeIndex, uint64_t countTimeIndices, EML2_NS::TimeSeries* ts, bool useInterval = false);
 
        DLL_IMPORT_OR_EXPORT unsigned int getTimeIndexStart() const;
 
        DLL_IMPORT_OR_EXPORT unsigned int getTimeIndicesCount() const;
 
        DLL_IMPORT_OR_EXPORT bool useInterval() const;
 
        //*********************************************
        //****** PROP KIND ****************************
        //*********************************************
 
        DLL_IMPORT_OR_EXPORT bool isAssociatedToOneStandardEnergisticsPropertyKind() const;
 
        DLL_IMPORT_OR_EXPORT std::string getPropertyKindDescription() const;
 
        DLL_IMPORT_OR_EXPORT std::string getPropertyKindAsString() const;
 
        DLL_IMPORT_OR_EXPORT std::string getPropertyKindParentAsString() const;
 
        DLL_IMPORT_OR_EXPORT void setPropertyKind(EML2_NS::PropertyKind* propKind);
 
        COMMON_NS::DataObjectReference getPropertyKindDor() const;
 
        DLL_IMPORT_OR_EXPORT EML2_NS::PropertyKind* getPropertyKind() const;
 
        virtual bool validatePropertyKindAssociation(EML2_NS::PropertyKind* pk) = 0;
 
        virtual bool validatePropertyKindAssociation(gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind pk) = 0;
 
        bool validate();
 
    protected:
 
        DLL_IMPORT_OR_EXPORT AbstractProperty(gsoap_resqml2_0_1::eml20__DataObjectReference* partialObject) : COMMON_NS::AbstractObject(partialObject) {}
 
        AbstractProperty() {}
 
        AbstractProperty(gsoap_resqml2_0_1::resqml20__AbstractProperty* fromGsoap) : COMMON_NS::AbstractObject(fromGsoap) {}
        AbstractProperty(gsoap_eml2_3::resqml22__AbstractProperty* fromGsoap) : COMMON_NS::AbstractObject(fromGsoap) {}
 
        virtual void loadTargetRelationships() override;
 
        DLL_IMPORT_OR_EXPORT gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind getEnergisticsPropertyKind201() const;
 
        virtual EML2_NS::AbstractHdfProxy* getDatasetOfPatch(unsigned int patchIndex, int64_t & nullValue, std::string & dsPath) const = 0;
 
        virtual COMMON_NS::DataObjectReference getHdfProxyDor(unsigned int patchIndex) const = 0;
    };
}