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

Description

Instances of this class represent a time extent. The time extent is a span of time going from a start time to an end time and it is returned in the metadata for time-aware services and layers.

Defined in:
AGSTimeExtent.h ( ArcGIS library)

Since
1.0
Inheritance diagram for AGSTimeExtent:

Instance Methods

(id) - initWithStart:end:
 
(BOOL) - isEqualToTimeExtent:
 
(AGSTimeExtent *) - timeExtentByOffset:units:
 

Class Methods

(NSDate *) + dateByOffsettingDate:offset:units:
 
(AGSTimeExtent *) + intersectionOfTimeExtent:andTimeExtent:
 
(AGSTimeExtent *) + timeExtentWithStart:end:
 

Properties

NSDate * end
 
NSDate * start
 

Method Documentation

+ (NSDate*) dateByOffsettingDate: (NSDate *)  date
offset: (NSInteger)  offsetValue
units: (AGSTimeIntervalUnits units 

Convenience method to get a new date by applying an offset to an existing date

Parameters
dateThe starting date
offsetValueAmount to offset starting date by
unitsThe units of the offset amount
Returns
The offset date
Since
1.8
- (id) initWithStart: (NSDate *)  start
end: (NSDate *)  end 

Initialize an AGSTimeExtent with a start and end date.

Parameters
startThe beginning date of the time extent.
endThe end date of the time extent.
Returns
A new time extent object.
Since
1.0
+ (AGSTimeExtent*) intersectionOfTimeExtent: (AGSTimeExtent *)  timeExtent1
andTimeExtent: (AGSTimeExtent *)  timeExtent2 

Convenience method to determine the overlapping period of two time extents

Since
1.8
- (BOOL) isEqualToTimeExtent: (AGSTimeExtent *)  timeExtent

Determines whether or not two time extents are equal.

Parameters
timeExtentThe time extent to compare the current extent with.
Since
1.0
- (AGSTimeExtent*) timeExtentByOffset: (NSInteger)  offsetValue
units: (AGSTimeIntervalUnits units 

Convenience method to offset a time extent by a period.

Parameters
offsetValueThe amount to offset
unitsThe units of the offset amount
Returns
The offset time extent
Since
1.8
+ (AGSTimeExtent*) timeExtentWithStart: (NSDate *)  start
end: (NSDate *)  end 

Return an initialized, auto released, time extent with the specified starting and ending points

Parameters
startThe starting point
endThe ending point
Returns
AGSTimeExtent
Since
1.8

Property Documentation

- (NSDate*) end
readnonatomiccopy

The end date for the time extent.

Since
1.0
- (NSDate*) start
readnonatomiccopy

The start date for the time extent.

Since
1.0