HydroCouple  2.0.0
HydroCouple Interface Definitions
HydroCouple::IQuality Class Referenceabstract

Qualitative data described items in terms of some quality or categorization that may be 'informal' or may use relatively ill-defined characteristics such as warmth and flavour. However, qualitative data can include well-defined aspects such as gender, nationality or commodity type. More...

#include <hydrocouple.h>

Inheritance diagram for HydroCouple::IQuality:
Collaboration diagram for HydroCouple::IQuality:

Public Member Functions

virtual ~IQuality ()=0
 IQuality::~IQuality is a virtual destructor. More...
 
virtual vector< hydrocouple_variantcategories () const =0
 
virtual bool isOrdered () const =0
 Checks if the IQuality is defined by an ordered set of ICategory or not. More...
 
- Public Member Functions inherited from HydroCouple::IValueDefinition
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

Qualitative data described items in terms of some quality or categorization that may be 'informal' or may use relatively ill-defined characteristics such as warmth and flavour. However, qualitative data can include well-defined aspects such as gender, nationality or commodity type.

Returns
An IQuality describes qualitative data, where a value is specified as one category within a number of predefined (possible) categories. These categories can be ordered or not.

For qualitative data the IComponentItem data exchanged between IComponents contains one of the possible ICategory instances per element in the IComponentItem involved.

Examples:

  • Colors:
    • red
    • green
    • blue
  • Land use:
    • nature
    • recreation
    • industry3
    • infrastructure
  • Rating:
    • worse
    • same
    • better

Constructor & Destructor Documentation

◆ ~IQuality()

virtual HydroCouple::IQuality::~IQuality ( )
pure virtual

IQuality::~IQuality is a virtual destructor.

Member Function Documentation

◆ categories()

virtual vector<hydrocouple_variant> HydroCouple::IQuality::categories ( ) const
pure virtual
Returns
A list of the possible ICategory allowed for this IQuality If the quality is not ordered the list contains the ICategory's in an unspecified order. When it is ordered the list contains the ICategory's in the same sequence.

◆ isOrdered()

virtual bool HydroCouple::IQuality::isOrdered ( ) const
pure virtual

Checks if the IQuality is defined by an ordered set of ICategory or not.


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