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_0_1_NS
{
    class PropertySet;
}
 
namespace RESQML2_NS
{
    class AbstractProperty: public COMMON_NS::AbstractObject
    {
    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) {}
 
    public:
 
        virtual ~AbstractProperty() {}
 
        DLL_IMPORT_OR_EXPORT void setRepresentation(class AbstractRepresentation * rep);
 
        gsoap_resqml2_0_1::eml20__DataObjectReference* getRepresentationDor() const;
 
        DLL_IMPORT_OR_EXPORT class AbstractRepresentation* getRepresentation() const;
 
        /*
        * Getter for the uuid of the representation which is described by this property
        */
        DLL_IMPORT_OR_EXPORT std::string getRepresentationUuid() const;
 
        /*
        * Getter for the title of the representation which is described by this property
        */
        DLL_IMPORT_OR_EXPORT std::string getRepresentationTitle() const;
 
        /*
        * Getter for the content type of the representation which is described by this property
        */
        DLL_IMPORT_OR_EXPORT std::string getRepresentationContentType() const;
 
        DLL_IMPORT_OR_EXPORT unsigned int getElementCountPerValue() const;
 
        DLL_IMPORT_OR_EXPORT gsoap_resqml2_0_1::resqml20__IndexableElements getAttachmentKind() const;
 
        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;
 
        //*********************************************
        //****** REALIZATION DIMENSION ****************
        //*********************************************
 
        DLL_IMPORT_OR_EXPORT bool hasRealizationIndex() const;
 
        DLL_IMPORT_OR_EXPORT ULONG64 getRealizationIndex() const;
 
        DLL_IMPORT_OR_EXPORT void setRealizationIndex(ULONG64 realizationIndex);
 
        //*********************************************
        //****** TIME DIMENSION ***********************
        //*********************************************
 
        DLL_IMPORT_OR_EXPORT void setTimeSeries(class TimeSeries * ts);
 
        DLL_IMPORT_OR_EXPORT 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.
        */
        DLL_IMPORT_OR_EXPORT std::string getTimeSeriesUuid() const;
 
        /*
        * Getter for the uuid of the time series which is associated to this property.
        */
        DLL_IMPORT_OR_EXPORT std::string getTimeSeriesTitle() const;
 
        DLL_IMPORT_OR_EXPORT void setTimeIndex(const unsigned int & timeIndex, class TimeSeries * ts);
 
        DLL_IMPORT_OR_EXPORT void setTimeStep(const unsigned int & timeStep);
 
        DLL_IMPORT_OR_EXPORT time_t getTimestamp() const;
 
        DLL_IMPORT_OR_EXPORT unsigned int getTimeIndex() 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 gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind getEnergisticsPropertyKind() const;
 
        DLL_IMPORT_OR_EXPORT void setLocalPropertyKind(class PropertyKind* propKind);
 
        gsoap_resqml2_0_1::eml20__DataObjectReference* getLocalPropertyKindDor() const;
 
        DLL_IMPORT_OR_EXPORT std::string getLocalPropertyKindUuid() const;
 
        DLL_IMPORT_OR_EXPORT std::string getLocalPropertyKindTitle() const;
 
        DLL_IMPORT_OR_EXPORT class PropertyKind* getLocalPropertyKind() const;
 
        virtual bool validatePropertyKindAssociation(class PropertyKind* pk) = 0;
 
        virtual bool validatePropertyKindAssociation(gsoap_resqml2_0_1::resqml20__ResqmlPropertyKind pk) = 0;
 
        bool validate();
 
    protected:
 
        virtual void loadTargetRelationships();
    };
}