apiGRDP.h

Go to the documentation of this file.

/****************************************************************************
 *
 * Pointwise Grid Import Plugin API (GRDP-API) v1.0
 *
 * (C) 2021 Cadence Design Systems, Inc. All rights reserved worldwide.
 *
 ***************************************************************************/
 
#ifndef _APIGRDP_H_
#define _APIGRDP_H_
 
#include "apiGridModel.h"
#include "apiPWP.h"
#include "apiPWPUtils.h"
 
 
extern "C" {
 
 
/***********************************************************/
/***********************************************************/
#define GRDP_VALUE_GROUP        "SDK.Plugin.GRDP"
#define GRDP_GROUP_VALUE_NAMES  PWU_GROUP_VALUE_NAMES(GRDP_VALUE_GROUP)
#define GRDP_GROUP_VALUE_DEFNS  PWU_GROUP_VALUE_DEFNS(GRDP_VALUE_GROUP)
 
#define GRDP_INFO_GROUP         GRDP_VALUE_GROUP ".INFO"
 
 
/***********************************************************/
/***********************************************************/
/*---------------------------------------------------------*/
struct GRDP_FORMATINFO {
    const char *group;
 
    const char *name;
 
    PWP_UINT32 id;
 
    PWP_ENUM_FILEDEST fileDest;
 
    const char *exts;
};
 
 
/*---------------------------------------------------------*/
struct GRDP_READINFO {
    const char *fileDest;
 
    PWP_BOOL    importConditions;
 
    //PWP_ENUM_ENCODING encoding;
 
    //PWP_ENUM_PRECISION precision;
 
    //PWP_ENUM_DIMENSION dimension;
 
    //PWP_ENDIANNESS byteOrder;
};
 
 
/*---------------------------------------------------------*/
PWP_DECLARE_HANDLE(GRDP_IMPORTER);
 /* DOXGRP_APIGRDP_TYPES */
 
 
/***********************************************************/
/***********************************************************/
/*---------------------------------------------------------*/
PWP_PROTOTYPE_DECL GRDP_IMPORTER
PwCreateGrdpById(PWP_UINT32 id);
 
 
/*---------------------------------------------------------*/
PWP_PROTOTYPE_DECL GRDP_IMPORTER
PwCreateGrdpByName(const char name[]);
 
 
/*---------------------------------------------------------*/
PWP_PROTOTYPE_DECL PWP_VOID
PwDestroyGrdp(GRDP_IMPORTER *handle);
 
 
/*---------------------------------------------------------*/
PWP_PROTOTYPE_DECL const char*
PwEnumGrdpFormat(PWP_UINT32 ndx, GRDP_FORMATINFO *pFormatInfo);
 
 
/*---------------------------------------------------------*/
PWP_PROTOTYPE_DECL PWP_UINT32
PwGetGrdpFormatCount();
 
 
/*---------------------------------------------------------*/
PWP_PROTOTYPE_DECL const char*
PwGrdpFormat(GRDP_IMPORTER handle, GRDP_FORMATINFO *pFormatInfo);
 
 
/*---------------------------------------------------------*/
PWP_PROTOTYPE_DECL PWP_BOOL
PwGridRead(GRDP_IMPORTER handle, PWGM_HGRIDMODEL model,
            const GRDP_READINFO *pReadInfo);
 
} /* extern "C" */
 
#endif /* !_APIGRDP_H_ */