Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

data_ptr_nport Class Reference

Some classes don't store their scattering and noise matrices locally. More...

#include <nport.h>

Inheritance diagram for data_ptr_nport::

nport device alias cascade fet mixer mixer_currents radial_stub fhr02x fhx13x jpltrw160 jpltrw300 kukje List of all members.

Public Methods

 data_ptr_nport ()
 Constructor: Make data_ptr point to data so that it won't cause a core dump. More...

 data_ptr_nport (const data_ptr_nport &c)
 Copy constructor. More...

data_ptr_nport& operator= (const data_ptr_nport &c)
 Assignment operator. More...

virtual ~data_ptr_nport ()
virtual const sdataget_data ()
 Return the nport data in one chunk after recalculating the nport. More...

virtual const sdataget_data (state_tag calc_id)
 Return the nport data, recalculating only if calc_id is different from when we last recalculated. More...

virtual const sdataget_data_S ()
 Special function to save time in circuits: calculate only the S matrix and B vector parts of the sdata. More...

virtual const sdataget_data_S (state_tag calc_id)
 Special function to save time in circuits: calculate only the S matrix and B vector parts of the sdata only if calc_id is different from when we last recalculated. More...

virtual const sdataget_last_data () const
 Return the nport data. More...

virtual int size ()
 The number of ports this device has. More...

virtual v_index_mode mode ()
 A function for those rare cases when an nport may not use Index_1 indexing. More...


Protected Attributes

const sdatadata_ptr
 data includes the scattering matrix, noise matrix, size, etc. More...


Detailed Description

Some classes don't store their scattering and noise matrices locally.

For example, they might use another subclass of nport to do the calculation for them.

data_ptr_nport uses a pointer to keep track of where its sdata is. This avoids the inefficiency of copying the matrices over from someplace else. It saves the programmer the trouble of overloading functions such as get_data().

Class data_ptr_nport should never be instantiated directly.

Definition at line 308 of file nport.h.


Constructor & Destructor Documentation

data_ptr_nport::data_ptr_nport ( ) [inline]
 

Constructor: Make data_ptr point to data so that it won't cause a core dump.

Definition at line 323 of file nport.h.

data_ptr_nport::data_ptr_nport ( const data_ptr_nport & c ) [inline]
 

Copy constructor.

Make sure data_ptr doesn't point to data of the instance we're copying.

Definition at line 329 of file nport.h.

data_ptr_nport::~data_ptr_nport ( ) [inline, virtual]
 

Definition at line 339 of file nport.h.


Member Function Documentation

const sdata & data_ptr_nport::get_data ( state_tag calc_id ) [inline, virtual]
 

Return the nport data, recalculating only if calc_id is different from when we last recalculated.

Parameters:
calc_id   used to determine if this device needs to be recalculated
Returns:
the scattering matrix, noise correlation matrix, etc.

Reimplemented from nport.

Definition at line 354 of file nport.h.

const sdata & data_ptr_nport::get_data ( ) [inline, virtual]
 

Return the nport data in one chunk after recalculating the nport.

Reimplemented from nport.

Definition at line 342 of file nport.h.

Referenced by mixer::analyzer::fill_data().

const sdata & data_ptr_nport::get_data_S ( state_tag calc_id ) [inline, virtual]
 

Special function to save time in circuits: calculate only the S matrix and B vector parts of the sdata only if calc_id is different from when we last recalculated.

The noise correlation matrix will contain stale values.

Parameters:
calc_id   used to determine if this device needs to be recalculated
Returns:
the scattering matrix, noise correlation matrix, etc.

Reimplemented from nport.

Definition at line 383 of file nport.h.

const sdata & data_ptr_nport::get_data_S ( ) [inline, virtual]
 

Special function to save time in circuits: calculate only the S matrix and B vector parts of the sdata.

The noise correlation matrix will contain stale values.

Returns:
the scattering matrix, noise correlation matrix, etc.

Reimplemented from nport.

Definition at line 369 of file nport.h.

Referenced by mixer::balancer::fill_data().

const sdata & data_ptr_nport::get_last_data ( ) const [inline, virtual]
 

Return the nport data.

Do not perform a calculation.

Returns:
the scattering matrix, noise correlation matrix, etc.

Reimplemented from nport.

Definition at line 396 of file nport.h.

v_index_mode data_ptr_nport::mode ( ) [inline, virtual]
 

A function for those rare cases when an nport may not use Index_1 indexing.

Reimplemented from nport.

Definition at line 409 of file nport.h.

data_ptr_nport & data_ptr_nport::operator= ( const data_ptr_nport & c ) [inline]
 

Assignment operator.

Make sure data_ptr doesn't point to data of the instance we're copying.

Definition at line 335 of file nport.h.

int data_ptr_nport::size ( ) [inline, virtual]
 

The number of ports this device has.

Returns:
the number of ports

Reimplemented from nport.

Reimplemented in cascade, fet, mixer, mixer_currents, alias, and radial_stub.

Definition at line 403 of file nport.h.


Member Data Documentation

const sdata * data_ptr_nport::data_ptr [protected]
 

data includes the scattering matrix, noise matrix, size, etc.

You must be careful that this pointer always points to a valid sdata object.

Definition at line 316 of file nport.h.


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

Please direct comments and corrections to supermix@submm.caltech.edu
Go to the supermix home page
Generated by doxygen1.2.7