QGIS API Documentation 3.32.0-Lima (311a8cb8a6)
Public Member Functions | List of all members
QgsMeshDatasetValue Class Reference

QgsMeshDatasetValue represents single dataset value. More...

#include <qgsmeshdataset.h>

Public Member Functions

 QgsMeshDatasetValue ()=default
 Default Ctor, initialize to NaN. More...
 
 QgsMeshDatasetValue (double scalar)
 Constructor for scalar value. More...
 
 QgsMeshDatasetValue (double x, double y)
 Constructor for vector value. 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.

Values may 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 79 of file qgsmeshdataset.h.

Constructor & Destructor Documentation

◆ QgsMeshDatasetValue() [1/3]

QgsMeshDatasetValue::QgsMeshDatasetValue ( double  x,
double  y 
)

Constructor for vector value.

Definition at line 55 of file qgsmeshdataset.cpp.

◆ QgsMeshDatasetValue() [2/3]

QgsMeshDatasetValue::QgsMeshDatasetValue ( double  scalar)

Constructor for scalar value.

Definition at line 59 of file qgsmeshdataset.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 104 of file qgsmeshdataset.cpp.

◆ scalar()

double QgsMeshDatasetValue::scalar ( ) const

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

Definition at line 63 of file qgsmeshdataset.cpp.

◆ set()

void QgsMeshDatasetValue::set ( double  scalar)

Sets scalar value.

Definition at line 79 of file qgsmeshdataset.cpp.

◆ setX()

void QgsMeshDatasetValue::setX ( double  x)

Sets X value.

Definition at line 84 of file qgsmeshdataset.cpp.

◆ setY()

void QgsMeshDatasetValue::setY ( double  y)

Sets Y value.

Definition at line 89 of file qgsmeshdataset.cpp.

◆ x()

double QgsMeshDatasetValue::x ( ) const

Returns x value.

Definition at line 94 of file qgsmeshdataset.cpp.

◆ y()

double QgsMeshDatasetValue::y ( ) const

Returns y value.

Definition at line 99 of file qgsmeshdataset.cpp.


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