Qucs-core  0.0.18
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Attributes
qucs::analysis Class Reference

class for performing circuit analyses. More...

#include <analysis.h>

Inheritance diagram for qucs::analysis:
qucs::object qucs::nasolver< nr_complex_t > qucs::nasolver< nr_double_t > qucs::hbsolver qucs::nasolver< nr_type_t > qucs::parasweep qucs::spsolver qucs::acsolver qucs::dcsolver qucs::trsolver qucs::e_trsolver

Public Member Functions

 analysis ()
 Constructor (Unnamed) More...
 
 analysis (char *)
 
 analysis (analysis &)
 
 ~analysis ()
 Destructor. More...
 
virtual int solve (void)
 placehoder for solution function More...
 
virtual int initialize (void)
 placehoder for initialization function More...
 
virtual int cleanup (void)
 placehoder for cleanup function More...
 
virtual bool isExternal (void)
 informs whether this is an external sim More...
 
dataset * getData (void)
 
void setData (dataset *d)
 
net * getNet (void)
 
void setNet (net *netlist)
 
environment * getEnv (void)
 
void setEnv (environment *e)
 
ptrlist< analysis > * getAnalysis (void)
 
void setAnalysis (ptrlist< analysis > *a)
 
void addAnalysis (analysis *)
 
void delAnalysis (analysis *)
 
int getType (void)
 
void setType (int t)
 
sweep * createSweep (const char *)
 create a named sweep object More...
 
void saveVariable (const char *, nr_complex_t, qucs::vector *)
 Save variable into analysis dataset. More...
 
bool getProgress (void)
 get More...
 
void setProgress (bool p)
 Sets the progress. More...
 
- Public Member Functions inherited from qucs::object
 object ()
 
 object (const char *)
 
 object (const object &)
 
virtual ~object ()
 
objectgetNext (void)
 
void setNext (object *o)
 
objectgetPrev (void)
 
void setPrev (object *o)
 
void setName (const char *)
 
char * getName (void)
 
void addProperty (property *)
 
propertyaddProperty (const char *, const char *)
 
propertyaddProperty (const char *, nr_double_t)
 
propertyaddProperty (const char *, variable *)
 
void setProperty (const char *, char *)
 
void setProperty (const char *, nr_double_t)
 
void setScaledProperty (const char *, nr_double_t)
 
void setProperty (const char *, variable *)
 
vectorgetPropertyVector (const char *)
 
char * getPropertyString (const char *)
 
char * getPropertyReference (const char *)
 
nr_double_t getPropertyDouble (const char *)
 
nr_double_t getScaledProperty (const char *)
 
int getPropertyInteger (const char *)
 
bool hasProperty (const char *)
 
bool isPropertyGiven (const char *)
 
void copyProperties (property *)
 
void deleteProperties (void)
 
int countProperties (void)
 
char * propertyList (void)
 
 object ()
 
 object (const char *)
 
 object (const object &)
 
virtual ~object ()
 
objectgetNext (void)
 
void setNext (object *o)
 
objectgetPrev (void)
 
void setPrev (object *o)
 
void setName (const char *)
 
char * getName (void)
 
void addProperty (property *)
 
propertyaddProperty (const char *, const char *)
 
propertyaddProperty (const char *, nr_double_t)
 
propertyaddProperty (const char *, variable *)
 
void setProperty (const char *, char *)
 
void setProperty (const char *, nr_double_t)
 
void setScaledProperty (const char *, nr_double_t)
 
void setProperty (const char *, variable *)
 
vectorgetPropertyVector (const char *)
 
char * getPropertyString (const char *)
 
char * getPropertyReference (const char *)
 
nr_double_t getPropertyDouble (const char *)
 
nr_double_t getScaledProperty (const char *)
 
int getPropertyInteger (const char *)
 
bool hasProperty (const char *)
 
bool isPropertyGiven (const char *)
 
void copyProperties (property *)
 
void deleteProperties (void)
 
int countProperties (void)
 
char * propertyList (void)
 

Protected Attributes

int runs
 
int type
 
net * subnet
 
dataset * data
 
environment * env
 
ptrlist< analysis > * actions
 
bool progress
 

Detailed Description

class for performing circuit analyses.

This class is used for performing all the anlyses specified in a circuit description. The actual solver classes for specific analysis types inheirit from this class and override it's methods.

Definition at line 82 of file analysis.h.

Constructor & Destructor Documentation

qucs::analysis::analysis ( )

Constructor (Unnamed)

Copy Constructor.

Constructor (Named)

Constructor. Creates an unnamed instance of the analysis class.

Constructor. Creates a named instance of the analysis class.

Constructor. Creates an instance of the analysis class from an existing analysis object.

