ICWFGM_Ignition Class Reference

Interface ICWFGM Ignition. More...

import "FireEngine.idl";

Collaboration diagram for ICWFGM_Ignition:

Public Member Functions
HRESULT	MT_Lock ([in] unsigned short exclusive, [in] unsigned short obtain)
HRESULT	Clone ([out, retval]ICWFGM_Ignition **fire)
HRESULT	GetIgnitionTime ([out, retval]unsigned __int64 *pVal)
HRESULT	SetIgnitionTime ([in]unsigned __int64 newVal)
HRESULT	GetAttribute ([in]unsigned short option, [out, retval]VARIANT *value)
HRESULT	SetAttribute ([in]unsigned short option, [in]VARIANT value)
HRESULT	AddIgnition ([in]unsigned short ignition_type, [in]SAFEARRAY(double) xy_pairs, [out, retval]unsigned long *index)
HRESULT	SetIgnition ([in]unsigned long index, [in]unsigned short ignition_type, [in]SAFEARRAY(double) xy_pairs)
HRESULT	SetIgnitionWKB ([in]unsigned long index, [in]SAFEARRAY(unsigned char) wkb)
HRESULT	ClearIgnition ([in]unsigned long index)
HRESULT	GetIgnitionCount ([out, retval]unsigned long *count)
HRESULT	GetIgnitionType ([in]unsigned long index, [out, retval]unsigned short *ignition_type)
HRESULT	GetIgnitionSize ([in]unsigned long index, [out, retval]unsigned long *size)
HRESULT	GetIgnition ([in]unsigned long index, [out]unsigned short *ignition_type, [out]unsigned long *size, [in, out]SAFEARRAY(double)*xy_pairs)
HRESULT	GetIgnitionWKBSize ([in]unsigned long index, [out, retval]unsigned long long *size)
HRESULT	GetIgnitionWKB ([in]unsigned long index, [in, out]SAFEARRAY(unsigned char)*wkb)
HRESULT	ImportIgnition ([in] ICWFGM_GridEngine *engine, [in] const BSTR file_path, [in] SAFEARRAY(BSTR) permissible_drivers)
HRESULT	ExportIgnition ([in] ICWFGM_GridEngine *engine, [in] const BSTR driver_name, [in] const BSTR projection, [in] const BSTR file_path)

Properties
VARIANT	UserData [get, set]

Detailed Description

Interface ICWFGM Ignition.

The ICWFGM Ignition Interface is part of FireEngine

Member Function Documentation

ICWFGM_Ignition::AddIgnition	(	[in] unsigned short	ignition_type,
		[in] SAFEARRAY(double)	xy_pairs,
		[out,retval] unsigned long *	index
	)

Adds an ignition to this scenario object.

Parameters

ignition_type	Whether it's a point, line, or polygon ignition. Valid values are: CWFGM_FIRE_IGNITION_POINT CWFGM_FIRE_IGNITION_LINE CWFGM_FIRE_IGNITION_POLYGON_OUT CWFGM_FIRE_IGNITION_POLYGON_IN
xy_pairs	2D Array of coordinates
index	Index of the newly added sub-ignition

See Also

CCWFGM_Ignition::AddIgnition

ICWFGM_Ignition::ClearIgnition

(

[in] unsigned long

index

)

This method clears the sub-ignition from this ignition set. If index = (unsigned long) -1, then all ignitions are cleared.

Parameters

index

Index of the sub-ignition to remove

See Also

CCWFGM_Ignition::ClearIgnition

ICWFGM_Ignition::Clone

(

[out, retval] ICWFGM_Ignition **

fire

)

Creates a new ignition object with all the same properties of the object being called, returns a handle to the new object in fire. This method does not attach the new fire to any scenarios that this object is attached to, nor does it simulate any fire growth to duplicate the calculated data that this object may have.

Parameters

fire	An ignition object

See Also

