AGSTimeClassBreaksAger Class Reference


Description

Instances of this class represent symbol interpolators that use a collection of time class breaks to "age" features. Aging a feature means modifying its symbol's properties, such as size or color, depending on how old or recent its time information is, relative to the interpolator's time extent.

A class break is represented by an AGSTimeClassBreak object. Each class break is associated with a maximum relative age, a symbol size, and color. The age specifies how old a feature could be to be applicable for the class break. Thus, you can specify different symbol sizes and colors for features of different ages.

The interpolator determines the actual size and color for a feature by computing the feature's age and finding a class break appropriate for that age. Age is computed by comparing the feature's time information with the ending point of the map's time extent. When a feature's time information contains both a start time and an end time, the start time is used is used for computing the age.

Defined in:
AGSRampInterpolator.h ( ArcGIS library)
Since:
1.8
Inheritance diagram for AGSTimeClassBreaksAger:
AGSSymbolInterpolator

List of all members.

Public Member Functions

(id) - initWithTimeClassBreaks:units:
(AGSSymbol *) - interpolatedSymbolForGraphic:originalSymbol:start:end:val:
(AGSSymbol *) - interpolatedSymbolForGraphic:originalSymbol:timeExtent:date:

Static Public Member Functions

(AGSTimeClassBreaksAger *) + timeClassBreaksAgerWithTimeClassBreaks:units:

Properties

NSArray * timeClassBreaks
AGSTimeExtenttimeExtent
AGSTimeIntervalUnits units

Member Function Documentation

- (id) initWithTimeClassBreaks: (NSArray *)  timeClassBreaks
units: (AGSTimeIntervalUnits units 

Initializes an AGSTimeClassBreaksAger with an array of timeClassBreaks and time internal units.

Parameters:
timeClassBreaks The breaks associated with this ager.
units The unit of the time interval for the associated breaks.
Returns:
An initialized AGSTimeClassBreaksAger.
Since:
1.8
- (AGSSymbol*) interpolatedSymbolForGraphic: (AGSGraphic *)  graphic
originalSymbol: (AGSSymbol *)  origSymbol
start: (double)  start
end: (double)  end
val: (double)  val 

Returns an interpolated symbol for the specified feature.

Since:
1.8
- (AGSSymbol*) interpolatedSymbolForGraphic: (AGSGraphic *)  graphic
originalSymbol: (AGSSymbol *)  origSymbol
timeExtent: (AGSTimeExtent *)  timeExtent
date: (NSDate *)  valDate 

Returns an interpolated symbol for the given feature based on the feature's age relative to the given time extent.

Parameters:
graphic The feature whose age is to be considered
origSymbol The symbol used as the starting point for interpolation
timeExtent The time extent to which the feature's time information will be compared to
valDate 
Returns:
AGSSymbol representing the interpolated symbol
Since:
1.8
+ (AGSTimeClassBreaksAger*) timeClassBreaksAgerWithTimeClassBreaks: (NSArray *)  timeClassBreaks
units: (AGSTimeIntervalUnits units 

Initializes an autoreleased AGSTimeClassBreaksAger with an array of timeClassBreaks and time internal units.

Parameters:
timeClassBreaks The breaks associated with this ager.
units The unit of the time interval for the associated breaks.
Returns:
An initialized, autoreleased AGSTimeClassBreaksAger.
Since:
1.8

Property Documentation

- (NSArray*) timeClassBreaks [read, retain]

The time class breaks. This is an array of AGSTimeClassBreak objects.

Since:
1.8
- (AGSTimeExtent*) timeExtent [read, write, retain]

The time extent for which the age of each break is relative to.

Since:
1.8
- (AGSTimeIntervalUnits) units [read, assign]

The time interval units for which the age of the breaks are in.

Since:
1.8