Component.hh

Go to the documentation of this file.

#ifndef COMPONENT_HH
#define COMPONENT_HH

// Copyright (c) 2002-2005 The University of Cincinnati.  All rights
// reserved.

// You may modify, distribute, and use the software contained in this
// package under the terms of the "GNU LIBRARY GENERAL PUBLIC LICENSE"
// version 2, June 1991. A copy of this license agreement can be found in
// the file "LGPL", distributed with this archive.

// Authors: Sameer Kher                    kherss@ececs.uc.edu
//          Vinod Chamarty                 chamarv@ececs.uc.edu
//          Shriram Subramanian            subramsi@ececs.uc.edu

#include <iostream>
#include <string>
#include <list>

extern "C" {
#include "spmatrix.h"
}
#include "tyvis/vhdl.hh"
#include "tyvis/Wait.hh"
#include "tyvis/CallStack.hh"
#include "tyvis/Constants.hh"
#include "tyvis/AMSKernel_state.hh"
#include "tyvis/AMSKernel.hh"
#include "tyvis/Quantity.hh"
#include "tyvis/vhdl_ams.hh"
#include "tyvis/Tolerance.hh"

using std::list;

class AMSKernel;
class Quantity;
class branchEquation;
class AMSProcess;
class VHDLType;

template <class type> class set;

class component  {
public:

  component(const char* ); 

  virtual ~component(void) { }

  virtual void init()=0;

  virtual eqnType getEquationType()=0;

  virtual void setBranch();

  virtual Quantity **getQuantities();

  virtual int getNumberOfQuantities();

  virtual bool getConsCheck();
  
  virtual void addToCurrentEquations();

  virtual void buildQuantitySet(list<Quantity *> * quantitySet);

  bool getBranchSetFlag() {
    return branchSetFlag;
  }

  virtual void definePointers(void);

  virtual int findBranch(int posNode, int negNode);
  
  virtual int checkCurrent(int posNode, int negNode, int index);
  
  void setLoadedFlagInQtys();
  
  virtual int pointerAllocation() {
    return 0;  
  }
  
  virtual int load() = 0;
  
  _savant_entity_elab *getEnclosingBlock();

  void setEnclosingBlock(_savant_entity_elab * toSet);

  virtual int getThroFreeNumber(){
    return (noOfThroOrFreeQuantities);
  }

  const char* getName(){
    return name;
  }

  component * getNext(){
    return next;
  }

  void setNext(component * nextP ){
    next = nextP;
  } 

  AMSKernel * getCkt(){
    return ckt;
  }  
  
  void setCkt(AMSKernel * cktP){
    ckt=cktP;
  }

  virtual void updateQuantityValues();

  virtual void add(component *comp);

  virtual component* getImplicitEquationList();
  
  virtual int trunc(double* timeStep);

  virtual int load(Quantity* qty, int);

protected:
  component(){};

  bool branchSetFlag;
  
  int noOfThroOrFreeQuantities;
  
  eqnType equationType;

  AMSKernel *ckt;     

private:
  component* next; 
  
  _savant_entity_elab *enclosingBlock;
  
  const char* name;   

};

#endif

---