QGIS API Documentation  3.23.0-Master (dd0cd13a00)
Public Member Functions | List of all members
QgsMeshDataset Class Referenceabstract

Abstract class that represents a dataset. More...

#include <qgsmeshdataset.h>

Inheritance diagram for QgsMeshDataset:
Inheritance graph
[legend]

Public Member Functions

 QgsMeshDataset ()=default
 Constructor. More...
 
virtual ~QgsMeshDataset ()=default
 Destructor. More...
 
virtual QgsMeshDataBlock areFacesActive (int faceIndex, int count) const =0
 Returns whether faces are active. More...
 
virtual QgsMeshDatasetValue datasetValue (int valueIndex) const =0
 Returns the value with index valueIndex. More...
 
virtual QgsMeshDataBlock datasetValues (bool isScalar, int valueIndex, int count) const =0
 Returns count values from valueIndex. More...
 
virtual bool isActive (int faceIndex) const =0
 Returns whether the face is active. More...
 
virtual QgsMeshDatasetMetadata metadata () const =0
 Returns the metadata of the dataset. More...
 
virtual int valuesCount () const =0
 Returns the values count. More...
 

Detailed Description

Abstract class that represents a dataset.

Since
QGIS 3.16

Definition at line 543 of file qgsmeshdataset.h.

Constructor & Destructor Documentation

◆ QgsMeshDataset()

QgsMeshDataset::QgsMeshDataset ( )
default

Constructor.

◆ ~QgsMeshDataset()

virtual QgsMeshDataset::~QgsMeshDataset ( )
virtualdefault

Destructor.

Member Function Documentation

◆ areFacesActive()

virtual QgsMeshDataBlock QgsMeshDataset::areFacesActive ( int  faceIndex,
int  count 
) const
pure virtual

Returns whether faces are active.

Implemented in QgsMeshVerticesElevationDataset, QgsMeshMemoryDataset, and QgsMeshZValueDataset.

◆ datasetValue()

virtual QgsMeshDatasetValue QgsMeshDataset::datasetValue ( int  valueIndex) const
pure virtual

Returns the value with index valueIndex.

Implemented in QgsMeshVerticesElevationDataset, QgsMeshMemoryDataset, and QgsMeshZValueDataset.

◆ datasetValues()

virtual QgsMeshDataBlock QgsMeshDataset::datasetValues ( bool  isScalar,
int  valueIndex,
int  count 
) const
pure virtual

Returns count values from valueIndex.

Implemented in QgsMeshVerticesElevationDataset, QgsMeshMemoryDataset, and QgsMeshZValueDataset.

◆ isActive()

virtual bool QgsMeshDataset::isActive ( int  faceIndex) const
pure virtual

Returns whether the face is active.

Implemented in QgsMeshVerticesElevationDataset, QgsMeshMemoryDataset, and QgsMeshZValueDataset.

◆ metadata()

virtual QgsMeshDatasetMetadata QgsMeshDataset::metadata ( ) const
pure virtual

Returns the metadata of the dataset.

Implemented in QgsMeshVerticesElevationDataset, QgsMeshMemoryDataset, and QgsMeshZValueDataset.

◆ valuesCount()

virtual int QgsMeshDataset::valuesCount ( ) const
pure virtual

Returns the values count.

Implemented in QgsMeshVerticesElevationDataset, QgsMeshMemoryDataset, and QgsMeshZValueDataset.


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