CCWFGM_Ignition::Clone

ICWFGM_Ignition::ExportIgnition	(	[in] ICWFGM_GridEngine *	engine,
		[in] const BSTR	driver_name,
		[in] const BSTR	projection,
		[in] const BSTR	file_path
	)

Exports the ignition to the specified file path.

Parameters

engine	Needed to convert from grid units for storage
driver_name	Determines the file format (refer to GDAL documentation for supported formats)
projection	Projection file
file_path	Path/file of the vector data

See Also

CCWFGM_Ignition::ExportIgnition

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

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

Parameters

option	Supported / valid attribute/option index supported are: CWFGM_ATTRIBUTE_LOAD_WARNING BSTR. Any warnings generated by the COM object when deserializating.
value	Return value for the attribute/option index

See Also

CCWFGM_Ignition::GetAttribute

ICWFGM_Ignition::GetIgnition	(	[in] unsigned long	index,
		[out] unsigned short *	ignition_type,
		[out] unsigned long *	size,
		[in,out] SAFEARRAY(double)*	xy_pairs
	)

This method returns the indices of the specified polygon sub-ignition at the specified index. size is adjusted as necessary to return the number of array entries used.

Parameters

index	Index of sub-ignition
ignition_type	Point, line, or poly ignition. Valid values are: CWFGM_FIRE_IGNITION_POINT CWFGM_FIRE_IGNITION_LINE CWFGM_FIRE_IGNITION_POLYGON_OUT CWFGM_FIRE_IGNITION_POLYGON_IN
size	Size of array (or number of valid elements in provided array)
xy_pairs	2D Array of coordinates

See Also

CCWFGM_Ignition::GetIgnition

ICWFGM_Ignition::GetIgnitionCount

(

[out, retval] unsigned long *

count

)

Returns the number of sub-ignitions associated with this ignition object.

Parameters

count

Number of sub-ignitions

See Also

CCWFGM_Ignition::GetIgnitionCount

ICWFGM_Ignition::GetIgnitionSize	(	[in] unsigned long	index,
		[out, retval] unsigned long *	size
	)

This method returns the number of vertices of the specified sub-ignition. Or, if the sub-ignition index is -1, then this method returns the maximum number of indices found in any of the vectors (sub-ignitions) defined by this object.

Parameters

index	Sub-ignition being queried
size	Return value

See Also

CCWFGM_Ignition::GetIgnitionSize

ICWFGM_Ignition::GetIgnitionTime ( [out, retval] unsigned __int64 *  pVal )

property

This property identifies the start time (in GMT, count of seconds since Midnight January 1, 1600) for the fire. Local time is calculated from data provided by the grid engine attached to a given scenario. This value cannot be modified when the fire object is attached to a running simulation.

Parameters

pVal	Value of IgnitionTime

See Also

CCWFGM_Ignition::GetIgnitionTime

ICWFGM_Ignition::GetIgnitionType	(	[in] unsigned long	index,
		[out, retval] unsigned short *	ignition_type
	)

Returns the type of ignition whether it be point, line, or polygon.

Parameters

index	Sub-ignition being queried
ignition_type	Return value. Valid values are: CWFGM_FIRE_IGNITION_POINT CWFGM_FIRE_IGNITION_LINE CWFGM_FIRE_IGNITION_POLYGON_OUT CWFGM_FIRE_IGNITION_POLYGON_IN

See Also

CCWFGM_Ignition::GetIgnitionType

ICWFGM_Ignition::GetIgnitionWKB	(	[in] unsigned long	index,
		[in,out] SAFEARRAY(unsigned char)*	wkb
	)

This method returns the Well Known Binary array of the sub-ignition at the specified index.

Parameters

index	Index of sub-ignition
wkb	Array used to hold the WKB array

See Also

CCWFGM_Ignition::GetIgnitionWKB