Definition at line 53 of file analysis.cpp.

qucs::analysis::analysis ( char *  n)

Definition at line 64 of file analysis.cpp.

qucs::analysis::analysis ( analysis a)

Definition at line 81 of file analysis.cpp.

qucs::analysis::~analysis ( )

Destructor.

Destructor. Destroys an analysis object.

Definition at line 75 of file analysis.cpp.

Member Function Documentation

qucs::analysis::addAnalysis ( analysis a)
Parameters
analysispointer to existing analysis object

Adds the given analysis to the actions being associated with the current analysis object.

Definition at line 93 of file analysis.cpp.

qucs::analysis::cleanup ( void  )
inlinevirtual

placehoder for cleanup function

Virtual cleanup function intended to be overridden by the inheiriting class's cleanup function.

Reimplemented in qucs::parasweep.

Definition at line 143 of file analysis.h.

qucs::analysis::createSweep ( const char *  n)

create a named sweep object

Parameters
npointer to a character array contining the name of the sweep to be created
sweeppointer to the created sweep object

Creates a named sweep object depending on the analysis's properties. Supported sweep types are: linear, logarithmic, lists and constants.

Definition at line 107 of file analysis.cpp.

qucs::analysis::delAnalysis ( analysis a)
Parameters
analysispointer to existing analysis object

Deletes the given analysis from the actions being associated with the current analysis object.

Definition at line 100 of file analysis.cpp.

ptrlist<analysis>* qucs::analysis::getAnalysis ( void  )
inline

Definition at line 190 of file analysis.h.

dataset* qucs::analysis::getData ( void  )
inline

Definition at line 160 of file analysis.h.

environment* qucs::analysis::getEnv ( void  )
inline

Definition at line 180 of file analysis.h.

net* qucs::analysis::getNet ( void  )
inline

Definition at line 170 of file analysis.h.

qucs::analysis::getProgress ( void  )
inline

get

Parameters
progress

Definition at line 254 of file analysis.h.

int qucs::analysis::getType ( void  )
inline

Definition at line 216 of file analysis.h.

qucs::analysis::initialize ( void  )
inlinevirtual

placehoder for initialization function

Virtual initialize function intended to be overridden by the inheiriting class's initialization function.

Reimplemented in qucs::parasweep.

Definition at line 132 of file analysis.h.

qucs::analysis::isExternal ( void  )
inlinevirtual

informs whether this is an external sim

External simulations will be ignored by qucsator. This function is used to determine whether the analysis is external or not.

Reimplemented in qucs::e_trsolver.

Definition at line 155 of file analysis.h.

qucs::analysis::saveVariable ( const char *  ,
nr_complex_t  ,
qucs::vector  
)

Save variable into analysis dataset.

Parameters
nName of the variable
zThe variable to be added to the dataset
fSaves the given variable into the dataset associated with the analysis. Creates the dataset vector if necessary.

Definition at line 151 of file analysis.cpp.

void qucs::analysis::setAnalysis ( ptrlist< analysis > *  a)
inline

Definition at line 195 of file analysis.h.

void qucs::analysis::setData ( dataset *  d)
inline

Definition at line 165 of file analysis.h.

void qucs::analysis::setEnv ( environment *  e)
inline

Definition at line 185 of file analysis.h.

void qucs::analysis::setNet ( net *  netlist)
inline

Definition at line 175 of file analysis.h.

qucs::analysis::setProgress ( bool  p)
inline

Sets the progress.

Parameters
pnew value of the progress

Sets the progress.

Definition at line 265 of file analysis.h.

void qucs::analysis::setType ( int  t)
inline

Definition at line 221 of file analysis.h.

qucs::analysis::solve ( void  )
inlinevirtual

placehoder for solution function

Virtual solution function intended to be overridden by the inheiriting class's solution function.

Reimplemented in qucs::spsolver, qucs::hbsolver, qucs::trsolver, qucs::acsolver, qucs::parasweep, and qucs::dcsolver.

Definition at line 121 of file analysis.h.

Field Documentation

ptrlist<analysis>* qucs::analysis::actions
protected

Definition at line 276 of file analysis.h.

dataset* qucs::analysis::data
protected

Definition at line 274 of file analysis.h.

environment* qucs::analysis::env
protected

Definition at line 275 of file analysis.h.

bool qucs::analysis::progress
protected

Definition at line 277 of file analysis.h.

int qucs::analysis::runs
protected

Definition at line 271 of file analysis.h.

net* qucs::analysis::subnet
protected

Definition at line 273 of file analysis.h.

int qucs::analysis::type
protected

Definition at line 272 of file analysis.h.


The documentation for this class was generated from the following files: