10.2.5: AGSMosaicRule Class Reference
10.2.5
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Properties Macros Pages
AGSMosaicRule Class Reference

Description

Specifies the mosaic rule when defining how individual images should be mosaicked. It specifies selection, mosaic method, sort order, overlapping pixel resolution, etc. Mosaic rules are for mosaicking rasters in the mosaic dataset. A mosaic rule is used to define:

  • The selection of rasters that will participate in the mosaic (using the where clause).
  • The mosaic method, e.g. how the selected rasters are ordered.
  • The mosaic operation, e.g. how overlapping pixels at the same location are resolved.

Defined in:
AGSMosaicRule.h ( ArcGIS library)

Since
1.8
Inheritance diagram for AGSMosaicRule:
<AGSCoding>

Instance Methods

(void) - decodeWithJSON:
 
(NSDictionary *) - encodeToJSON
 
(id) - initWithJSON:
 

Properties

BOOL ascending
 
NSArray * lockRasterIds
 
AGSMosaicMethod method
 
NSArray * objectIds
 
AGSMosaicOperationType operation
 
NSString * sortField
 
NSString * sortValue
 
AGSPointviewpoint
 
NSString * where
 
NSString * whereClause
 

Method Documentation

- (void) decodeWithJSON: (NSDictionary *)  json
optionalinherited

Decode object from JSON representation.

Parameters
jsonThe JSON representation of the object to be decoded.
Since
1.0
- (NSDictionary *) encodeToJSON
optionalinherited

Encode and return JSON representation for object.

Returns
JSON representation of object.
Since
1.0
- (id) initWithJSON: (NSDictionary *)  json
optionalinherited

Initialize and return object from JSON representation.

Parameters
jsonThe JSON representation of the object to be created.
Returns
Object decoded from JSON representation.
Since
1.0

Reimplemented in AGSWebMapFeatureCollection.

Property Documentation

- (BOOL) ascending
readwritenonatomicassign

Indicates whether the sort should be ascending or not.

Since
1.8
- (NSArray*) lockRasterIds
readwritenonatomiccopy

An array of raster Ids. All the rasters with the given list of raster Ids are selected to participate in the mosaic. The rasters will be visible at all pixel sizes regardless of the minimum and maximum pixel size range of the locked rasters.

Since
1.8
- (AGSMosaicMethod) method
readwritenonatomicassign

The mosaic method determines how the selected rasters are ordered. See AGSMosaicMethod for a list of valid values.

Since
1.8
- (NSArray*) objectIds
readwritenonatomiccopy

Defines a selection using a set of ObjectIds. This property applies to all mosaic methods.

Since
1.8
- (AGSMosaicOperationType) operation
readwritenonatomicassign

Defines the mosaic operation used to resolve overlapping pixels. See AGSMosaicOperationType for a list of valid values.

Since
1.8
- (NSString*) sortField
readwritenonatomiccopy

The name of the attribute field that is used together with a constant sortValue to define the mosaicking order when the mosaic method is set to AGSMosaicMethodAttribute.

Since
1.8
- (NSString*) sortValue
readwritenonatomiccopy

A constant value defining a reference or base value for the sort field when the mosaic method is set to AGSMosaicMethodAttribute.

Since
1.8
- (AGSPoint*) viewpoint
readwritenonatomicstrong

Defines the viewpoint location on which the ordering is defined based on the distance from the viewpoint and the nadir of rasters.

Since
1.8
- (NSString*) where
readwritenonatomiccopy

The where clause determines which rasters will participate in the mosaic. This property applies to all mosaic methods.

Since
1.8
Deprecated:
Deprecated at 10.2.5. Please use AGSMosaicRule::whereClause instead.
- (NSString*) whereClause
readwritenonatomiccopy

The where clause determines which rasters will participate in the mosaic. This property applies to all mosaic methods.

Since
10.2.5