QSAS_2_4/QSAS_dist/src/Ext/CorrelationCoefficient/CorCoefPlug.h File Reference

#include <stdio.h>
#include <math.h>
#include <string.h>
#include <stdlib.h>
#include "qplug_if.h"
#include "Qdos.h"
#include "qdutil.h"
#include "IndexTSSubset.h"
#include "CorCoefPlug_utils.h"
#include "CorCoef.h"

Classes
struct	CorCoefPlug_ptrs_s
Defines
#define	CORCOEFPLUG
#define	VERBOSE
#define	VERBOSE_PLUG
Typedefs
typedef struct CorCoefPlug_ptrs_s	CorCoefPlug_ptrs
typedef enum CorCoefPlugReturnStatus_e	CorCoefPlugReturnStatus
Enumerations
enum	CorCoefPlugReturnStatus_e {   CORCOEF_PLUG_ERROR_UNDEFINED, CORCOEF_PLUG_CHECK_INPUT_ERROR, CORCOEF_PLUG_SUBSET_ERROR, CORCOEF_PLUG_CREATE_OUTPUT_FAIL,   CORCOEF_PLUG_SUCCESS }
Functions
CorCoefPlugReturnStatus	CorCoefPlug_ini (CorCoefPlug_ptrs *)
CorCoefPlugReturnStatus	CorCoefPlug_checkload_input (QplugArgList *, CorCoefPlug_ptrs *)
CorCoefPlugReturnStatus	CorCoefPlug_SubsetXY (CorCoefPlug_ptrs *)
CorCoefPlugReturnStatus	CorCoefPlug_create_out_DOs (QplugArgList *, CorCoefPlug_ptrs *)
QplugReturnStatus	CorCoefPlug_cleanup (QplugReturnStatus, CorCoefPlug_ptrs *)
QplugReturnStatus	CorCoefStart (QplugArgList *)
Variables
static const char *	CorCoefPlugReturnMessage [5]

---

Define Documentation

#define CORCOEFPLUG

#define VERBOSE

#define VERBOSE_PLUG

---

Typedef Documentation

typedef struct CorCoefPlug_ptrs_s CorCoefPlug_ptrs

typedef enum CorCoefPlugReturnStatus_e CorCoefPlugReturnStatus

---

Enumeration Type Documentation

enum CorCoefPlugReturnStatus_e

Enumerator:

CORCOEF_PLUG_ERROR_UNDEFINED
CORCOEF_PLUG_CHECK_INPUT_ERROR
CORCOEF_PLUG_SUBSET_ERROR
CORCOEF_PLUG_CREATE_OUTPUT_FAIL
CORCOEF_PLUG_SUCCESS

---

Function Documentation

CorCoefPlugReturnStatus CorCoefPlug_checkload_input	(	QplugArgList *	,
		CorCoefPlug_ptrs *
	)

QplugReturnStatus CorCoefPlug_cleanup	(	QplugReturnStatus	,
		CorCoefPlug_ptrs *
	)

CorCoefPlugReturnStatus CorCoefPlug_create_out_DOs	(	QplugArgList *	,
		CorCoefPlug_ptrs *
	)

CorCoefPlugReturnStatus CorCoefPlug_ini

(

CorCoefPlug_ptrs *

)

CorCoefPlugReturnStatus CorCoefPlug_SubsetXY

(

CorCoefPlug_ptrs *

)

QplugReturnStatus CorCoefStart

(

QplugArgList *

)

---

Variable Documentation

const char* CorCoefPlugReturnMessage[5] [static]

Initial value:

 
   { "CorCoefPlug>> Error zero undefined\n",
     "CorCoefPlug>> Input type check/load failed\n",
     "CorCoefPlug>> Subset failure - fatal\n",
     "CorCoefPlug>> Failed to create output data object\n",
     "CorCoefPlug >> Success\n"}