HydroCouple  2.0.0
HydroCouple Interface Definitions
HydroCouple::IValueDefinition Class Referenceabstract

IValueDefinition describes a value returned by the getValues() function of IValueSet. More...

#include <hydrocouple.h>

Inheritance diagram for HydroCouple::IValueDefinition:
Collaboration diagram for HydroCouple::IValueDefinition:

Public Member Functions

virtual ~IValueDefinition ()=0
 ~IValueDefinition destructor More...
 
virtual type_info type () const =0
 The object types of value that will be available and is returned by the GetValues function.IPropertyChanged. More...
 
virtual hydrocouple_variant missingValue () const =0
 The value representing that data is missing. More...
 
virtual hydrocouple_variant defaultValue () const =0
 Gets the default value of the argument. More...
 
- Public Member Functions inherited from HydroCouple::IDescription
virtual ~IDescription ()=0
 IDescription::~IDescription is a virtual destructor. More...
 
virtual string caption () const =0
 Gets caption for the entity. More...
 
virtual void setCaption (const string &caption)=0
 Sets caption for the entity. More...
 
virtual string description () const =0
 Gets additional descriptive information for the entity. More...
 
virtual void setDescription (const string &description)=0
 Gets additional descriptive information for the entity. More...
 
- Public Member Functions inherited from HydroCouple::IPropertyChanged
virtual ~IPropertyChanged ()=0
 IPropertyChanged::~IPropertyChanged is a virtual destructor. More...
 
virtual void registerPropertyChangedListener (const function< void(const any &, const string &)> &propertyChangedListener)=0
 IPropertyChanged::registerPropertyChangedListener() registers a listener to be called when a property of an object changes. More...
 
virtual void deRegisterPropertyChangedListener (const function< void(const any &, const string &propertyName)> &propertyChangedListener)=0
 IPropertyChanged::deRegisterPropertyChangedListener() deregisters a listener that is called when a property of an object changes. More...
 

Detailed Description

IValueDefinition describes a value returned by the getValues() function of IValueSet.

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

Constructor & Destructor Documentation

◆ ~IValueDefinition()

virtual HydroCouple::IValueDefinition::~IValueDefinition ( )
pure virtual

~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 type_info HydroCouple::IValueDefinition::type ( ) const
pure virtual

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

Returns
the value type associated with this IValueDefinition

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