V3FIT
Public Member Functions | Public Attributes | List of all members
combination::combination_class Interface Reference

Base class representing a combination signal. More...

Inheritance diagram for combination::combination_class:
signal::signal_class

Public Member Functions

PROCEDURE set_signal => combination_set_signal
 
PROCEDURE set_weight => combination_set_weight
 
PROCEDURE get_modeled_signal_last => combination_get_modeled_signal
 
PROCEDURE get_type => combination_get_type
 
PROCEDURE get_header => combination_get_header
 
PROCEDURE write_auxiliary => combination_write_auxiliary
 
FINAL combination_destruct
 
type(combination_class) function, pointer combination_construct (n_signals, combination_type, wgt_index)
 Construct a combination_class. More...
 
- Public Member Functions inherited from signal::signal_class
PROCEDURE get_modeled_signal_cache => signal_get_modeled_signal_cache
 
PROCEDURE get_modeled_signal_last => signal_get_modeled_signal_last
 
GENERIC get_modeled_signal => get_modeled_signal_cache, get_modeled_signal_last
 
PROCEDURE get_observed_signal => signal_get_observed_signal
 
PROCEDURE get_g2 => signal_get_g2
 
PROCEDURE get_e => signal_get_e
 
PROCEDURE get_sigma2 => signal_get_sigma2
 
PROCEDURE get_type => signal_get_type
 
PROCEDURE get_header => signal_get_header
 
PROCEDURE get_gp_i => signal_get_gp_i
 
PROCEDURE get_gp_s => signal_get_gp_s
 
PROCEDURE get_gp_x => signal_get_gp_x
 
GENERIC get_gp => get_gp_i, get_gp_s, get_gp_x
 
PROCEDURE scale_and_offset => signal_scale_and_offset
 
PROCEDURE sync_child => signal_sync_child
 
PROCEDURE write_header => signal_write_header
 
PROCEDURE write => signal_write
 
PROCEDURE write_auxiliary => signals_write_auxiliary
 
PROCEDURE write_step_data => signal_write_step_data
 
FINAL signal_destruct
 

Public Attributes

integer type = combination_none
 Type descirptor of the cobination type. More...
 
type(signal_pointer), dimension(:), pointer signals
 Array of signal_class pointer presenting the signals to combine.
 
real(rprec), dimension(:), pointer a
 Array of coeffients to for the combined signals.
 
integer wgt_index
 Index of the average weighting factor.
 
- Public Attributes inherited from signal::signal_class
character(len=data_short_name_length) s_name
 Short name of the signal.
 
character(len=data_name_length) l_name
 Long name of the signal.
 
character(len=data_short_name_length) units
 Physical units the signal measures.
 
real(rprec) observed
 Eperimentally measured signal value.
 
real(rprec) observed_sigma
 Eperimentally measured signal uncertainty.
 
real(rprec) weight
 Weighting parameter of the signal.
 
real(rprec), dimension(4) modeled
 Cached value of the modeled signal.
 
real(rprec), dimension(4) modeled_sigma
 Cached value of the modeled sigma.
 
integer scale_index
 Scale factor index.
 
integer offset_index
 Offset factor index.
 

Detailed Description

Base class representing a combination signal.

Interface for thomson te constructor.

Super Class:
signal

Definition at line 40 of file combination.f.

Member Function/Subroutine Documentation

◆ combination_construct()

type (combination_class) function, pointer combination::combination_class::combination_construct ( integer, intent(in)  n_signals,
character (len=combination_type_length), intent(in)  combination_type,
integer, intent(in)  wgt_index 
)

Construct a combination_class.

Allocates memory and initializes a combination_class object. This just allocates the combination_class::signals and combination_class::a array. The indices of these arrays are set by combination_set_signal

Parameters
[in]n_signalsNumber of signals in this combination.
[in]combination_typeThe method to combine the signals. Possible values are combination_sum, combination_max, @ ref combination_min and combination_wavg
[in]wgt_indexIndex number of the average weighting.
Returns
A pointer to a constructed combination_class object.

Definition at line 102 of file combination.f.

Member Data Documentation

◆ type

integer combination::combination_class::type = combination_none

Type descirptor of the cobination type.

Possible values are:

Definition at line 47 of file combination.f.


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