ICWFGM_Ignition::GetIgnitionWKBSize	(	[in] unsigned long	index,
		[out, retval] unsigned long long *	size
	)

This method returns the size of the WKB array that will be generated from the sub-ignition at the specified index.

Parameters

index	Index of sub-ignition
size	Size of array in bytes

See Also

CCWFGM_Ignition::GetIgnitionWKBSize

ICWFGM_Ignition::ImportIgnition	(	[in] ICWFGM_GridEngine *	engine,
		[in] const BSTR	file_path,
		[in] SAFEARRAY(BSTR)	permissible_drivers
	)

Imports an ignition from the file path specified.

Parameters

engine	Needed to convert to grid units for storage
file_path	File to import
permissible_drivers	Array of drivers (known by GDAL) identifying the file types that are allowed to be imported.

See Also

CCWFGM_Ignition::ImportIgnition

ICWFGM_Ignition::MT_Lock	(	[in] unsigned short	exclusive,
		[in] unsigned short	obtain
	)

Changes the state of the object with respect to access rights. When the object is used by an active simulation, it must not be modified. When the object is somehow modified, it must be done so in an atomic action to prevent concerns with arising from multithreading. Note that these locks are primarily needed to ensure a simulation dependency is not changed while it occurs. All routines are otherwise multi-thread safe.

Parameters

exclusive	TRUE if the requester wants a write lock, false for read/shared access
obtain	TRUE to obtain the lock, FALSE to release the lock. If this is FALSE, then the exclusive parameter must match the initial call to obtain the lock.

See Also

CCWFGM_Ignition::MT_Lock

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

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

Parameters

option	Reserved for future use.
value	Value for option.

See Also

CCWFGM_Ignition::SetAttribute

ICWFGM_Ignition::SetIgnition	(	[in] unsigned long	index,
		[in] unsigned short	ignition_type,
		[in] SAFEARRAY(double)	xy_pairs
	)

This method sets the ignition for this fire. This data cannot be modified when the fire object is attached to a running simulation. The array is 2D, and is specified as consecutive X, Y pairs. The units for x, y are in grid units, not in metres, etc.

Parameters

index	Where to insert this sub-ignition
ignition_type	Whether it's a point, line, or polygon ignition. Valid values are: CWFGM_FIRE_IGNITION_POINT CWFGM_FIRE_IGNITION_LINE CWFGM_FIRE_IGNITION_POLYGON_OUT CWFGM_FIRE_IGNITION_POLYGON_IN
xy_pairs	2D Array of coordinates

See Also

CCWFGM_Ignition::SetIgnition

ICWFGM_Ignition::SetIgnitionTime ( [in] unsigned __int64  newVal )

property

This property identifies the start time (in GMT, count of seconds since Midnight January 1, 1600) for the fire. Local time is calculated from data provided by the grid engine attached to a given scenario. This value cannot be modified when the fire object is attached to a running simulation.

Parameters

newVal

Replacement value for IgnitionTime

See Also

CCWFGM_Ignition::SetIgnitionTime

ICWFGM_Ignition::SetIgnitionWKB	(	[in] unsigned long	index,
		[in] SAFEARRAY(unsigned char)	wkb
	)

This method sets the ignition for this fire. This data cannot be modified when the fire object is attached to a running simulation. The arrray is in Well Known Binary. The units for x, y are in grid units, not in metres, etc.

Parameters

index	Where to insert this sub-ignition
wkb	An array of WKB bytes

See Also

CCWFGM_Ignition::SetIgnition

Property Documentation

Property ICWFGM_Ignition::UserData

getsetproperty

This property is unused by this object, and is available for exclusive use by the client code. It is a VARIANT value to ensure that the client code can store a pointer value (if it chooses) for use in manual subclassing this object. This value is not loaded or saved during serialization operations, and it is the responsibility of the client code to manage any value or object stored here. Access to this property is not thread-safe.

Parameters

pVal	when retrieving the property
newVal	when setting the property