HydroCouple::IValueDefinition Class Reference

IValueDefinition describes the type and properties of values returned by IComponentDataItem::getValue() and related methods. More...

#include <hydrocouple.h>

Inheritance diagram for HydroCouple::IValueDefinition:

Collaboration diagram for HydroCouple::IValueDefinition:

Public Member Functions
virtual	~IValueDefinition ()=default
	~IValueDefinition destructor
virtual const std::type_info &	type () const =0
	Gets the object types of value that will be available and is returned by the GetValues function.
virtual hydrocouple_variant	missingValue () const =0
	The value representing that data is missing.
virtual hydrocouple_variant	defaultValue () const =0
	Gets the default value of the argument.
Public Member Functions inherited from HydroCouple::IDescription
virtual	~IDescription ()=default
	IDescription::~IDescription is a virtual destructor.
virtual const std::string &	caption () const =0
	Gets caption for the entity.
virtual void	setCaption (const std::string &caption)=0
	Sets caption for the entity.
virtual const std::string &	description () const =0
	Gets additional descriptive information for the entity.
virtual void	setDescription (const std::string &description)=0
	Gets additional descriptive information for the entity.
Public Member Functions inherited from HydroCouple::IPropertyChanged
virtual	~IPropertyChanged ()=default
	IPropertyChanged::~IPropertyChanged is a virtual destructor.
Public Member Functions inherited from HydroCouple::ISignal< std::string >
virtual	~ISignal ()=default
	ISignal::~ISignal is a virtual destructor.
virtual void	connect (const std::shared_ptr< ISlot< Args... > > &slot)=0
	connect is used to connect a slot to the signal.
virtual void	disconnect (const std::shared_ptr< ISlot< Args... > > &slot)=0
	disconnect is used to disconnect a slot from the signal.
virtual void	blockSignals (bool block)=0
	blockSignals is used to block signals from being emitted.

Additional Inherited Members
Protected Member Functions inherited from HydroCouple::ISignal< std::string >
virtual void	emit (Args... args)=0
	emit is used to emit the signal.

Detailed Description

IValueDefinition describes the type and properties of values returned by IComponentDataItem::getValue() and related methods.

This interface is not meant to be implemented directly. Instead, implement either IQuality or IQuantity or a custom derived value definition interface.

Constructor & Destructor Documentation

~IValueDefinition()

virtual HydroCouple::IValueDefinition::~IValueDefinition ( )

virtualdefault

~IValueDefinition destructor

Member Function Documentation

defaultValue()

virtual hydrocouple_variant HydroCouple::IValueDefinition::defaultValue ( ) const

pure virtual

Gets the default value of the argument.

missingValue()

virtual hydrocouple_variant HydroCouple::IValueDefinition::missingValue ( ) const

pure virtual

The value representing that data is missing.

type()

virtual const std::type_info & HydroCouple::IValueDefinition::type ( ) const

pure virtual

Gets the object types of value that will be available and is returned by the GetValues function.

Returns

A const reference to the type_info associated with this IValueDefinition.

---

The documentation for this class was generated from the following file:

• /home/runner/work/HydroCouple/HydroCouple/HydroCouple/include/hydrocouple.h