qucs_interface.h

Go to the documentation of this file.

/*
 * qucs_interface.h - m-code interface class definitions
 *
 * Copyright (C) 2003, 2004, 2005, 2006, 2007 Stefan Jahn <stefan@lkcc.org>
 *
 * This is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2, or (at your option)
 * any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this package; see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street - Fifth Floor,
 * Boston, MA 02110-1301, USA.
 *
 * $Id: analysis.h 1869 2013-03-06 12:50:21Z crobarcro $
 *
 */

#ifndef __QUCS_INTERFACE_H__
#define __QUCS_INTERFACE_H__


namespace qucs
{


enum QUCS_ERROR_CODES { NETLIST_OK,
                        NETLIST_FILE_NOT_FOUND,
                        NETLIST_FAILED_CHECK };

// forward declarations of some classes to avoid including
// header files and speed compilation
class net;
class input;
class circuit;
class dataset;
class environment;
class e_trsolver;

class qucsint
{

public:
    qucsint ();
    qucsint (char* infile);
    ~qucsint ();

    int prepare_netlist (char* infile);
    int evaluate ();
    int output (char* outfile);

protected:

    qucs::net * subnet;
    qucs::input * in;
    qucs::circuit * gnd;
    qucs::dataset * out;
    qucs::environment * root;
    int err;
    int ret;

};


/*/////////////////////////////////////////////////////////////////////////////

                            trsolver_interface



enum ETR_MODE { ETR_MODE_ASYNC, ETR_MODE_SYNC };

class trsolver_interface : public qucsint
{
public:
    trsolver_interface ();
    trsolver_interface (char* infile);
//    ~trsolver_interface ();

    void getETR(void);
    int init (double, double, int);
    bool getIsInitialised() { return isInitialised; };
    int stepsolve_sync (double synctime);
    void acceptstep_sync (void);
    int stepsolve_async (double steptime);
    void acceptstep_async (void);
    void rejectstep_async (void);
    void getsolution (double *);

    int getN ();

    int getM ();

    int setECVSVoltage(char * ecvsname, double V);

    int getJacRows ();

    int getJacCols ();

    int getJacData (int r, int c, double& data);

    int getNodeV (char * label, double& nodeV);

    int getVProbeV (char * probename, double& probeV);

    int getIProbeI (char * probename, double& probeI);

    void setMessageFcn (void (*newmessagefcn)(int level, const char * format, ...));

    // debugging functions
//    void debug (void);
    void printSolution (void);

private:

    bool isInitialised;
    qucs::e_trsolver * etr;

};

} // namespace qucs

#endif /* __QUCS_INTERFACE_H__ */