Add support for EML2.3 PropertyKind deprecation date

Author: philippeVerney

example/example.cpp

@@ -302,6 +302,7 @@ void serializeWells(COMMON_NS::DataObjectRepository * repo, EML2_NS::AbstractHdf
 #if WITH_RESQML2_2
 	else {
 		unitNumberPropType = repo->createPropertyKind("358aac23-b377-4349-9e72-bff99a6edf34", "Unit number", gsoap_eml2_3::eml23__QuantityClassKind::not_x0020a_x0020measure);
+		static_cast<EML2_3_NS::PropertyKind*>(unitNumberPropType)->setDeprecationDate(unitNumberPropType->getCreation() + 3600);
 	}
 #endif
 

src/eml2_3/PropertyKind.cpp

@@ -19,6 +19,7 @@ under the License.
 #include "PropertyKind.h"
 
 #include <stdexcept>
+#include "../tools/TimeTools.h"
 
 using namespace std;
 using namespace EML2_3_NS;
@@ -113,6 +114,63 @@ COMMON_NS::DataObjectReference PropertyKind::getParentPropertyKindDor() const
 	return COMMON_NS::DataObjectReference(static_cast<gsoap_eml2_3::_eml23__PropertyKind*>(gsoapProxy2_3)->Parent);
 }
 
+time_t PropertyKind::getDeprecationDate() const
+{
+	tm result = getDeprecationDateAsTimeStructure();
+
+	if (result.tm_mday == 0) {
+		return -1;
+	}
+
+	return timeTools::timegm(result);
+}
+
+tm PropertyKind::getDeprecationDateAsTimeStructure() const
+{
+	cannotBePartial();
+
+	if (gsoapProxy2_3 != nullptr && static_cast<gsoap_eml2_3::_eml23__PropertyKind*>(gsoapProxy2_3)->DeprecationDate)
+		return *static_cast<gsoap_eml2_3::_eml23__PropertyKind*>(gsoapProxy2_3)->DeprecationDate;
+	else {
+		tm result;
+		result.tm_hour = 0;
+		result.tm_isdst = 0;
+		result.tm_mday = 0;
+		result.tm_min = 0;
+		result.tm_mon = 0;
+		result.tm_sec = 0;
+		result.tm_wday = 0;
+		result.tm_yday = 0;
+		result.tm_year = 0;
+		return result;
+	}
+}
+
+void PropertyKind::setDeprecationDate(time_t deprecationDate)
+{
+	cannotBePartial();
+
+	if (deprecationDate > 0) {
+
+		if (deprecationDate < getCreation()) {
+			throw invalid_argument("Deprecation Date cannot be inferior to creation date.");
+		}
+
+		std::tm tmConversion = timeTools::to_calendar_time(timeTools::from_time_t(deprecationDate));
+		setDeprecationDate(tmConversion);
+	}
+}
+
+void PropertyKind::setDeprecationDate(const tm& deprecationDate)
+{
+	cannotBePartial();
+
+	if (static_cast<gsoap_eml2_3::_eml23__PropertyKind*>(gsoapProxy2_3)->DeprecationDate == nullptr) {
+		static_cast<gsoap_eml2_3::_eml23__PropertyKind*>(gsoapProxy2_3)->DeprecationDate = (tm*)soap_malloc(gsoapProxy2_3->soap, sizeof(tm));
+	}
+	*static_cast<gsoap_eml2_3::_eml23__PropertyKind*>(gsoapProxy2_3)->DeprecationDate = deprecationDate;
+}
+
 void PropertyKind::loadTargetRelationships()
 {
 	COMMON_NS::DataObjectReference dor = getParentPropertyKindDor();

src/eml2_3/PropertyKind.h

@@ -124,6 +124,44 @@ namespace EML2_3_NS
 		 */
 		COMMON_NS::DataObjectReference getParentPropertyKindDor() const final;
 
+		/**
+		 * Gets the date and time at which this property dictionary entry must no longer be used.
+		 * Files generated before this date would have used this entry so it is left here for reference.
+		 *
+		 * @exception	std::invalid_argument	If this instance is actually a partial object.
+		 *
+		 * @returns 	deprecationDate	The deprecation date and time of this data object.
+		 */
+		DLL_IMPORT_OR_EXPORT time_t getDeprecationDate() const;
+
+		/**
+		 * Same as {@link getDeprecationDate()}. Please use this method if you want to read some dates out of
+		 * the range of @c time_t
+		 *
+		 * @exception	std::invalid_argument	If this instance is actually a partial object.
+		 *
+		 * @returns	The deprecation date and time of the data object.
+		 */
+		DLL_IMPORT_OR_EXPORT tm getDeprecationDateAsTimeStructure() const;
+
+		/**
+		 * Sets the date and time at which this property dictionary entry must no longer be used.
+		 * Files generated before this date would have used this entry so it is left here for reference.
+		 *
+		 * @exception	std::invalid_argument	If this instance is actually a partial object.
+		 *
+		 * @param 	deprecationDate	The deprecation date and time to set to this data object.
+		*/
+		DLL_IMPORT_OR_EXPORT void setDeprecationDate(time_t deprecationDate);
+
+		/**
+		 * Same as {@link setDeprecationDate()}. Please use this method if you want to read some dates out of
+		 * the range of @c time_t
+		 *
+		 * @param 	lastUpdate	The deprecation date and time to set to this data object.
+		 */
+		DLL_IMPORT_OR_EXPORT void setDeprecationDate(const tm& lastUpdate);
+
 		/** Loads target relationships */
 		void loadTargetRelationships() final;
 

swig/swigEml2_3Include.i

@@ -2042,6 +2042,26 @@ namespace EML2_3_NS
 	class PropertyKind : public EML2_NS::PropertyKind
 	{
 	public:
+
+		/**
+		 * Gets the date and time at which this property dictionary entry must no longer be used.
+		 * Files generated before this date would have used this entry so it is left here for reference.
+		 *
+		 * @exception	std::invalid_argument	If this instance is actually a partial object.
+		 *
+		 * @returns 	deprecationDate	The deprecation date and time of this data object.
+		 */
+		time_t getDeprecationDate() const;
+
+		/**
+		 * Sets the date and time at which this property dictionary entry must no longer be used.
+		 * Files generated before this date would have used this entry so it is left here for reference.
+		 *
+		 * @exception	std::invalid_argument	If this instance is actually a partial object.
+		 *
+		 * @param 	deprecationDate	The deprecation date and time to set to this data object.
+		*/
+		void setDeprecationDate(time_t deprecationDate);
 	};
 
 #if defined(SWIGJAVA) || defined(SWIGPYTHON)