ICWFGM_WeatherGrid Class Reference

Interface ICWFGM WeatherGrid. More...

import "WeatherCom.idl";

Collaboration diagram for ICWFGM_WeatherGrid:

Public Member Functions
HRESULT	GetStreamCount ([out, retval]unsigned long *count)
HRESULT	AddStream ([in]ICWFGM_WeatherStream *stream)
HRESULT	RemoveStream ([in]ICWFGM_WeatherStream *stream)
HRESULT	StreamAtIndex ([in]unsigned long index, [out, retval]ICWFGM_WeatherStream **stream)
HRESULT	IndexOfStream ([in]ICWFGM_WeatherStream *stream, [out, retval]unsigned long *index)
HRESULT	GetAttribute ([in]unsigned short option, [out, retval]VARIANT *value)
HRESULT	SetAttribute ([in]unsigned short option, [in]VARIANT value)

Properties
ICWFGM_WeatherStream	PrimaryStream [get, set]

Detailed Description

Interface ICWFGM WeatherGrid.

    This object manages a collection weather data for a simulation engine's scenario.  It implements the GridEngine interface for communication with the simulation engine.  Since it only handles weather data, its GridEngine property should refer to an object that can provide fuel type and elevation data, latitude, longitude, etc.

In addition to the GridEngine interface, it also implements its own interface so that a client application may specify a collection of weather streams for use in a simulation. This object manages the spatial aspect of merging data together from multiple weather streams. Only one weather stream from a weather station may be associated with a weather grid at a time. This rule is imposed to avoid confusing situations to merge data from multiple streams. A stream cannot be attached to a weather grid until it is associated with a weather station, to ensure that it has a location.

Member Function Documentation

ICWFGM_WeatherGrid::AddStream

(

[in] ICWFGM_WeatherStream *

stream

)

Adds a weather stream to this weather grid.

Parameters

stream

Weather stream object.

ICWFGM_WeatherGrid::GetAttribute	(	[in] unsigned short	option,
		[out, retval] VARIANT *	value
	)

Polymorphic. This routine retrieves an attribute/option value given the attribute/option index.

Parameters

option

The attribute of interest. Valid attributes are: CWFGM_WEATHER_OPTION_ADIABATIC_IDW_EXPONENT_TEMP 64-bit floating point. Used when CWFGM_SCENARIO_OPTION_WEATHER_INTERPOLATE_SPATIAL is set. IDW power for interpolating temperature and dew point values. CWFGM_WEATHER_OPTION_IDW_EXPONENT_WS 64-bit floating point. Used when CWFGM_SCENARIO_OPTION_WEATHER_INTERPOLATE_WIND is set. IDW power for interpolating WS values. CWFGM_WEATHER_OPTION_IDW_EXPONENT_PRECIP 64-bit floating point. Used when CWFGM_SCENARIO_OPTION_WEATHER_INTERPOLATE_PRECIP is set. IDW power for interpolating precip values. CWFGM_WEATHER_OPTION_IDW_EXPONENT_FWI 64-bit floating point. Used when CWFGM_SCENARIO_OPTION_WEATHER_INTERPOLATE_SPATIAL is set. IDW power for interpolating FWI values. CWFGM_WEATHER_OPTION_FFMC_VANWAGNER Boolean. Use the Van Wagner approach to calculating HFFMC values CWFGM_WEATHER_OPTION_FFMC_LAWSON Boolean. Use the Lawson approach to calculating HFFMC values CWFGM_WEATHER_OPTION_FFMC_HYBRID Boolean. Do not use, only for experimental purposes.

value

Location for the retrieved value to be placed.

ICWFGM_WeatherGrid::GetStreamCount

(

[out, retval] unsigned long *

count

)

Returns the number of streams associated with this weather grid.

Parameters

count

Number of streams.

ICWFGM_WeatherGrid::IndexOfStream	(	[in] ICWFGM_WeatherStream *	stream,
		[out, retval] unsigned long *	index
	)

Returns the index of ‘stream' in this grid's set of streams.

Parameters

stream	Weather stream object.
index	Index to the stream.

ICWFGM_WeatherGrid::RemoveStream

(

[in] ICWFGM_WeatherStream *

stream

)

Removes an association between a weather stream and this weather grid.

Parameters

stream

Weather stream object.

ICWFGM_WeatherGrid::SetAttribute	(	[in] unsigned short	option,
		[in] VARIANT	value
	)

Sets the value of an "option" to the value of the "value" variable provided. Supported values for IDW exponents are from (0.0 to 10.0]. If 0.0 is provided for either wind or precipitation, then voronoi regions / theissen polygons are used instead of the IDW approach.

Parameters

option

The weather option of interest. Valid options are: CWFGM_WEATHER_OPTION_ADIABATIC_IDW_EXPONENT_TEMP 64-bit floating point. Used when CWFGM_SCENARIO_OPTION_WEATHER_INTERPOLATE_SPATIAL is set. IDW power for interpolating temperature and dew point values. CWFGM_WEATHER_OPTION_IDW_EXPONENT_WS 64-bit floating point. Used when CWFGM_SCENARIO_OPTION_WEATHER_INTERPOLATE_WIND is set. IDW power for interpolating WS values. CWFGM_WEATHER_OPTION_IDW_EXPONENT_PRECIP 64-bit floating point. Used when CWFGM_SCENARIO_OPTION_WEATHER_INTERPOLATE_PRECIP is set. IDW power for interpolating precip values. CWFGM_WEATHER_OPTION_IDW_EXPONENT_FWI 64-bit floating point. Used when CWFGM_SCENARIO_OPTION_WEATHER_INTERPOLATE_SPATIAL is set. IDW power for interpolating FWI values.

value

The value to set the option to.

ICWFGM_WeatherGrid::StreamAtIndex	(	[in] unsigned long	index,
		[out,retval] ICWFGM_WeatherStream **	stream
	)

Given an index value, returns a pointer to a stream associated with this grid. Note that this value is expected to be different from the stream's index for its station.

Parameters

index	Index to a weather stream
stream	Address to contain the specific requested weather stream.

Property Documentation

Property ICWFGM_WeatherGrid::PrimaryStream

getsetproperty

This property is very important for various aspects and options for spatial weather modelling. It must be specified any time more than one stream is associated with this grid (and thus, a scenario). Its affects will vary according to scenario options. If only one stream is attached, then this value will automatically be set to that scenario.

Parameters

pVal	Value of PrimaryStream.
newVal	Replacement value for PrimaryStream.