QGIS API Documentation  3.13.0-Master (7f54853aae)
Public Member Functions | List of all members
QgsMeshDatasetValue Class Reference

QgsMeshDatasetValue represents single dataset value. More...

#include <qgsmeshdataprovider.h>

Public Member Functions

 QgsMeshDatasetValue (double x, double y)
 Constructor for vector value. More...
 
 QgsMeshDatasetValue (double scalar)
 Constructor for scalar value. More...
 
 QgsMeshDatasetValue ()=default
 Default Ctor, initialize to NaN. More...
 
 ~QgsMeshDatasetValue ()=default
 Dtor. More...
 
bool operator== (QgsMeshDatasetValue other) const
 
double scalar () const
 Returns magnitude of vector for vector data or scalar value for scalar data. More...
 
void set (double scalar)
 Sets scalar value. More...
 
void setX (double x)
 Sets X value. More...
 
void setY (double y)
 Sets Y value. More...
 
double x () const
 Returns x value. More...
 
double y () const
 Returns y value. More...
 

Detailed Description

QgsMeshDatasetValue represents single dataset value.

could be scalar or vector. Nodata values are represented by NaNs.

Note
The API is considered EXPERIMENTAL and can be changed without a notice
Since
QGIS 3.2

Definition at line 104 of file qgsmeshdataprovider.h.

Constructor & Destructor Documentation

◆ QgsMeshDatasetValue() [1/3]

QgsMeshDatasetValue::QgsMeshDatasetValue ( double  x,
double  y 
)

Constructor for vector value.

Definition at line 61 of file qgsmeshdataprovider.cpp.

◆ QgsMeshDatasetValue() [2/3]

QgsMeshDatasetValue::QgsMeshDatasetValue ( double  scalar)

Constructor for scalar value.

Definition at line 65 of file qgsmeshdataprovider.cpp.

◆ QgsMeshDatasetValue() [3/3]

QgsMeshDatasetValue::QgsMeshDatasetValue ( )
default

Default Ctor, initialize to NaN.

◆ ~QgsMeshDatasetValue()

QgsMeshDatasetValue::~QgsMeshDatasetValue ( )
default

Dtor.

Member Function Documentation

◆ operator==()

bool QgsMeshDatasetValue::operator== ( QgsMeshDatasetValue  other) const

Definition at line 110 of file qgsmeshdataprovider.cpp.

◆ scalar()

double QgsMeshDatasetValue::scalar ( ) const

Returns magnitude of vector for vector data or scalar value for scalar data.

Definition at line 69 of file qgsmeshdataprovider.cpp.

◆ set()

void QgsMeshDatasetValue::set ( double  scalar)

Sets scalar value.

Definition at line 85 of file qgsmeshdataprovider.cpp.

◆ setX()

void QgsMeshDatasetValue::setX ( double  x)

Sets X value.

Definition at line 90 of file qgsmeshdataprovider.cpp.

◆ setY()

void QgsMeshDatasetValue::setY ( double  y)

Sets Y value.

Definition at line 95 of file qgsmeshdataprovider.cpp.

◆ x()

double QgsMeshDatasetValue::x ( ) const

Returns x value.

Definition at line 100 of file qgsmeshdataprovider.cpp.

◆ y()

double QgsMeshDatasetValue::y ( ) const

Returns y value.

Definition at line 105 of file qgsmeshdataprovider.cpp.


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