server/attrsetval_templ.h: Move into Attribute_templ.h (2e968059) · Commits · tango-controls / cppTango

src/include/tango/server/Attribute_templ.h

+197 −0

Original line number	Diff line number	Diff line
		@@ -10,10 +10,12 @@
		#include <tango/server/Attribute.h>

		#include <tango/client/Database.h>
		#include <tango/server/DeviceClass.h>
		#include <tango/server/DeviceImpl.h>
		#include <tango/server/tango_clock.h>

		#include <string>
		#include <type_traits>

		namespace Tango
		{
		@@ -477,5 +479,200 @@ inline void Attribute::_extract_value(CORBA::Any &dest)
		delete_seq();
		}

		/// @cond DO_NOT_DOCUMENT

		/*
		* method: Attribute::set_value
		*
		* These methods store the attribute value inside the Attribute object, set current time as readout time
		* and calculate attribute quality factor (if warning/alarm levels are defined)
		*
		* The value will be later send to the client either as result of attribute readout of event value,
		* or utilized to define current device State (when reading device State and warning/alarm levels are defined)
		*
		* After readout or in case of failure value will be destroyed.
		*
		* When release is true, we expect p_data to be allocated with operator new for SCALAR attributes and operator new[]
		* otherwise. For the DevString's, when release is true we expect value to have been allocated with Tango::string_dup or
		* equivalent.
		*
		* @param T *p_data: pointer to value
		* @param long x=1: the attribute x dimension
		* @param long y=0: the attribute y dimension
		* @param bool release: The release flag. If true, memory pointed to by p_data will be
		* freed after being send to the client. Default value is false.
		* @exception DevFailed If the attribute data type is not coherent, enum labels are not defined, wrong size of data, or
		* wrong Enum value.
		*
		*/

		// Special set_value realisation for scalar C++11 scoped enum with short as underlying data type or old enum
		template <class T, std::enable_if_t<std::is_enum_v<T> && !std::is_same_v<T, Tango::DevState>, T> *>
		inline void Attribute::set_value(T *enum_ptr, long x, long y, bool release)
		{
		TANGO_LOG_DEBUG << "Attribute::set_value() called " << std::endl;

		//
		// Throw exception if attribute data type is not correct
		//

		if(data_type != Tango::DEV_ENUM)
		{
		delete_data_if_needed(enum_ptr, release);

		std::stringstream o;

		o << "Invalid incoming data type " << Tango::DEV_ENUM << " for attribute " << name
		<< ". Attribute data type is " << (CmdArgType) data_type << std::ends;

		TANGO_THROW_EXCEPTION(API_AttrOptProp, o.str());
		}

		bool short_enum = std::is_same_v<short, std::underlying_type_t<T>>;
		bool uns_int_enum = std::is_same_v<unsigned int, std::underlying_type_t<T>>;

		if(!short_enum && !uns_int_enum)
		{
		delete_data_if_needed(enum_ptr, release);

		std::stringstream o;
		o << "Invalid enumeration type. Supported types are C++11 scoped enum with short as underlying data type or "
		"old enum."
		<< std::endl;

		TANGO_THROW_EXCEPTION(API_IncompatibleArgumentType, o.str());
		}

		//
		// Check if the input type is an enum and if it is from the valid type
		//

		if(std::is_enum_v<T> == false)
		{
		delete_data_if_needed(enum_ptr, release);
		TANGO_THROW_EXCEPTION(API_IncompatibleArgumentType, "The input argument data type is not an enumeration");
		}

		//
		// Check if enum labels are defined
		//

		if(enum_labels.size() == 0)
		{
		delete_data_if_needed(enum_ptr, release);

		std::stringstream o;
		o << "Attribute " << name << " data type is enum but no enum labels are defined!";

		TANGO_THROW_EXCEPTION(API_AttrOptProp, o.str());
		}

		//
		// Check enum type
		//

		DeviceImpl *dev = get_att_device();
		Tango::DeviceClass *dev_class = dev->get_device_class();
		Tango::MultiClassAttribute *mca = dev_class->get_class_attr();
		Tango::Attr &att = mca->get_attr(name);

		if(!att.same_type(typeid(T)))
		{
		delete_data_if_needed(enum_ptr, release);

		std::stringstream o;
		o << "Invalid enumeration type. Requested enum type is " << att.get_enum_type();
		TANGO_THROW_EXCEPTION(API_IncompatibleArgumentType, o.str());
		}

		//
		// Check that data size is less than the given max
		//

		if((x > max_x) \|\| (y > max_y))
		{
		delete_data_if_needed(enum_ptr, release);

		std::stringstream o;

		o << "Data size for attribute " << name << " [" << x << ", " << y << "]"
		<< " exceeds given limit [" << max_x << ", " << max_y << "]" << std::ends;

		TANGO_THROW_EXCEPTION(API_AttrOptProp, o.str());
		}

		//
		// Compute data size and set default quality to valid.
		//

		dim_x = x;
		dim_y = y;
		set_data_size();
		quality = Tango::ATTR_VALID;

		//
		// Throw exception if pointer is null and data_size != 0
		//

		if(data_size != 0)
		{
		CHECK_PTR(enum_ptr, name);
		}

		if(data_size > enum_nb)
		{
		if(enum_nb != 0)
		{
		delete[] loc_enum_ptr;
		}
		loc_enum_ptr = new short[data_size];
		enum_nb = data_size;
		}

		short max_val = (short) enum_labels.size() - 1;
		for(std::uint32_t i = 0; i < data_size; i++)
		{
		loc_enum_ptr[i] = (short) enum_ptr[i];
		if(loc_enum_ptr[i] < 0 \|\| loc_enum_ptr[i] > max_val)
		{
		delete_data_if_needed(enum_ptr, release);
		enum_nb = 0;

		std::stringstream o;
		o << "Wrong value for attribute " << name << ". Element " << i << " (value = " << loc_enum_ptr[i]
		<< ") is negative or above the limit defined by the enum (" << max_val << ").";

		delete[] loc_enum_ptr;

		TANGO_THROW_EXCEPTION(API_AttrOptProp, o.str());
		}
		}

		delete_data_if_needed(enum_ptr, release);

		if((data_format == Tango::SCALAR) && (release))
		{
		attribute_value.set(std::make_unique<Tango::DevVarShortArray>(data_size, data_size, loc_enum_ptr, false));
		}
		else
		{
		attribute_value.set(std::make_unique<Tango::DevVarShortArray>(data_size, data_size, loc_enum_ptr, release));
		}

		//
		// Reset alarm flags
		//

		alarm.reset();

		//
		// Get time
		//

		set_time();
		}

		/// @endcond

		} // namespace Tango
		#endif // TANGO_SERVER_ATTRIBUTE_TEMPL_H

