Skip To Content ArcGIS for Developers Sign In Dashboard

AddRastersParameters Class


Adds raster datasets to a MosaicDatasetRaster by setting various parameters. More...

Header: #include <AddRastersParameters>
Since: Esri::ArcGISRuntime 100.1
Inherited By:


Public Functions

AddRastersParameters(const AddRastersParameters &other)
AddRastersParameters(AddRastersParameters &&other)
virtual ~AddRastersParameters()
AddRastersParametersType addRastersParametersType() const
QString filter() const
QString inputDirectory() const
QString inputFile() const
double maxPixelSizeFactor() const
double minPixelSizeFactor() const
QString rasterFunctionTemplateFile() const
void setFilter(const QString &filter)
void setInputDirectory(const QString &inputDirectory)
void setInputFile(const QString &inputFile)
void setMaxPixelSizeFactor(double maxPixelSizeFactor)
void setMinPixelSizeFactor(double minPixelSizeFactor)
void setRasterFunctionTemplateFile(const QString &templateFile)
AddRastersParameters &operator=(const AddRastersParameters &other)
AddRastersParameters &operator=(AddRastersParameters &&other)

Detailed Description

Adds raster datasets to a MosaicDatasetRaster by setting various parameters.

Mosaic datasets (via the MosaicDatasetRaster class) are used to manage, display, serve, and share raster data. When you create a new mosaic dataset, it is created as an empty container in a geodatabase to which you can add raster data. The AddRastersParameters object provides the mechanism to set various properties, so that a raster can be added to a mosaic dataset via the MosaicDatasetRaster::addRasters() method.

Some of the parameters (also called properties) on the AddRastersParameters class that enable adding a raster into a mosaic dataset also include specifying the file filter type (like .tif or .jpg) of the rasters that are to be included (AddRastersParameters::filter property), the directory location of the raster files (AddRastersParameters::inputDirectory property), the minimum pixel cell size of the raster to be included (AddRastersParameters::minPixelSizeFactor property), and more.

Member Function Documentation


Default constructor. Creates an empty AddRastersParameters.

AddRastersParameters::AddRastersParameters(const AddRastersParameters &other)

Copy constructor from other AddRastersParameters.

AddRastersParameters::AddRastersParameters(AddRastersParameters &&other)

Move constructor from other AddRastersParameters.

[virtual] AddRastersParameters::~AddRastersParameters()


AddRastersParametersType AddRastersParameters::addRastersParametersType() const

Returns the AddRastersParametersType.

QString AddRastersParameters::filter() const

Returns the raster filename filter.

See also setFilter.

QString AddRastersParameters::inputDirectory() const

Returns the input directory.

See also setInputDirectory().

QString AddRastersParameters::inputFile() const

Returns the input file.

See also setInputFile().

double AddRastersParameters::maxPixelSizeFactor() const

Returns the maximum pixel size factor.

See also setMaxPixelSizeFactor().

double AddRastersParameters::minPixelSizeFactor() const

Returns the minimum pixel size factor.

See also setMinPixelSizeFactor().

QString AddRastersParameters::rasterFunctionTemplateFile() const

Returns the raster function template file.

See also setRasterFunctionTemplateFile().

void AddRastersParameters::setFilter(const QString &filter)

Sets the optional raster filename filter.

The optional raster filename filter is a regular expression with ECMA-262 grammar.

See also filter().

void AddRastersParameters::setInputDirectory(const QString &inputDirectory)

Sets the optional input directory of rasters to inputDirectory.

See also inputDirectory().

void AddRastersParameters::setInputFile(const QString &inputFile)

Sets the optional input CSV file to inputFile.

See also inputFile().

void AddRastersParameters::setMaxPixelSizeFactor(double maxPixelSizeFactor)

Sets the optional maximum pixel size factor to maxPixelSizeFactor.

See also maxPixelSizeFactor().

void AddRastersParameters::setMinPixelSizeFactor(double minPixelSizeFactor)

Sets the optional minimum pixel size factor to minPixelSizeFactor.

See also minPixelSizeFactor().

void AddRastersParameters::setRasterFunctionTemplateFile(const QString &templateFile)

Sets the optional raster function template file to templateFile.

See also rasterFunctionTemplateFile().

AddRastersParameters &AddRastersParameters::operator=(const AddRastersParameters &other)

Assignment operator from other AddRastersParameters.

AddRastersParameters &AddRastersParameters::operator=(AddRastersParameters &&other)

Move operator from other AddRastersParameters.

Feedback on this topic?