Collaboration diagram for API Functions:

Functions
PWP_PROTOTYPE_DECL GRDP_IMPORTER	PwCreateGrdpById (PWP_UINT32 id)
	Create GRDP importer instance with given id. More...

PWP_PROTOTYPE_DECL GRDP_IMPORTER	PwCreateGrdpByName (const char name[])
	Create GRDP importer instance with given name. More...

PWP_PROTOTYPE_DECL PWP_VOID	PwDestroyGrdp (GRDP_IMPORTER *handle)
	Destroy GRDP importer instance. More...

PWP_PROTOTYPE_DECL const char *	PwEnumGrdpFormat (PWP_UINT32 ndx, GRDP_FORMATINFO *pFormatInfo)
	Enumerate GRDP_FORMATINFO data for all supported GRDP importers. More...

PWP_PROTOTYPE_DECL PWP_UINT32	PwGetGrdpFormatCount ()
	Get the number of supported GRDP importers. More...

PWP_PROTOTYPE_DECL const char *	PwGrdpFormat (GRDP_IMPORTER handle, GRDP_FORMATINFO *pFormatInfo)
	Get GRDP_FORMATINFO data for a GRDP importer handle. More...

PWP_PROTOTYPE_DECL PWP_BOOL	PwGridRead (GRDP_IMPORTER handle, PWGM_HGRIDMODEL model, const GRDP_READINFO *pReadInfo)
	Initiates reading a grid model. More...

Detailed Description

Function Documentation

◆ PwCreateGrdpById()

PWP_PROTOTYPE_DECL GRDP_IMPORTER PwCreateGrdpById ( PWP_UINT32 id )

Create GRDP importer instance with given id.

Parameters

id	The plugin-defined GRDP importer id.

Returns: The GRDP importer handle or NULL if id is invalid.

See also: PwEnumGrdpFormat()

Note: Valid GRDP importer id's can be obtained from PwEnumGrdpFormat(pFormatInfo).

Definition at line 80 of file apiGRDP.cxx.

References grdpFindFormatById(), and grdpRuntimeCreate().

◆ PwCreateGrdpByName()

PWP_PROTOTYPE_DECL GRDP_IMPORTER PwCreateGrdpByName ( const char name[] )

Create GRDP importer instance with given name.

Parameters

name	The plugin-defined GRDP importer name.

Returns: The GRDP importer handle or NULL if name is invalid.

See also: PwEnumGrdpFormat()

Note: Valid GRDP importer names can be obtained from PwEnumGrdpFormat(pFormatInfo).

Definition at line 91 of file apiGRDP.cxx.

References grdpFindFormatByName(), and grdpRuntimeCreate().

◆ PwDestroyGrdp()

PWP_PROTOTYPE_DECL PWP_VOID PwDestroyGrdp ( GRDP_IMPORTER * handle )

Destroy GRDP importer instance.

Parameters

handle Pointer to a GRDP_IMPORTER handle obtained from PwCreateGrdpById() or PwCreateGrdpByName().

See also: PwCreateGrdpByName(), PwCreateGrdpById()

Definition at line 102 of file apiGRDP.cxx.

References grdpH2Rti(), and grdpRuntimeDestroy().

◆ PwEnumGrdpFormat()

PWP_PROTOTYPE_DECL const char* PwEnumGrdpFormat	(	PWP_UINT32	ndx,
		GRDP_FORMATINFO *	pFormatInfo
	)

Enumerate GRDP_FORMATINFO data for all supported GRDP importers.

Parameters

ndx	The format index starting with 0.
pFormatInfo	Pointer to a GRDP_FORMATINFO buffer.

Returns: The GRDP format name (same as info.name). NULL if ndx is not valid.

See also: PwGrdpFormat()

Sample usage:: GRDP_FORMATINFO info;

PWP_UINT32 ndx = 0;

while (grdp->PwEnumGrdpFormat(ndx++, &info)) {

...do something here...

}

Definition at line 115 of file apiGRDP.cxx.

References GRDP_RTITEM::FormatInfo, grdpFormatCnt, and grdpRtItem.

◆ PwGetGrdpFormatCount()

PWP_PROTOTYPE_DECL PWP_UINT32 PwGetGrdpFormatCount ( )

Get the number of supported GRDP importers.

Returns: The number of supported importers.

Definition at line 126 of file apiGRDP.cxx.

References grdpFormatCnt.

◆ PwGrdpFormat()

PWP_PROTOTYPE_DECL const char* PwGrdpFormat	(	GRDP_IMPORTER	handle,
		GRDP_FORMATINFO *	pFormatInfo
	)

Get GRDP_FORMATINFO data for a GRDP importer handle.

Parameters

handle	A GRDP_IMPORTER handle obtained from PwCreateGrdpById() or PwCreateGrdpByName().
pFormatInfo	Pointer to a GRDP_FORMATINFO buffer.

Returns: The GRDP format name (same as info.name). NULL if ndx is not valid.

See also: PwGrdpFormat()

Sample usage:: GRDP_IMPORTER h = PwCreateGrdpByName("name");

GRDP_FORMATINFO info;

if (grdp->PwGrdpFormat(h, &info)) {

...do something here...

}

Definition at line 133 of file apiGRDP.cxx.

References GRDP_RTITEM::FormatInfo, grdpH2Rti(), and GRDP_FORMATINFO::name.

◆ PwGridRead()

PWP_PROTOTYPE_DECL PWP_BOOL PwGridRead	(	GRDP_IMPORTER	handle,
		PWGM_HGRIDMODEL	model,
		const GRDP_READINFO *	pReadInfo
	)

Initiates reading a grid model.

Instructs a plugin to read the given grid model according to the specified settings.

Parameters

handle	A GRDP_IMPORTER handle obtained from PwCreateGrdpById() or PwCreateGrdpByName().
model	A PWGM_HGRIDMODEL handle. The plugin uses this handle to access the grid model data.
pReadInfo	Pointer to a GRDP_READINFO settings buffer.

Returns: PWP_FALSE if read failed.

See also: PWGM-API specification

Definition at line 175 of file apiGRDP.cxx.

References GRDP_FORMATINFO::fileDest, GRDP_READINFO::fileDest, GRDP_RTITEM::FormatInfo, grdpH2Rti(), GRDP_RTITEM::model, GRDP_RTITEM::pReadInfo, PWGM_HGRIDMODEL_ISVALID, PWP_FALSE, and runtimeReadGrid().