src/include/tango/server/CMakeLists.txt

+0 −1

Original line number	Diff line number	Diff line
		@@ -10,7 +10,6 @@ set(SERVER_HEADERS UserDefaultAttrProp.h
		Attribute.h
		AttrValue.h
		Attribute_templ.h
		attrsetval_templ.h
		AttrManip.h
		AttrProp.h
		AttrHistoryStack.h

src/include/tango/server/attrsetval_templ.h

deleted100644 → 0

+0 −216

Original line number	Diff line number	Diff line
		/*
		* SPDX-FileCopyrightText: 2014 Copyright contributors to the cppTango project
		*
		* SPDX-License-Identifier: LGPL-3.0-or-later
		*/

		#ifndef TANGO_SERVER_ATTRSETVAL_TEMPL_H
		#define TANGO_SERVER_ATTRSETVAL_TEMPL_H

		#include <tango/common/tango_type_traits.h>
		#include <tango/server/Attribute.h>
		#include <tango/server/DeviceClass.h>
		#include <tango/server/DeviceImpl.h>

		#include <type_traits>

		namespace Tango
		{

		/// @cond DO_NOT_DOCUMENT

		/*
		* method: Attribute::set_value
		*
		* These methods store the attribute value inside the Attribute object, set current time as readout time
		* and calculate attribute quality factor (if warning/alarm levels are defined)
		*
		* The value will be later send to the client either as result of attribute readout of event value,
		* or utilized to define current device State (when reading device State and warning/alarm levels are defined)
		*
		* After readout or in case of failure value will be destroyed.
		*
		* When release is true, we expect p_data to be allocated with operator new for SCALAR attributes and operator new[]
		* otherwise. For the DevString's, when release is true we expect value to have been allocated with Tango::string_dup or
		* equivalent.
		*
		* @param T *p_data: pointer to value
		* @param long x=1: the attribute x dimension
		* @param long y=0: the attribute y dimension
		* @param bool release: The release flag. If true, memory pointed to by p_data will be
		* freed after being send to the client. Default value is false.
		* @exception DevFailed If the attribute data type is not coherent, enum labels are not defined, wrong size of data, or
		* wrong Enum value.
		*
		*/

		// Special set_value realisation for scalar C++11 scoped enum with short as underlying data type or old enum
		template <class T, std::enable_if_t<std::is_enum_v<T> && !std::is_same_v<T, Tango::DevState>, T> *>
		inline void Attribute::set_value(T *enum_ptr, long x, long y, bool release)
		{
		TANGO_LOG_DEBUG << "Attribute::set_value() called " << std::endl;

		//
		// Throw exception if attribute data type is not correct
		//

		if(data_type != Tango::DEV_ENUM)
		{
		delete_data_if_needed(enum_ptr, release);

		std::stringstream o;

		o << "Invalid incoming data type " << Tango::DEV_ENUM << " for attribute " << name
		<< ". Attribute data type is " << (CmdArgType) data_type << std::ends;

		TANGO_THROW_EXCEPTION(API_AttrOptProp, o.str());
		}

		bool short_enum = std::is_same_v<short, std::underlying_type_t<T>>;
		bool uns_int_enum = std::is_same_v<unsigned int, std::underlying_type_t<T>>;

		if(!short_enum && !uns_int_enum)
		{
		delete_data_if_needed(enum_ptr, release);

		std::stringstream o;
		o << "Invalid enumeration type. Supported types are C++11 scoped enum with short as underlying data type or "
		"old enum."
		<< std::endl;

		TANGO_THROW_EXCEPTION(API_IncompatibleArgumentType, o.str());
		}

		//
		// Check if the input type is an enum and if it is from the valid type
		//

		if(std::is_enum_v<T> == false)
		{
		delete_data_if_needed(enum_ptr, release);
		TANGO_THROW_EXCEPTION(API_IncompatibleArgumentType, "The input argument data type is not an enumeration");
		}

		//
		// Check if enum labels are defined
		//

		if(enum_labels.size() == 0)
		{
		delete_data_if_needed(enum_ptr, release);

		std::stringstream o;
		o << "Attribute " << name << " data type is enum but no enum labels are defined!";

		TANGO_THROW_EXCEPTION(API_AttrOptProp, o.str());
		}

		//
		// Check enum type
		//

		DeviceImpl *dev = get_att_device();
		Tango::DeviceClass *dev_class = dev->get_device_class();
		Tango::MultiClassAttribute *mca = dev_class->get_class_attr();
		Tango::Attr &att = mca->get_attr(name);

		if(!att.same_type(typeid(T)))
		{
		delete_data_if_needed(enum_ptr, release);

		std::stringstream o;
		o << "Invalid enumeration type. Requested enum type is " << att.get_enum_type();
		TANGO_THROW_EXCEPTION(API_IncompatibleArgumentType, o.str());
		}

		//
		// Check that data size is less than the given max
		//

		if((x > max_x) \|\| (y > max_y))
		{
		delete_data_if_needed(enum_ptr, release);

		std::stringstream o;

		o << "Data size for attribute " << name << " [" << x << ", " << y << "]"
		<< " exceeds given limit [" << max_x << ", " << max_y << "]" << std::ends;

		TANGO_THROW_EXCEPTION(API_AttrOptProp, o.str());
		}

		//
		// Compute data size and set default quality to valid.
		//

		dim_x = x;
		dim_y = y;
		set_data_size();
		quality = Tango::ATTR_VALID;

		//
		// Throw exception if pointer is null and data_size != 0
		//

		if(data_size != 0)
		{
		CHECK_PTR(enum_ptr, name);
		}

		if(data_size > enum_nb)
		{
		if(enum_nb != 0)
		{
		delete[] loc_enum_ptr;
		}
		loc_enum_ptr = new short[data_size];
		enum_nb = data_size;
		}

		short max_val = (short) enum_labels.size() - 1;
		for(std::uint32_t i = 0; i < data_size; i++)
		{
		loc_enum_ptr[i] = (short) enum_ptr[i];
		if(loc_enum_ptr[i] < 0 \|\| loc_enum_ptr[i] > max_val)
		{
		delete_data_if_needed(enum_ptr, release);
		enum_nb = 0;

		std::stringstream o;
		o << "Wrong value for attribute " << name << ". Element " << i << " (value = " << loc_enum_ptr[i]
		<< ") is negative or above the limit defined by the enum (" << max_val << ").";

		delete[] loc_enum_ptr;

		TANGO_THROW_EXCEPTION(API_AttrOptProp, o.str());
		}
		}

		delete_data_if_needed(enum_ptr, release);

		if((data_format == Tango::SCALAR) && (release))
		{
		attribute_value.set(std::make_unique<Tango::DevVarShortArray>(data_size, data_size, loc_enum_ptr, false));
		}
		else
		{
		attribute_value.set(std::make_unique<Tango::DevVarShortArray>(data_size, data_size, loc_enum_ptr, release));
		}

		//
		// Reset alarm flags
		//

		alarm.reset();

		//
		// Get time
		//

		set_time();
		}

		/// @endcond

		} // namespace Tango
		#endif // TANGO_SERVER_ATTRSETVAL_TEMPL_H