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:

AGSTime.h ( ArcGIS library)

Since:

1.0

List of all members.

Public Member Functions
(id)	- initWithStart:end:
(BOOL)	- isEqualToTimeExtent:
(AGSTimeExtent *)	- timeExtentByOffset:units:
Static Public Member Functions
(NSDate *)	+ dateByOffsettingDate:offset:units:
(AGSTimeExtent *)	+ intersectionOfTimeExtent:andTimeExtent:
(AGSTimeExtent *)	+ timeExtentWithStart:end:
Properties
NSDate *	end
NSDate *	start

---

Member Function 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:

	date	The starting date
	offsetValue	Amount to offset starting date by
	units	The 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:

	start	The beginning date of the time extent.
	end	The 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:

timeExtent

The 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:

	offsetValue	The amount to offset
	units	The 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:

	start	The starting point
	end	The ending point

Returns:

AGSTimeExtent

Since:

1.8

---

Property Documentation

- (NSDate*) end [read, copy]

The end date for the time extent.

Since:

1.0

- (NSDate*) start [read, copy]

The start date for the time extent.

Since:

1.0