BDS Public
BdsApi 4.0.1
This is the Blacknest BDS API.
Loading...
Searching...
No Matches
Bds::ResponseObj Class Reference

Response object adding string conversion. More...

#include <BdsLib.h>

Inheritance diagram for Bds::ResponseObj:
Bds::Response

Public Member Functions

 ResponseObj (const Response &response)
 
 ~ResponseObj ()
 
BString getString ()
 
void setString (BString str)
 
- Public Member Functions inherited from Bds::Response
 Response (BUInt32 id=0, BTimeStamp startTime=BTimeStamp(), BTimeStamp endTime=BTimeStamp(), BString network=BString(), BString station=BString(), BString channel=BString(), BString source=BString(), BUInt32 stage=0, BString name=BString(), BString type=BString(), PoleZero poleZeros=PoleZero(), BArray< Fap > faps=BArray< Fap >(), Fir fir=Fir(), Polynomial polynomial=Polynomial(), BFloat64 gain=0, BFloat64 gainFrequency=0, BString stageType=BString(), BFloat64 decimation=0, BFloat64 decimationOffset=0, BFloat64 decimationDelay=0, BFloat64 decimationCorr=0, BString symmetry=BString(), BString description=BString(), BInt32 measured=0, BFloat64 sampleRate=0, BString inputUnits=BString(), BString inputUnitsDesc=BString(), BString outputUnits=BString(), BString outputUnitsDesc=BString())
 

Additional Inherited Members

- Public Attributes inherited from Bds::Response
BUInt32 id
 The ID.
 
BTimeStamp startTime
 The start time when ret response is valid from.
 
BTimeStamp endTime
 The end time the response is valid to.
 
BString network
 The Network/Organisation Name.
 
BString station
 The station.
 
BString channel
 The channel.
 
BString source
 The source.
 
BUInt32 stage
 The stage (0, 1, 2, 3, ...). 0 is a special overall response sometimes used.
 
BString name
 The response name. (Anti-Aliasing filter, Digitiser, post filter etc)
 
BString type
 The type of response (PoleZero, FIR, FAP, Polynomial or blank if no frequency response)
 
PoleZero poleZeros
 The PoleZeros.
 
BArray< Fapfaps
 The FAP Frequency/Amplitude/Phase table.
 
Fir fir
 The FIR filters coefficients.
 
Polynomial polynomial
 The polynomial response.
 
BFloat64 gain
 Overall gain at gainFrequency.
 
BFloat64 gainFrequency
 Frequency that gain is valid for.
 
BString stageType
 The stage type: A - Analog (rad/sec), B - Analog (Hz), C - Composite, D - Digital.
 
BFloat64 decimation
 Decimation factor performed post filter.
 
BFloat64 decimationOffset
 Decimation sample offset.
 
BFloat64 decimationDelay
 Decimation delay in seconds.
 
BFloat64 decimationCorr
 Decimation correction performed.
 
BString symmetry
 Symmetry for FIR coefficients (A = asymmetric, B = symmetric[odd], C = symmetric[even])
 
BString description
 Misc description.
 
BInt32 measured
 Boolean if response was a measured response.
 
BFloat64 sampleRate
 The stage's sample rate.
 
BString inputUnits
 The units of the data as input from the perspective of data acquisition. After correcting data for this response, these would be the resulting units.
 
BString inputUnitsDesc
 The input units description.
 
BString outputUnits
 The units of the data as output from the perspective of data acquisition. These would be the units of the data prior to correcting for this response.
 
BString outputUnitsDesc
 The output units description.
 

Detailed Description

Response object adding string conversion.

Constructor & Destructor Documentation

◆ ResponseObj()

Bds::ResponseObj::ResponseObj ( const Response response)

◆ ~ResponseObj()

Bds::ResponseObj::~ResponseObj ( )

Member Function Documentation

◆ getString()

BString Bds::ResponseObj::getString ( )

◆ setString()

void Bds::ResponseObj::setString ( BString  str)

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