class for performing circuit analyses. More...

#include <analysis.h>

Inheritance diagram for qucs::analysis:

Collaboration diagram for qucs::analysis:

Public Member Functions
	analysis ()
	Constructor (Unnamed)
	analysis (const std::string &)
	analysis (analysis &)
virtual	~analysis ()
	Destructor.
virtual int	solve (void)
	placehoder for solution function
virtual int	initialize (void)
	placehoder for initialization function
virtual int	cleanup (void)
	placehoder for cleanup function
virtual bool	isExternal (void)
	informs whether this is an external sim
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 std::string &)
	create a named sweep object
void	saveVariable (const std::string &, nr_complex_t, qucs::vector *)
	Save variable into analysis dataset.
bool	getProgress (void)
	get
void	setProgress (bool p)
	Sets the progress.
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 ( const std::string & 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 ( ) [virtual]

Destructor.

Destructor. Destroys an analysis object.

Definition at line 75 of file analysis.cpp.

Member Function Documentation

qucs::analysis::addAnalysis ( analysis * a )

Parameters:

analysis pointer 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 ) [inline, virtual]

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 std::string & n )

create a named sweep object

Parameters:

n	pointer to a character array contining the name of the sweep to be created
sweep	pointer 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 109 of file analysis.cpp.

qucs::analysis::delAnalysis ( analysis * a )

Parameters:

analysis pointer 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 ) [inline, virtual]

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 ) [inline, virtual]

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 std::string &	,
		nr_complex_t	,
		qucs::vector *
	)

Save variable into analysis dataset.

Parameters:

n	Name of the variable
z	The variable to be added to the dataset
f	Saves the given variable into the dataset associated with the analysis. Creates the dataset vector if necessary.

Definition at line 153 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: