Interface CWFGM FBPFuel. More...

import "FuelCom.idl";

Collaboration diagram for ICWFGM_FBPFuel:

Public Member Functions
HRESULT	SetDefaultCLSID ([in] CLSID *clsId)

HRESULT	GetEquation ([in] unsigned short equationKey, [out, retval] unsigned short *equation)

HRESULT	SetEquation ([in] unsigned short equationKey, [in] unsigned short equation)

Public Member Functions inherited from ICWFGM_Fuel
HRESULT	MT_Lock ([in] unsigned short exclusive, [in] unsigned short obtain)

HRESULT	Clone ([out]ICWFGM_Fuel **newFuel)

HRESULT	FMC ([in]double latitude, [in]double longitude, [in]double elev, [in]unsigned short day, [out, retval]double *fmc)

HRESULT	CalculateROSValues ([in]double GS, [in]double SAZ, [in]double WS, [in]double WAZ, [in]double BUI, [in]double FMC, [in]double FFMC, [in]double fF, [in]ULONGLONG time, [in]ULONGLONG ffmc_time, [in] short flag, [out]double rss, [out]double roseq, [out]double ros, [out]double frss, [out]double froseq, [out]double fros, [out]double brss, [out]double broseq, [out]double bros, [out]double wsv, [out]double *raz)

HRESULT	CalculateFCValues ([in]double FFMC, [in]double BUI, [in]double FMC, [in]double RSS, [in]double ROS, [in]short flag, [out]double cfb, [out]double cfc, [out]double rso, [out]double csi, [out]double sfc, [out]double tfc, [out]double *fi)

HRESULT	CalculateStatistics ([in]double ROS, [in]double FROS, [in]double BROS, [in]double CFB, [in]ULONGLONG time, [in]short flag, [out]double area, [out]double perimeter)

HRESULT	CalculateDistances ([in]double ROS, [in]double FROS, [in]double BROS, [in]double CFB, [in]ULONGLONG time, [in]short flag, [out]double dhead, [out]double dflank, [out]double *dback)

HRESULT	ISF ([in]double RSF, [in]double SF, [in]double ISZ, [in]short flag,[out]double *isfValue)

HRESULT	SFC ([in] double FFMC, [in] double BUI, [in] short flag, [out, retval] double *sfc)

HRESULT	RSI ([in]double FFMC, [in]double BUI, [in]double FMC, [in]double ISI, [in] short flag, [out, retval]double *rsi)

HRESULT	IsConiferFuelType ([out, retval] VARIANT_BOOL *retbool)

HRESULT	IsDeciduousFuelType ([out, retval] VARIANT_BOOL *retbool)

HRESULT	IsMixedFuelType ([out, retval] VARIANT_BOOL *retbool)

HRESULT	IsGrassFuelType ([out, retval] VARIANT_BOOL *retbool)

HRESULT	IsC6FuelType ([out, retval] VARIANT_BOOL *retbool)

HRESULT	IsMixedDeadFirFuelType ([out, retval]VARIANT_BOOL *retbool)

HRESULT	IsSlashFuelType ([out, retval]VARIANT_BOOL *retbool)

HRESULT	IsNonFuel ([out, retval] VARIANT_BOOL *retbool)

HRESULT	GetDefaultCLSID ([out, retval] CLSID *clsId)

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

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

Properties
BSTR	Name `[set]`

ICWFGM_Fuel	C2 `[get, set]`

ICWFGM_Fuel	D1 `[get, set]`

ICWFGM_AccelAttribute	CustomEquation_Accel `[get, set]`

ICWFGM_FMCAttribute	CustomEquation_FMC `[get, set]`

ICWFGM_SFCAttribute	CustomEquation_SFC `[get, set]`

ICWFGM_TFCAttribute	CustomEquation_TFC `[get, set]`

ICWFGM_CFBAttribute	CustomEquation_CFB `[get, set]`

ICWFGM_RSIAttribute	CustomEquation_RSI `[get, set]`

ICWFGM_ISFAttribute	CustomEquation_ISF `[get, set]`

ICWFGM_LBAttribute	CustomEquation_LB `[get, set]`

Properties inherited from ICWFGM_Fuel
BSTR	Name `[get]`

VARIANT	UserData `[get, set]`

Detailed Description

Interface CWFGM FBPFuel.

ICWFGM_FBPFuel defines properties and methods to modify and examine various aspects of the fuel type.

Member Function Documentation

ICWFGM_FBPFuel::GetEquation	(	[in] unsigned short	equationKey,
		[out, retval] unsigned short *	equation
	)

Given a request for a specific type of equation, retrieves the index for the specific equation (set) used for a particular calculation.

Parameters

