summaryrefslogtreecommitdiff
path: root/src/components/smart_objects/include/smart_objects/number_schema_item.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/components/smart_objects/include/smart_objects/number_schema_item.h')
-rw-r--r--src/components/smart_objects/include/smart_objects/number_schema_item.h179
1 files changed, 179 insertions, 0 deletions
diff --git a/src/components/smart_objects/include/smart_objects/number_schema_item.h b/src/components/smart_objects/include/smart_objects/number_schema_item.h
new file mode 100644
index 0000000000..f5dd8ba42b
--- /dev/null
+++ b/src/components/smart_objects/include/smart_objects/number_schema_item.h
@@ -0,0 +1,179 @@
+/*
+ * Copyright (c) 2014, Ford Motor Company
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * Neither the name of the Ford Motor Company nor the names of its contributors
+ * may be used to endorse or promote products derived from this software
+ * without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef SRC_COMPONENTS_SMART_OBJECTS_INCLUDE_SMART_OBJECTS_NUMBER_SCHEMA_ITEM_H_
+#define SRC_COMPONENTS_SMART_OBJECTS_INCLUDE_SMART_OBJECTS_NUMBER_SCHEMA_ITEM_H_
+
+#include <typeinfo>
+
+#include "utils/shared_ptr.h"
+#include "smart_objects/default_shema_item.h"
+#include "smart_objects/schema_item_parameter.h"
+
+namespace NsSmartDeviceLink {
+namespace NsSmartObjects {
+/**
+ * @brief Number schema item.
+ * @tparam NumberType Number type.
+ **/
+template<typename NumberType>
+class TNumberSchemaItem : public CDefaultSchemaItem<NumberType> {
+ public:
+ /**
+ * @brief Create a new schema item.
+ * @param MinValue Minimum allowed value.
+ * @param MaxValue Maximum allowed value.
+ * @param DefaultValue Default value.
+ * @return Shared pointer to a new schema item.
+ **/
+ static utils::SharedPtr<TNumberSchemaItem> create(
+ const TSchemaItemParameter<NumberType>& MinValue = TSchemaItemParameter <NumberType > (),
+ const TSchemaItemParameter<NumberType>& MaxValue = TSchemaItemParameter <NumberType > (),
+ const TSchemaItemParameter<NumberType>& DefaultValue =
+ TSchemaItemParameter<NumberType>());
+
+ /**
+ * @brief Validate smart object.
+ * @param Object Object to validate.
+ * @return NsSmartObjects::Errors::eType
+ **/
+ Errors::eType validate(const SmartObject& Object) OVERRIDE;
+
+ private:
+ /**
+ * @brief Get smart type for this NumberType.
+ * @return Smart type for this NumberType.
+ **/
+ SmartType getSmartType() const OVERRIDE;
+ NumberType getDefaultValue() const OVERRIDE;
+ /**
+ * @brief Constructor.
+ *
+ * @param MinValue Minimum allowed value.
+ * @param MaxValue Maximum allowed value.
+ * @param DefaultValue Default value.
+ **/
+ TNumberSchemaItem(const TSchemaItemParameter<NumberType>& MinValue,
+ const TSchemaItemParameter<NumberType>& MaxValue,
+ const TSchemaItemParameter<NumberType>& DefaultValue);
+ bool isNumberType(SmartType type);
+
+ /**
+ * @brief Minimum and Maximum allowed values.
+ **/
+ const TSchemaItemParameter<NumberType> mMinValue;
+ const TSchemaItemParameter<NumberType> mMaxValue;
+ DISALLOW_COPY_AND_ASSIGN(TNumberSchemaItem);
+};
+
+template<typename NumberType>
+utils::SharedPtr<TNumberSchemaItem<NumberType> >
+TNumberSchemaItem<NumberType>::create(
+ const TSchemaItemParameter<NumberType>& MinValue,
+ const TSchemaItemParameter<NumberType>& MaxValue,
+ const TSchemaItemParameter<NumberType>& DefaultValue) {
+ return new TNumberSchemaItem<NumberType>(MinValue, MaxValue, DefaultValue);
+}
+
+template<typename NumberType>
+bool TNumberSchemaItem<NumberType>::isNumberType(SmartType type) {
+ return SmartType_Integer == type || SmartType_Double == type;
+}
+
+template<typename NumberType>
+Errors::eType TNumberSchemaItem<NumberType>::validate(const SmartObject& Object) {
+ if (!isNumberType(Object.getType())) {
+ return Errors::INVALID_VALUE;
+ }
+ NumberType value;
+ if (typeid(int32_t) == typeid(value)) {
+ value = Object.asInt();
+ } else if (typeid(uint32_t) == typeid(value)) {
+ value = Object.asUInt();
+ } else if (typeid(double) == typeid(value)) {
+ value = Object.asDouble();
+ } else if (typeid(int64_t) == typeid(value)) {
+ value = Object.asInt64();
+ } else {
+ NOTREACHED();
+ }
+
+ NumberType rangeLimit;
+ if (mMinValue.getValue(rangeLimit) && (value < rangeLimit)) {
+ return Errors::OUT_OF_RANGE;
+ }
+
+ if (mMaxValue.getValue(rangeLimit) && (value > rangeLimit)) {
+ return Errors::OUT_OF_RANGE;
+ }
+ return Errors::OK;
+}
+
+template<typename NumberType>
+TNumberSchemaItem<NumberType>::TNumberSchemaItem(
+ const TSchemaItemParameter<NumberType>& MinValue,
+ const TSchemaItemParameter<NumberType>& MaxValue,
+ const TSchemaItemParameter<NumberType>& DefaultValue)
+ : CDefaultSchemaItem<NumberType>(DefaultValue),
+ mMinValue(MinValue),
+ mMaxValue(MaxValue) {
+}
+
+template<typename NumberType>
+NumberType TNumberSchemaItem<NumberType>::getDefaultValue() const {
+ return NumberType(0);
+}
+
+/**
+ * @brief Specialization of getSmartType for number types.
+ * @return SmartType.
+ **/
+template<typename NumberType>
+SmartType TNumberSchemaItem<NumberType>::getSmartType() const {
+ DCHECK(!"Wrong type of template class");
+ return SmartType_Invalid;
+}
+template<>
+SmartType TNumberSchemaItem<int32_t>::getSmartType() const;
+
+template<>
+SmartType TNumberSchemaItem<uint32_t>::getSmartType() const;
+
+template<>
+SmartType TNumberSchemaItem<uint32_t>::getSmartType() const;
+
+template<>
+SmartType TNumberSchemaItem<double>::getSmartType() const;
+
+} // namespace NsSmartObjects
+} // namespace NsSmartDeviceLink
+#endif // SRC_COMPONENTS_SMART_OBJECTS_INCLUDE_SMART_OBJECTS_NUMBER_SCHEMA_ITEM_H_