BdsApi  2.0.11
Public Member Functions | Public Attributes | List of all members
Bds::Response Class Reference

This class defines a Response. More...

#include <BdsD.h>

Inheritance diagram for Bds::Response:
Bds::ResponseEdit

Public Member Functions

 Response (BUInt32 pid=0, BTimeStamp pstartTime=BTimeStamp(), BTimeStamp pendTime=BTimeStamp(), BString pnetwork=BString(), BString pstation=BString(), BString pchannel=BString(), BString psource=BString(), BUInt32 pstage=0, BString pname=BString(), BString ptype=BString(), PoleZero ppoleZeros=PoleZero(), BArray< Fap > pfaps=BArray< Fap >(), Fir pfir=Fir(), BFloat64 pgain=0, BFloat64 pgainFrequency=0, BString pstageType=BString(), BFloat64 pdecimation=0, BString psymmetry=BString(), BString pdescription=BString(), BInt32 pmeasured=0, BFloat64 psampleRate=0)
 

Public Attributes

BUInt32 id
 The ID. More...
 
BTimeStamp startTime
 The Start Time. More...
 
BTimeStamp endTime
 The End Time the channel was available. More...
 
BString network
 The Network/Organisation Name. More...
 
BString station
 The station. More...
 
BString channel
 The channel. More...
 
BString source
 The source. More...
 
BUInt32 stage
 The stage. More...
 
BString name
 The response name. (Anti-Aliasing filter, Digitiser, post filter etc) More...
 
BString type
 The type of response (PoleZero,AmplitudePhase or FIR Coefficients) More...
 
PoleZero poleZeros
 PoleZero, AmplitudePhase or FIR Coefficient data. More...
 
BArray< Fapfaps
 The Frequency/Amplitude/Phase table. More...
 
Fir fir
 The FIR filters coefficients. More...
 
BFloat64 gain
 Overall gain at gain frequency. (For information) (Do we need this ?) More...
 
BFloat64 gainFrequency
 Frequency that gain is valid for. (For information) (Do we need this ?) More...
 
BString stageType
 The stage type: A - Analog (rad/sec), B - Analog (Hz), C - Composite, D - Digital. More...
 
BFloat64 decimation
 Decimation performed post filter. More...
 
BString symmetry
 Symmetry for FIR coefficients (A = asymmetric, B = symmetric[odd], C = symmetric[even]) ?? More...
 
BString description
 Misc description. More...
 
BInt32 measured
 If response was a measured response. More...
 
BFloat64 sampleRate
 The stage's sample rate. More...
 

Detailed Description

This class defines a Response.

Constructor & Destructor Documentation

◆ Response()

Bds::Response::Response ( BUInt32  pid = 0,
BTimeStamp  pstartTime = BTimeStamp(),
BTimeStamp  pendTime = BTimeStamp(),
BString  pnetwork = BString(),
BString  pstation = BString(),
BString  pchannel = BString(),
BString  psource = BString(),
BUInt32  pstage = 0,
BString  pname = BString(),
BString  ptype = BString(),
PoleZero  ppoleZeros = PoleZero(),
BArray< Fap pfaps = BArray<Fap >(),
Fir  pfir = Fir(),
BFloat64  pgain = 0,
BFloat64  pgainFrequency = 0,
BString  pstageType = BString(),
BFloat64  pdecimation = 0,
BString  psymmetry = BString(),
BString  pdescription = BString(),
BInt32  pmeasured = 0,
BFloat64  psampleRate = 0 
)

Member Data Documentation

◆ channel

BString Bds::Response::channel

The channel.

◆ decimation

BFloat64 Bds::Response::decimation

Decimation performed post filter.

◆ description

BString Bds::Response::description

Misc description.

◆ endTime

BTimeStamp Bds::Response::endTime

The End Time the channel was available.

◆ faps

BArray<Fap > Bds::Response::faps

The Frequency/Amplitude/Phase table.

◆ fir

Fir Bds::Response::fir

The FIR filters coefficients.

◆ gain

BFloat64 Bds::Response::gain

Overall gain at gain frequency. (For information) (Do we need this ?)

◆ gainFrequency

BFloat64 Bds::Response::gainFrequency

Frequency that gain is valid for. (For information) (Do we need this ?)

◆ id

BUInt32 Bds::Response::id

The ID.

◆ measured

BInt32 Bds::Response::measured

If response was a measured response.

◆ name

BString Bds::Response::name

The response name. (Anti-Aliasing filter, Digitiser, post filter etc)

◆ network

BString Bds::Response::network

The Network/Organisation Name.

◆ poleZeros

PoleZero Bds::Response::poleZeros

PoleZero, AmplitudePhase or FIR Coefficient data.

◆ sampleRate

BFloat64 Bds::Response::sampleRate

The stage's sample rate.

◆ source

BString Bds::Response::source

The source.

◆ stage

BUInt32 Bds::Response::stage

The stage.

◆ stageType

BString Bds::Response::stageType

The stage type: A - Analog (rad/sec), B - Analog (Hz), C - Composite, D - Digital.

◆ startTime

BTimeStamp Bds::Response::startTime

The Start Time.

◆ station

BString Bds::Response::station

The station.

◆ symmetry

BString Bds::Response::symmetry

Symmetry for FIR coefficients (A = asymmetric, B = symmetric[odd], C = symmetric[even]) ??

◆ type

BString Bds::Response::type

The type of response (PoleZero,AmplitudePhase or FIR Coefficients)


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