equationKey	One of the following values, as defined in FuelCOM_ext.h FUELCOM_EQUATION_FMC FUELCOM_EQUATION_SFC FUELCOM_EQUATION_SFC_GREENUP FUELCOM_EQUATION_TFC FUELCOM_EQUATION_TFC_GREENUP FUELCOM_EQUATION_RSI FUELCOM_EQUATION_RSI_GREENUP FUELCOM_EQUATION_ISF FUELCOM_EQUATION_ISF_GREENUP FUELCOM_EQUATION_CFB FUELCOM_EQUATION_CFB_GREENUP FUELCOM_EQUATION_ACCEL FUELCOM_EQUATION_LB
equation	Index of the requested equation. Refer to the following table for equation indices and what they refer to.

ICWFGM_FBPFuel::SetDefaultCLSID ( [in] CLSID * clsID )

Sets the default CLSID. Typically this value identifies the original read-only fuel type used to create/clone the fuel type, but can be used to store any value (because this value is unused by this COM DLL).

Parameters

clsID return value for CLSID

ICWFGM_FBPFuel::SetEquation	(	[in] unsigned short	equationKey,
		[in] unsigned short	equation
	)

Requests to change a specific equation defining part of the operations for the fuel type. If the request matches the type of the current equation, then nothing is performed. Once a given equation format has been chosen, virtually any coefficient or attribute of that equation (set) can be modified using the method SetAttribute.

Parameters

equationKey	One of the following values, as defined in FuelCOM_ext.h FUELCOM_EQUATION_FMC FUELCOM_EQUATION_SFC FUELCOM_EQUATION_SFC_GREENUP FUELCOM_EQUATION_TFC FUELCOM_EQUATION_TFC_GREENUP FUELCOM_EQUATION_RSI FUELCOM_EQUATION_RSI_GREENUP FUELCOM_EQUATION_ISF FUELCOM_EQUATION_ISF_GREENUP FUELCOM_EQUATION_CFB FUELCOM_EQUATION_CFB_GREENUP FUELCOM_EQUATION_ACCEL FUELCOM_EQUATION_LB
equation	The index identifying the equation to be set. Refer to the following table for equestion indices and what they refer to.

Property Documentation

Property ICWFGM_FBPFuel::C2

getsetproperty

This property is used only for M-1, M-2 fuel types. They define extra parameters that are needed for those fuel types. For any other fuel types, these parameters are unused. C-2 and D-1 are pointers to ICWFGM_Fuel objects which represent the appropriate fuel type.
If the fuel type is not mixed (or modified), then attempts to get or set these parameters will result in a returned error code.
Retrieval of C-2 or D-1 pointer values does not modify the COM reference counter for either of these objects. Assignment will increment the reference counter for the new object and decrement the reference counter for the old object.

Parameters

pVal	When retrieving the property.
newVal	When setting the property.

ICWFGM_AccelAttribute ICWFGM_FBPFuel::CustomEquation_Accel

getsetproperty

ICWFGM_CFBAttribute ICWFGM_FBPFuel::CustomEquation_CFB

getsetproperty

ICWFGM_FMCAttribute ICWFGM_FBPFuel::CustomEquation_FMC

getsetproperty

ICWFGM_ISFAttribute ICWFGM_FBPFuel::CustomEquation_ISF

getsetproperty

ICWFGM_LBAttribute ICWFGM_FBPFuel::CustomEquation_LB

getsetproperty

ICWFGM_RSIAttribute ICWFGM_FBPFuel::CustomEquation_RSI

getsetproperty

ICWFGM_SFCAttribute ICWFGM_FBPFuel::CustomEquation_SFC

getsetproperty

ICWFGM_TFCAttribute ICWFGM_FBPFuel::CustomEquation_TFC

getsetproperty

Property ICWFGM_FBPFuel::D1

getsetproperty

This property is used only for M-1, M-2 fuel types. They define extra parameters that are needed for those fuel types. For any other fuel types, these parameters are unused. C-2 and D-1 are pointers to ICWFGM_Fuel objects which represent the appropriate fuel type.
If the fuel type is not mixed (or modified), then attempts to get or set these parameters will result in a returned error code.
Retrieval of C-2 or D-1 pointer values does not modify the COM reference counter for either of these objects. Assignment will increment the reference counter for the new object and decrement the reference counter for the old object.

Parameters

pVal	When retrieving the property.
newVal	When setting the property.

Property ICWFGM_FBPFuel::Name

setproperty

Set the fuel type name

Parameters

newVal New name for the fuel type

See Also: ICWFGM_Fuel::Name

COM Programmer Documentation

Public Member Functions

Properties

Detailed Description

Member Function Documentation

Property Documentation