core/matlab/include/engine.h

/*
 * @(#)engine.h    generated by: makeheader 5.1.3  Thu Jan 11 15:47:30 2007
 *
 *      built from: ../../src/include/copyright.h
 *              ../../src/include/pragma_interface.h
 *              ./engapi.cpp
 *              ./engapiv4.cpp
 *              ./engapiv5.cpp
 *              ./fengapi.cpp
 *              ./fengapi_stdcall.cpp
 *              ./fengapiv5.cpp
 */

#if defined(_MSC_VER) || __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ > 3)
#pragma once
#endif

#ifndef engine_h
#define engine_h


/*
 * Copyright 1984-2003 The MathWorks, Inc.
 * All Rights Reserved.
 */



/* Copyright 2003-2004 The MathWorks, Inc. */

/* Only define EXTERN_C if it hasn't been defined already. This allows
 * individual modules to have more control over managing their exports.
 */
#ifndef EXTERN_C

#ifdef __cplusplus
  #define EXTERN_C extern "C"
#else
  #define EXTERN_C extern
#endif

#endif


#include "matrix.h"     /* mx Routines used in module */


typedef struct engine Engine;   /* Incomplete definition for Engine */


/*
 * Execute matlab statement
 */
EXTERN_C int engEvalString(
    Engine  *ep,        /* engine pointer */
    const char *string  /* string for matlab t execute */
    );


/*
 * Start matlab process for single use.
 * Not currently supported on UNIX.
 */
EXTERN_C Engine *engOpenSingleUse(
             const char *startcmd, /* exec command string used to start matlab */
             void *reserved, /* reserved for future use, must be NULL */
             int *retstatus /* return status */
);


/*
 * SetVisible, do nothing since this function is only for NT 
 */ 
EXTERN_C int engSetVisible( 
          Engine *ep,        /* engine pointer */ 
          bool newVal 
          );


/* 
 * GetVisible, do nothing since this function is only for NT 
 */ 
EXTERN_C int engGetVisible( 
          Engine *ep,        /* engine pointer */ 
          bool* bVal 
          );


/* 
 * Start matlab process
 */
EXTERN_C Engine *engOpen(
    const char *startcmd /* exec command string used to start matlab */
    );


/*
 * Close down matlab server
 */
EXTERN_C int engClose(
    Engine  *ep         /* engine pointer */
    );


/*
 * Get a variable with the specified name from MATLAB's workspace
 */
EXTERN_C mxArray *engGetVariable(
    Engine  *ep,        /* engine pointer */
    const char *name    /* name of variable to get */
    );


/*
 * Put a variable into MATLAB's workspace with the specified name
 */
EXTERN_C int engPutVariable(
           Engine   *ep,        /* engine pointer */
           const char *var_name,
           const mxArray *ap   /* array pointer */
           );


/*
 * register a buffer to hold matlab text output
 */
EXTERN_C int engOutputBuffer(
    Engine  *ep,        /* engine pointer */
    char    *buffer,    /* character array to hold output */
    int     buflen      /* buffer array length */
    );


#define engOpenV4()      cannot_call_engOpenV4


#define engGetFull()     engGetFull_is_obsolete
#define engPutFull()     engPutFull_is_obsolete
#define engGetMatrix()   engGetMatrix_is_obsolete
#define engPutMatrix()   engPutMatrix_is_obsolete


#if defined(V5_COMPAT)
#define engPutArray(ep, ap)   engPutVariable(ep, mxGetName(ap), ap)
#define engGetArray(ep, name) engGetVariable(ep, name)
#else
#define engPutArray() engPutArray_is_obsolete
#define engGetArray() engGetArray_is_obsolete
#endif /* defined(V5_COMPAT) */

#endif /* engine_h */

---

GridLAB-D^TM Version 1.0

An open-source project initiated by the US Department of Energy