com.esri.arcgis.spatialanalyst
Interface IGPSATimeConfiguration

All Superinterfaces:

Serializable

All Known Implementing Classes:

GPSATimeConfiguration

public interface IGPSATimeConfiguration
extends Serializable

Provides access to the time configuration object used for solar radiation.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Method Summary

int	getType() Time configuration type of time configuration parameters.
void	setDefault() Sets default time configuration parameters.
void	setMultiDays(int year, int startDay, int endDay) Sets Multi-Days in time configuration parameters.
void	setSpecialDays() Sets Special-Days in time configuration parameters.
void	setWholeYear(int year) Sets Whole-Year in time configuration parameters.
void	setWithinDay(int day, double startTime, double endTime) Sets Within-Day in time configuration parameters.

Method Detail

setDefault

void setDefault()
                throws IOException,
                       AutomationException

Sets default time configuration parameters.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWithinDay

void setWithinDay(int day,
                  double startTime,
                  double endTime)
                  throws IOException,
                         AutomationException

Sets Within-Day in time configuration parameters.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Parameters:

day - The day (in)

startTime - The startTime (in)

endTime - The endTime (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSpecialDays

void setSpecialDays()
                    throws IOException,
                           AutomationException

Sets Special-Days in time configuration parameters.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMultiDays

void setMultiDays(int year,
                  int startDay,
                  int endDay)
                  throws IOException,
                         AutomationException

Sets Multi-Days in time configuration parameters.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Parameters:

year - The year (in)

startDay - The startDay (in)

endDay - The endDay (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWholeYear

void setWholeYear(int year)
                  throws IOException,
                         AutomationException

Sets Whole-Year in time configuration parameters.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Parameters:

year - The year (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getType

int getType()
            throws IOException,
                   AutomationException

Time configuration type of time configuration parameters.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Returns:

A com.esri.arcgis.spatialanalyst.esriSolarTimeConfigEnum constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.