BdsApi 3.1.4
This is the Blacknest BDS API.
Loading...
Searching...
No Matches
BdsD.h
Go to the documentation of this file.
1/*******************************************************************************
2 * BdsD.h Produced by Bidl
3 *******************************************************************************
4 */
10
11#ifndef BDSD_H
12#define BDSD_H 1
13
14#include <Boap.h>
15#include <BObj.h>
16#include <BDate.h>
17#include <BTimeStamp.h>
18#include <BComplex.h>
19#include <BList.h>
20#include <BArray.h>
21
22//*****************************************************************************/
23// BDS API
24// T.Barnaby, BEAM Ltd, 2021-05-19
25//*****************************************************************************/
26//
27namespace Bds {
30
33
36
39
42
45
48
51
54
57 class Point {
58 public:
59 Point(BFloat64 x = 0, BFloat64 y = 0);
60 public:
63 };
64
67 class TimePeriod : public BObj {
68 public:
72 BError setMember(BString name, BString value);
74 BError getMember(BString name, BString& value);
75 public:
78 };
79
82 class ListRange : public BObj {
83 public:
87 BError setMember(BString name, BString value);
89 BError getMember(BString name, BString& value);
90 public:
94 };
95
98 class Network : public BObj {
99 public:
102 BError setMembers(BDictString& members);
103 BError setMember(BString name, BString value);
104 BError getMembers(BDictString& members);
105 BError getMember(BString name, BString& value);
106 public:
111 };
112
118 class Source : public BObj {
119 public:
122 BError setMembers(BDictString& members);
123 BError setMember(BString name, BString value);
124 BError getMembers(BDictString& members);
125 BError getMember(BString name, BString& value);
126 public:
132 };
133
138 class SourcePriority : public BObj {
139 public:
142 BError setMembers(BDictString& members);
143 BError setMember(BString name, BString value);
144 BError getMembers(BDictString& members);
145 BError getMember(BString name, BString& value);
146 public:
152 };
153
158 public:
160 public:
165 };
166
172 public:
174 public:
180 };
181
187 class Station {
188 public:
190 public:
198 };
199
205 class Location : public BObj {
206 public:
209 BError setMembers(BDictString& members);
210 BError setMember(BString name, BString value);
211 BError getMembers(BDictString& members);
212 BError getMember(BString name, BString& value);
213 public:
226 };
227
228 //
231 class PoleZero {
232 public:
234 public:
237 };
238
239 //
241 class Fap {
242 public:
244 public:
248 };
249
250 //
252 class FirEntry {
253 public:
255 public:
258 };
259
260 //
263 class Fir {
264 public:
266 public:
269 };
270
271 //
274 public:
276 public:
281 };
282
283 //
287 public:
289 public:
299 };
300
301 //
311 class Response {
312 public:
314 public:
344 };
345
352 class Calibration : public BObj {
353 public:
356 BError setMembers(BDictString& members);
358 BError getMembers(BDictString& members);
360 public:
381 };
382
385 class Digitiser : public BObj {
386 public:
389 BError setMembers(BDictString& members);
391 BError getMembers(BDictString& members);
393 public:
405 };
406
409 class Sensor : public BObj {
410 public:
413 BError setMembers(BDictString& members);
415 BError getMembers(BDictString& members);
417 public:
429 };
430
435 class ChannelInstrument : public BObj {
436 public:
439 BError setMembers(BDictString& members);
440 BError setMember(BString name, BString value);
441 BError getMembers(BDictString& members);
442 BError getMember(BString name, BString& value);
443 public:
451 };
452
458 class Channel : public BObj {
459 public:
462 BError setMembers(BDictString& members);
463 BError setMember(BString name, BString value);
464 BError getMembers(BDictString& members);
465 BError getMember(BString name, BString& value);
466 public:
477 };
478
482 public:
484 public:
494 };
495
499 public:
501 public:
506 };
507
515 class Selection {
516 public:
518 public:
536 };
537
543 public:
545 public:
557 };
558
565 public:
567 public:
570 };
571
576 class DataFileInfo : public BObj {
577 public:
580 BError setMembers(BDictString& members);
581 BError setMember(BString name, BString value);
582 BError getMembers(BDictString& members);
583 BError getMember(BString name, BString& value);
584 public:
596 };
597
605 class DataChannel : public BObj {
606 public:
609 BError setMembers(BDictString& members);
610 BError setMember(BString name, BString value);
611 BError getMembers(BDictString& members);
612 BError getMember(BString name, BString& value);
613 public:
631 };
632
640 class DataInfo {
641 public:
643 public:
653 };
654
656 class DataAvail {
657 public:
659 public:
663 };
664
674 public:
676 public:
684 };
685
688 public:
690 public:
693 };
694
707 class DataBlock {
708 public:
710 public:
717 };
718
721 public:
723 public:
728 };
729
732 class User : public BObj {
733 public:
736 BError setMembers(BDictString& members);
738 BError getMembers(BDictString& members);
740 public:
750 };
751
755 class Group : public BObj {
756 public:
759 BError setMembers(BDictString& members);
760 BError setMember(BString name, BString value);
761 BError getMembers(BDictString& members);
762 BError getMember(BString name, BString& value);
763 public:
767 };
768
772 class AccessGroup : public BObj {
773 public:
776 BError setMembers(BDictString& members);
777 BError setMember(BString name, BString value);
778 BError getMembers(BDictString& members);
779 BError getMember(BString name, BString& value);
780 public:
787 };
788
793 class Change : public BObj {
794 public:
797 BError setMembers(BDictString& members);
798 BError setMember(BString name, BString value);
799 BError getMembers(BDictString& members);
800 BError getMember(BString name, BString& value);
801 public:
808 };
809
814 class ChangeGroup : public BObj {
815 public:
818 BError setMembers(BDictString& members);
819 BError setMember(BString name, BString value);
820 BError getMembers(BDictString& members);
821 BError getMember(BString name, BString& value);
822 public:
829 };
830
835 class Note : public BObj {
836 public:
839 BError setMembers(BDictString& members);
840 BError setMember(BString name, BString value);
841 BError getMembers(BDictString& members);
842 BError getMember(BString name, BString& value);
843 public:
862 };
863
867 class Log : public BObj {
868 public:
871 BError setMembers(BDictString& members);
872 BError setMember(BString name, BString value);
873 BError getMembers(BDictString& members);
874 BError getMember(BString name, BString& value);
875 public:
883 };
884
886 class LogSelect {
887 public:
889 public:
894 };
895
898 public:
900 public:
904 };
905
909 public:
911 public:
919 };
920
923
927 class SpecialChannel : public BObj {
928 public:
931 BError setMembers(BDictString& members);
932 BError setMember(BString name, BString value);
933 BError getMembers(BDictString& members);
934 BError getMember(BString name, BString& value);
935 public:
944 };
945
949 class Event {
950 public:
952 public:
972 };
973
987}
988
989#endif
double BFloat64
uint32_t BUInt32
int32_t BInt32
uint64_t BUInt64
virtual const BObjMember * getMembers() const
This holds information on data access groups.
Definition: BdsD.h:772
BString getType()
Definition: BdsD.cc:1280
BError setMember(BString name, BString value)
Definition: BdsD.cc:1314
BString network
The Network Name.
Definition: BdsD.h:785
BError setMembers(BDictString &members)
Definition: BdsD.cc:1303
BTimeStamp startTime
The Start Time.
Definition: BdsD.h:783
BTimeStamp endTime
The End Time.
Definition: BdsD.h:784
BError getMember(BString name, BString &value)
Definition: BdsD.cc:1292
BUInt32 id
The unique id.
Definition: BdsD.h:781
BString station
The Station name.
Definition: BdsD.h:786
BString group
The Group name.
Definition: BdsD.h:782
This class defines an array's channel.
Definition: BdsD.h:171
BFloat64 arrayOffsetNorth
The Location offset in in an array in a northerly direction in metres.
Definition: BdsD.h:179
BFloat64 arrayOffsetEast
The Location offset in in an array in an easterly direction in metres.
Definition: BdsD.h:178
BString station
The Stations name.
Definition: BdsD.h:176
BString network
The Network this station belongs to if for a partricular network.
Definition: BdsD.h:175
BString channel
The Channels name.
Definition: BdsD.h:177
This class defines a calibration setting.
Definition: BdsD.h:352
BString source
The source.
Definition: BdsD.h:367
BError getMember(BString name, BString &value)
Definition: BdsD.cc:482
BString rawCalibrationUnits
The raw data measurment SI units such as "m".
Definition: BdsD.h:376
BString channel
The channel.
Definition: BdsD.h:366
BFloat64 rawCalibrationFactor
The raw data scaling value to apply to the data to normalise data to the units. This is a measured va...
Definition: BdsD.h:375
BTimeStamp startTime
The Start Time.
Definition: BdsD.h:362
BString network
The Network/Organisation Name.
Definition: BdsD.h:364
BFloat64 calibrationFactor
The post response compensation scaling value to apply to the data to normalise data to the units....
Definition: BdsD.h:371
BTimeStamp endTime
The End Time.
Definition: BdsD.h:363
BString calibrationUnitsDesc
A description of the calibrationUnits.
Definition: BdsD.h:373
BString getType()
Definition: BdsD.cc:456
BFloat64 rawCalibrationFrequency
The raw data frequency that the CalibrationFactor value is valid for in Hz.
Definition: BdsD.h:374
BFloat64 samplingFrequency
The sample rate used in Hz.
Definition: BdsD.h:369
BString name
The Calibrations name, "Main", "Measured".
Definition: BdsD.h:368
BFloat64 horizontalAngle
The Sensors channel placement horizontal angle in degrees clockwise from north.
Definition: BdsD.h:379
BError setMembers(BDictString &members)
Definition: BdsD.cc:507
BString calibrationUnits
The post response compensation measurment SI units such as "m".
Definition: BdsD.h:372
BFloat64 calibrationFrequency
The post response compensation frequency that the CalibrationFactor value is valid for in Hz.
Definition: BdsD.h:370
BFloat64 waterLevel
Elevation of the water surface in meters for underwater sites, where 0 is sea level.
Definition: BdsD.h:378
BString station
The station.
Definition: BdsD.h:365
BError setMember(BString name, BString value)
Definition: BdsD.cc:532
BFloat64 verticalAngle
The Sensors channel placement vertical angle in degrees degrees with zero = vertically up.
Definition: BdsD.h:380
BUInt32 id
The ID.
Definition: BdsD.h:361
BFloat64 depth
The depth of the sensor below ground level in meters.
Definition: BdsD.h:377
This holds information on a set of Changes.
Definition: BdsD.h:814
BString description
The Description of the change.
Definition: BdsD.h:828
BString user
The user who made the change.
Definition: BdsD.h:826
BString getType()
Definition: BdsD.cc:1390
BError setMembers(BDictString &members)
Definition: BdsD.cc:1413
BUInt32 id
The unique id.
Definition: BdsD.h:823
BString type
The type of change.
Definition: BdsD.h:825
BString title
The Changes title.
Definition: BdsD.h:827
BError setMember(BString name, BString value)
Definition: BdsD.cc:1424
BTimeStamp time
The Time the change was made.
Definition: BdsD.h:824
BError getMember(BString name, BString &value)
Definition: BdsD.cc:1402
This holds information on a Medatdata or Sensor data database change.
Definition: BdsD.h:793
BError getMember(BString name, BString &value)
Definition: BdsD.cc:1347
BUInt32 changeGroupId
The Change group ID.
Definition: BdsD.h:803
BUInt32 id
The unique id.
Definition: BdsD.h:802
BString table
The database table affected.
Definition: BdsD.h:806
BString type
The change type.
Definition: BdsD.h:805
BString getType()
Definition: BdsD.cc:1335
BUInt32 rowId
The database row affected.
Definition: BdsD.h:807
BTimeStamp time
The Time the change was made.
Definition: BdsD.h:804
BError setMembers(BDictString &members)
Definition: BdsD.cc:1358
BError setMember(BString name, BString value)
Definition: BdsD.cc:1369
This class provides full Metadata information on a channel.
Definition: BdsD.h:542
BTimeStamp startTime
The Start Time.
Definition: BdsD.h:546
BString source
The data source.
Definition: BdsD.h:552
Digitiser digitiser
The Digitiser in use.
Definition: BdsD.h:553
BTimeStamp endTime
The End Time.
Definition: BdsD.h:547
Location channelLocation
The Channel location.
Definition: BdsD.h:551
Station station
The Station info.
Definition: BdsD.h:548
BList< Response > responses
The list of frequency responses.
Definition: BdsD.h:556
Location stationLocation
The Station location.
Definition: BdsD.h:549
Calibration calibration
The Calibration info.
Definition: BdsD.h:555
Sensor sensor
The Sensor in use.
Definition: BdsD.h:554
Channel channel
The Channel data.
Definition: BdsD.h:550
This class provides Metadata information on a set of channels.
Definition: BdsD.h:564
Station array
The array if all channels are from an array.
Definition: BdsD.h:568
BArray< BArray< ChannelInfo > > channels
The per channel per time segment Metadata. For each channel there can be one or more ChannelInfo obje...
Definition: BdsD.h:569
This class defines a Channel's instrument.
Definition: BdsD.h:435
BString getType()
Definition: BdsD.cc:728
BString source
The source.
Definition: BdsD.h:448
BUInt32 digitiserId
The Digitiser in use.
Definition: BdsD.h:449
BError setMembers(BDictString &members)
Definition: BdsD.cc:753
BUInt32 id
Unique ID when stored in a database or for other uses.
Definition: BdsD.h:444
BError getMember(BString name, BString &value)
Definition: BdsD.cc:741
BUInt32 sensorId
The sensor in use.
Definition: BdsD.h:450
BError setMember(BString name, BString value)
Definition: BdsD.cc:765
BTimeStamp endTime
The End Time the channel was available.
Definition: BdsD.h:446
BTimeStamp startTime
The Start Time.
Definition: BdsD.h:445
BUInt32 channelId
The channels Id.
Definition: BdsD.h:447
This class defines a full channel name.
Definition: BdsD.h:157
BString channel
The Channels name.
Definition: BdsD.h:163
BString network
The Channels network.
Definition: BdsD.h:161
BString station
The Channels station.
Definition: BdsD.h:162
BString source
The Channels source.
Definition: BdsD.h:164
This class defines a seismic data Channel.
Definition: BdsD.h:458
BString network
The Network Name.
Definition: BdsD.h:470
BString description
The channels description.
Definition: BdsD.h:476
BString channelAux
The channels auxilary identifier (component of station field)
Definition: BdsD.h:474
BError setMembers(BDictString &members)
Definition: BdsD.cc:822
BString getType()
Definition: BdsD.cc:791
BUInt32 id
Unique ID when stored in a database or for other uses.
Definition: BdsD.h:467
BString dataType
The Type of data (seismic, seismicUnknown, data, log, unknown, empty)
Definition: BdsD.h:475
BTimeStamp endTime
The End Time the channel was available.
Definition: BdsD.h:469
BString channelType
The channels type (component of station field)
Definition: BdsD.h:473
BString channel
The channels name (often as <channelType>_<channelAux>)
Definition: BdsD.h:472
BString station
The Stations name.
Definition: BdsD.h:471
BTimeStamp startTime
The Start Time.
Definition: BdsD.h:468
BError setMember(BString name, BString value)
Definition: BdsD.cc:837
BError getMember(BString name, BString &value)
Definition: BdsD.cc:807
This defines the set of clean options used in the clean() function.
Definition: BdsD.h:897
BInt32 deletedFiles
Clean deleted data files.
Definition: BdsD.h:903
BInt32 logs
Clean the Logs.
Definition: BdsD.h:901
BInt32 changes
Clean the changes.
Definition: BdsD.h:902
This class defines avaiilablity information on a set of data.
Definition: BdsD.h:673
BArray< DataAvail > segments
Data time segment availability info.
Definition: BdsD.h:683
BString station
The Station name.
Definition: BdsD.h:680
BString channel
The Channels name.
Definition: BdsD.h:681
BTimeStamp startTime
The Start Time.
Definition: BdsD.h:677
BTimeStamp endTime
The End Time.
Definition: BdsD.h:678
BString network
The Network Name.
Definition: BdsD.h:679
BString source
The Data Source.
Definition: BdsD.h:682
This class provides availability information on a particular period of data.
Definition: BdsD.h:656
BTimeStamp endTime
The End Time.
Definition: BdsD.h:661
BTimeStamp startTime
The Start Time.
Definition: BdsD.h:660
AvailType availType
The availability type. Can be: AvailNone, AvailPartial or AvailFull.
Definition: BdsD.h:662
This class provides the actual seismic data values contained within a single data block along with th...
Definition: BdsD.h:720
BString source
The Data Source or Sources.
Definition: BdsD.h:727
BString station
The Station name or Stations.
Definition: BdsD.h:725
BString network
The Network Name or names.
Definition: BdsD.h:724
BString channel
The Channels name or Channels.
Definition: BdsD.h:726
This class provides the actual Sensor data values contained within a single data block.
Definition: BdsD.h:707
BArray< BArray< BFloat64 > > channelData
The raw channel data in a 2 dimensional array, ordered as per channel information in dataInfo.
Definition: BdsD.h:715
BTimeStamp endTime
The End Time the channel was available.
Definition: BdsD.h:712
BDict< BString > info
Extra information on data or ASCII data.
Definition: BdsD.h:716
BUInt32 segmentNumber
The segment number. (1, 2, 3, ...)
Definition: BdsD.h:714
BUInt32 channelNumber
The first channel number. (1, 2, 3 ...)
Definition: BdsD.h:713
BTimeStamp startTime
The Start Time.
Definition: BdsD.h:711
This class defines information on a single channel's set of data stored in a file.
Definition: BdsD.h:605
BUInt32 sampleFormat
The data sample format.
Definition: BdsD.h:624
BUInt32 dataFileChannel
The Data File Channel number. The channel number within the data file. (1, 2, 3 .....
Definition: BdsD.h:626
BUInt64 numSamples
The total number of samples per channel if known, 0 otherwise.
Definition: BdsD.h:622
BString importFormat
The original data format.
Definition: BdsD.h:627
BError setMembers(BDictString &members)
Definition: BdsD.cc:1061
BFloat64 sampleRate
The data's sample rate.
Definition: BdsD.h:623
BDict< BString > info
Extra info on the channel.
Definition: BdsD.h:630
BUInt32 id
Unique ID when stored in a database or for other uses.
Definition: BdsD.h:614
BString station
The Station name.
Definition: BdsD.h:618
BTimeStamp endTime
The End Time.
Definition: BdsD.h:616
BString channel
The Channels name.
Definition: BdsD.h:619
BString network
The Network Name.
Definition: BdsD.h:617
BString source
The Data Source.
Definition: BdsD.h:620
BString getType()
Definition: BdsD.cc:1016
BTimeStamp startTime
The Start Time.
Definition: BdsD.h:615
BUInt32 dataFileId
The Data File Id. This links to the particular DataFileInfo where the data is stored.
Definition: BdsD.h:625
BError setMember(BString name, BString value)
Definition: BdsD.cc:1083
BTimeStamp importStartTime
The original import files start time.
Definition: BdsD.h:629
BString importFilename
The original data file name.
Definition: BdsD.h:628
BError getMember(BString name, BString &value)
Definition: BdsD.cc:1039
BUInt32 numBlocks
The total number of blocks per channel if known, 0 otherwise.
Definition: BdsD.h:621
This class defines information on a Sensor data file.
Definition: BdsD.h:576
BTimeStamp startTime
The Start Time.
Definition: BdsD.h:586
BError getMember(BString name, BString &value)
Definition: BdsD.cc:947
BString getType()
Definition: BdsD.cc:930
BError setMember(BString name, BString value)
Definition: BdsD.cc:979
BUInt32 importUserId
The user ID of the importing user.
Definition: BdsD.h:593
BString comment
A comment on the file.
Definition: BdsD.h:592
BTimeStamp importTime
The Time the data was imported.
Definition: BdsD.h:594
BString format
The data format.
Definition: BdsD.h:589
BString location
The storage location.
Definition: BdsD.h:588
BString stream
The real-time data stream.
Definition: BdsD.h:591
BError setMembers(BDictString &members)
Definition: BdsD.cc:963
BTimeStamp endTime
The End Time.
Definition: BdsD.h:587
BString state
Status info on the import (importing, realtime, failed, ok etc)
Definition: BdsD.h:595
BString url
The URL for file access.
Definition: BdsD.h:590
BUInt32 id
Unique ID when stored in a database or for other uses.
Definition: BdsD.h:585
This holds information on a Sensor data format.
Definition: BdsD.h:908
BInt32 dataRead
Ability to read Sensor data.
Definition: BdsD.h:913
BList< BString > names
The format names.
Definition: BdsD.h:912
BInt32 metadataWrite
MetaData write supported.
Definition: BdsD.h:916
BInt32 metadataRead
MetaData read supported.
Definition: BdsD.h:915
BString extension
Default filename extension.
Definition: BdsD.h:917
BString description
The description.
Definition: BdsD.h:918
BInt32 dataWrite
Ability to write Sensor data.
Definition: BdsD.h:914
This defines a handle to a sensor data stream/file when opened for read or write.
Definition: BdsD.h:687
BUInt32 dataFileId
The data file ID if opened for write.
Definition: BdsD.h:692
BUInt32 handle
Opaque file handle.
Definition: BdsD.h:691
This class defines information on a set of data.
Definition: BdsD.h:640
BArray< BArray< DataChannel > > channels
The Data channels. Each channel can have multiple segments of data.
Definition: BdsD.h:649
BTimeStamp endTime
The End Time.
Definition: BdsD.h:645
BTimeStamp startTime
The Start Time.
Definition: BdsD.h:644
BList< BString > warnings
Warnings on the data set.
Definition: BdsD.h:652
BString array
The Seismic Array that all of the channels are from, if just one.
Definition: BdsD.h:646
BDict< BString > infoExtra
Extra Info on the set of channels. Used for extended error/logging information.
Definition: BdsD.h:651
BUInt32 synchronous
The channels are synchronously sampled.
Definition: BdsD.h:648
BDict< BString > info
Info on the set of channels.
Definition: BdsD.h:650
BString description
The Comment.
Definition: BdsD.h:647
This class defines a seismic Digitiser.
Definition: BdsD.h:385
BError setMember(BString name, BString value)
Definition: BdsD.cc:621
BInt32 shared
This digitiser is shared.
Definition: BdsD.h:404
BTimeStamp startTime
The Start Time.
Definition: BdsD.h:395
BUInt32 id
The ID.
Definition: BdsD.h:394
BString serialNumber
The digitisers's serial number.
Definition: BdsD.h:399
BTimeStamp endTime
The End Time the channel was available.
Definition: BdsD.h:396
BFloat64 gain
The overall gain of the digitiser at the manufacturers calibration frequency. (For information only)
Definition: BdsD.h:403
BString type
The Digitisers type.
Definition: BdsD.h:398
BString name
The Digitisers name.
Definition: BdsD.h:397
BFloat64 initialSamplingFrequency
The initial pre-decimation sampling frequency.
Definition: BdsD.h:402
BError getMember(BString name, BString &value)
Definition: BdsD.cc:589
BUInt32 numberChannels
The number of supported channels.
Definition: BdsD.h:400
BFloat64 baseSamplingFrequency
The base sampling frequency.
Definition: BdsD.h:401
BString getType()
Definition: BdsD.cc:572
BError setMembers(BDictString &members)
Definition: BdsD.cc:605
This class defines a seismic event.
Definition: BdsD.h:949
BFloat64 magnitude
Magnitude of the event.
Definition: BdsD.h:966
BString description
General description of the Event/Project.
Definition: BdsD.h:968
BString source
Unique source for this event if a project.
Definition: BdsD.h:958
BFloat64 elevation
The ground level elevation in meters from the WGS84 ellipsoid (Sea level)
Definition: BdsD.h:964
BFloat64 waterDepth
Water depth of the event if in water.
Definition: BdsD.h:965
BTimeStamp eventTime
The actual time of the event to the nearest microsecond.
Definition: BdsD.h:961
BString notes
General notes on the Event/project.
Definition: BdsD.h:969
BString network
Unique network for this event if a project.
Definition: BdsD.h:957
BString type
The event type (a hierarchy of types)
Definition: BdsD.h:955
BUInt32 userId
User ID for initial creator of this event. This allows them to edit these events.
Definition: BdsD.h:954
BDict< BString > extra
An array of name value pairs for extra metadata specific to particular events.
Definition: BdsD.h:970
BTimeStamp startTime
The startTime of the event to the nearest microsecond. For data access.
Definition: BdsD.h:959
BTimeStamp endTime
The endTime of the event to the nearest microsecond. For data access.
Definition: BdsD.h:960
BString magnitudeUnits
Magnitude Units.
Definition: BdsD.h:967
BFloat64 longitude
The longitude in degrees using the WGS84 datum.
Definition: BdsD.h:962
BString title
Some text describing the event.
Definition: BdsD.h:956
BUInt32 id
Unique id defining this event within the BDS system.
Definition: BdsD.h:953
BFloat64 latitude
The Latitude in degrees using the WGS84 datum.
Definition: BdsD.h:963
BList< SelectionChannel > dataChannels
List of BDS Channels of associated sensor data files if any.
Definition: BdsD.h:971
This class defines an entry in an Amplitude/Phase Response table.
Definition: BdsD.h:241
BFloat64 phase
The Phase.
Definition: BdsD.h:247
BFloat64 amplitude
The Amplitude.
Definition: BdsD.h:246
BFloat64 frequency
The frequency.
Definition: BdsD.h:245
This class defines an entry in a FIR coefficient table.
Definition: BdsD.h:252
BFloat64 error
FIR Coefficien Error.
Definition: BdsD.h:257
BFloat64 coefficient
FIR Coefficient Value.
Definition: BdsD.h:256
This class defines an FIR response table.
Definition: BdsD.h:263
BArray< FirEntry > a
FIR Denominator array.
Definition: BdsD.h:268
BArray< FirEntry > b
FIR Numerator array.
Definition: BdsD.h:267
This holds information on a User security group.
Definition: BdsD.h:755
BString group
The Group name.
Definition: BdsD.h:765
BString getType()
Definition: BdsD.cc:1237
BUInt32 id
The unique id.
Definition: BdsD.h:764
BError getMember(BString name, BString &value)
Definition: BdsD.cc:1246
BError setMember(BString name, BString value)
Definition: BdsD.cc:1262
BString description
The Groups description.
Definition: BdsD.h:766
BError setMembers(BDictString &members)
Definition: BdsD.cc:1254
This class defines an integer based range.
Definition: BdsD.h:82
BInt32 reverse
List from end.
Definition: BdsD.h:93
BError getMember(BString name, BString &value)
Definition: BdsD.cc:71
BError setMembers(BDictString &members)
Definition: BdsD.cc:79
BError setMember(BString name, BString value)
Definition: BdsD.cc:87
BUInt32 number
The number of items.
Definition: BdsD.h:92
BString getType()
Definition: BdsD.cc:62
BUInt32 start
The start position.
Definition: BdsD.h:91
This class defines the physical location of a Station.
Definition: BdsD.h:205
BTimeStamp endTime
The End Time the channel was available.
Definition: BdsD.h:216
BTimeStamp startTime
The Start Time.
Definition: BdsD.h:215
BString network
The Network/Organisation Name.
Definition: BdsD.h:217
BError getMember(BString name, BString &value)
Definition: BdsD.cc:302
BFloat64 elevation
The ground level elevation in meters from the WGS84 ellipsoid (Sea level)
Definition: BdsD.h:223
BError setMember(BString name, BString value)
Definition: BdsD.cc:336
BUInt32 id
The ID.
Definition: BdsD.h:214
BError setMembers(BDictString &members)
Definition: BdsD.cc:319
BFloat64 arrayOffsetNorth
The Array offset in an array in a northerly direction if array known/given. Note returns Array's Arra...
Definition: BdsD.h:225
BString station
The station this location is for.
Definition: BdsD.h:218
BFloat64 longitude
The longitude in degrees using the WGS84 datum.
Definition: BdsD.h:221
BFloat64 arrayOffsetEast
The Array offset in an array in an easterly direction if array known/given. Note returns Array's Arra...
Definition: BdsD.h:224
BFloat64 latitude
The Latitude in degrees using the WGS84 datum.
Definition: BdsD.h:222
BString channel
The channel this location is for. If blank the location is for the Station itself.
Definition: BdsD.h:219
BString datum
The locations Datum.
Definition: BdsD.h:220
BString getType()
Definition: BdsD.cc:284
This defines the selection cirteria when requesting a set of log entries.
Definition: BdsD.h:886
BUInt32 priority
The priority 0 to 5. Will return log entries at or above the priority given.
Definition: BdsD.h:892
BString type
The Type.
Definition: BdsD.h:891
BTimeStamp startTime
The start time.
Definition: BdsD.h:890
BString subSystem
The SubSystem.
Definition: BdsD.h:893
This holds information on a Log entry.
Definition: BdsD.h:867
BString title
The Changes title.
Definition: BdsD.h:881
BString getType()
Definition: BdsD.cc:1561
BTimeStamp time
The Time.
Definition: BdsD.h:877
BString subSystem
The SubSystem.
Definition: BdsD.h:880
BError getMember(BString name, BString &value)
Definition: BdsD.cc:1574
BString description
The Description of the change.
Definition: BdsD.h:882
BError setMember(BString name, BString value)
Definition: BdsD.cc:1598
BError setMembers(BDictString &members)
Definition: BdsD.cc:1586
BString type
The Type.
Definition: BdsD.h:878
BUInt32 id
The unique id.
Definition: BdsD.h:876
BUInt32 priority
The priority 0 to 5.
Definition: BdsD.h:879
This class defines a seismic Network organisation.
Definition: BdsD.h:98
BUInt32 id
Unique ID when stored in a database or for other uses.
Definition: BdsD.h:107
BString getType()
Definition: BdsD.cc:103
BString description
The organisations description.
Definition: BdsD.h:109
BError setMember(BString name, BString value)
Definition: BdsD.cc:131
BList< BString > stations
The list of arrays/stations the Network uses. (depreciated)
Definition: BdsD.h:110
BError setMembers(BDictString &members)
Definition: BdsD.cc:122
BString network
The name.
Definition: BdsD.h:108
BError getMember(BString name, BString &value)
Definition: BdsD.cc:113
This holds information on a Note for general information.
Definition: BdsD.h:835
BString user
The user.
Definition: BdsD.h:852
BString importFilename
The import filename.
Definition: BdsD.h:860
BUInt32 id
The unique id.
Definition: BdsD.h:844
BString type
The Type (note, warning, error ...)
Definition: BdsD.h:851
BInt32 errorNumber
Error number if error.
Definition: BdsD.h:854
BError getMember(BString name, BString &value)
Definition: BdsD.cc:1481
BUInt32 eventId
The event ID associated with this note.
Definition: BdsD.h:861
BUInt32 dataFileId
The data file id associated with this note.
Definition: BdsD.h:859
BError setMember(BString name, BString value)
Definition: BdsD.cc:1527
BString docUrl
Document Url if any.
Definition: BdsD.h:858
BString station
The Station/Array name.
Definition: BdsD.h:848
BString source
The Data Source.
Definition: BdsD.h:850
BString getType()
Definition: BdsD.cc:1457
BTimeStamp timeAdded
The Time Entered.
Definition: BdsD.h:853
BString channel
The Channels name.
Definition: BdsD.h:849
BString title
The title.
Definition: BdsD.h:855
BTimeStamp endTime
The End Time note is for.
Definition: BdsD.h:846
BString network
The Network Name.
Definition: BdsD.h:847
BString docFormat
Document format if any.
Definition: BdsD.h:857
BError setMembers(BDictString &members)
Definition: BdsD.cc:1504
BTimeStamp startTime
The Start Time note is for.
Definition: BdsD.h:845
BString description
The Description.
Definition: BdsD.h:856
This class defines an X,Y location.
Definition: BdsD.h:57
BFloat64 x
Definition: BdsD.h:61
BFloat64 y
Definition: BdsD.h:62
This class defines a Pole/Zero Response.
Definition: BdsD.h:231
BArray< BComplex > zeros
Zeros.
Definition: BdsD.h:236
BArray< BComplex > poles
Poles.
Definition: BdsD.h:235
This class defines an entry in a Polynomial coefficient table.
Definition: BdsD.h:273
BFloat64 minusError
Minus uncertainty or error in measured value.
Definition: BdsD.h:279
BFloat64 coefficient
The coefficient.
Definition: BdsD.h:277
BFloat64 plusError
Plus uncertainty or error in measured value.
Definition: BdsD.h:278
BString measurementMethod
The measurement method.
Definition: BdsD.h:280
This class defines an Polynomial response table.
Definition: BdsD.h:286
BFloat64 maximumError
Maximum Absolute Error.
Definition: BdsD.h:297
BFloat64 frequencyLowerBound
Lower Valid Frequency Bound.
Definition: BdsD.h:293
BFloat64 approximationLowerBound
Lower Bound of Approximation.
Definition: BdsD.h:295
BArray< PolynomialEntry > coefficients
The Coeficients.
Definition: BdsD.h:298
BString validFrequencyUnits
Valid Frequency Units.
Definition: BdsD.h:292
BFloat64 approximationUpperBound
Upper Bound of Approximation.
Definition: BdsD.h:296
BString approximationType
Polynomial Approximation Type.
Definition: BdsD.h:291
BString transferType
Transfer Type.
Definition: BdsD.h:290
BFloat64 frequencyUpperBound
Upper Valid Frequency Bound.
Definition: BdsD.h:294
This class defines a seismic Response characteristic.
Definition: BdsD.h:311
BUInt32 stage
The stage (0, 1, 2, 3, ...). 0 is a special overall response sometimes used.
Definition: BdsD.h:322
BUInt32 id
The ID.
Definition: BdsD.h:315
BString stageType
The stage type: A - Analog (rad/sec), B - Analog (Hz), C - Composite, D - Digital.
Definition: BdsD.h:331
Polynomial polynomial
The polynomial response.
Definition: BdsD.h:328
BFloat64 decimationOffset
Decimation sample offset.
Definition: BdsD.h:333
BFloat64 gain
Overall gain at gainFrequency.
Definition: BdsD.h:329
BFloat64 gainFrequency
Frequency that gain is valid for.
Definition: BdsD.h:330
BArray< Fap > faps
The FAP Frequency/Amplitude/Phase table.
Definition: BdsD.h:326
BFloat64 sampleRate
The stage's sample rate.
Definition: BdsD.h:339
BString source
The source.
Definition: BdsD.h:321
BFloat64 decimationCorr
Decimation correction performed.
Definition: BdsD.h:335
Fir fir
The FIR filters coefficients.
Definition: BdsD.h:327
BString channel
The channel.
Definition: BdsD.h:320
BFloat64 decimation
Decimation factor performed post filter.
Definition: BdsD.h:332
BString type
The type of response (PoleZero, FIR, FAP, Polynomial or blank if no frequency response)
Definition: BdsD.h:324
BTimeStamp startTime
The start time when ret response is valid from.
Definition: BdsD.h:316
BTimeStamp endTime
The end time the response is valid to.
Definition: BdsD.h:317
BString inputUnits
The units of the data as input from the perspective of data acquisition. After correcting data for th...
Definition: BdsD.h:340
BString symmetry
Symmetry for FIR coefficients (A = asymmetric, B = symmetric[odd], C = symmetric[even])
Definition: BdsD.h:336
BString description
Misc description.
Definition: BdsD.h:337
BString station
The station.
Definition: BdsD.h:319
BString inputUnitsDesc
The input units description.
Definition: BdsD.h:341
PoleZero poleZeros
The PoleZeros.
Definition: BdsD.h:325
BInt32 measured
Boolean if response was a measured response.
Definition: BdsD.h:338
BString outputUnits
The units of the data as output from the perspective of data acquisition. These would be the units of...
Definition: BdsD.h:342
BString name
The response name. (Anti-Aliasing filter, Digitiser, post filter etc)
Definition: BdsD.h:323
BString network
The Network/Organisation Name.
Definition: BdsD.h:318
BString outputUnitsDesc
The output units description.
Definition: BdsD.h:343
BFloat64 decimationDelay
Decimation delay in seconds.
Definition: BdsD.h:334
This class defines an idividual channel for selection.
Definition: BdsD.h:498
BString station
Definition: BdsD.h:503
BString network
Definition: BdsD.h:502
BString channel
Definition: BdsD.h:504
BString source
Definition: BdsD.h:505
This class defines the set of Metadata or Siesmic sensor data to be selected when getSelectionInfo() ...
Definition: BdsD.h:481
BList< BString > sources
The list of Data Sources.
Definition: BdsD.h:492
BList< BString > networks
The list of Network Names.
Definition: BdsD.h:487
BUInt32 numDataChannels
The number of sets of data in the system matching the criteria.
Definition: BdsD.h:493
BTimeStamp endTime
The End Time.
Definition: BdsD.h:486
BList< BString > arraysAndStations
The list of Array and Station names.
Definition: BdsD.h:490
BList< BString > stations
The list of Station names.
Definition: BdsD.h:489
BList< BString > channels
The list of Channels.
Definition: BdsD.h:491
BTimeStamp startTime
The Start Time.
Definition: BdsD.h:485
BList< BString > arrays
The list of Array names.
Definition: BdsD.h:488
This class defines a generic Metadata or Sensor data selection.
Definition: BdsD.h:515
BTimeStamp endTime
The End Time.
Definition: BdsD.h:522
BList< SelectionChannel > channels
The data channels to select.
Definition: BdsD.h:523
BUInt32 sensorOldId
The Sensor old id.
Definition: BdsD.h:527
BString excludeChannels
Comma separated wildcard list of channels to be excluded.
Definition: BdsD.h:535
BTimeStamp startTime
The Start Time.
Definition: BdsD.h:521
BUInt32 eventId
A particular event's ID.
Definition: BdsD.h:531
BUInt32 digitiserId
The Digitiser id.
Definition: BdsD.h:525
BUInt32 sensorId
The Sensor id.
Definition: BdsD.h:526
BString calibrationName
Calibration name to use.
Definition: BdsD.h:529
BInt32 completeSegments
Do not clip the segment times to match the required time period.
Definition: BdsD.h:528
LocationSelect locationSelect
Which locations to select, those for stations, channels or all of them when used in a locationGetList...
Definition: BdsD.h:533
BUInt32 id
The ID of the record to return.
Definition: BdsD.h:519
ListRange range
The range of data to return.
Definition: BdsD.h:520
BString name
Match the name, title or some other string in the objects to select.
Definition: BdsD.h:532
BString array
Channels are based on the given array (for array offsets)
Definition: BdsD.h:530
BUInt32 channelId
The Channel id.
Definition: BdsD.h:524
BString dataTypes
Place holder as yet for: A comma separated list of Channel dataTypes to select when returning Channel...
Definition: BdsD.h:534
This class defines a seismic Sensor.
Definition: BdsD.h:409
BTimeStamp endTime
The End Time.
Definition: BdsD.h:420
BString getType()
Definition: BdsD.cc:652
BString name
The Sensors name.
Definition: BdsD.h:421
BTimeStamp startTime
The Start Time.
Definition: BdsD.h:419
BError setMember(BString name, BString value)
Definition: BdsD.cc:701
BString gainUnits
The gain units.
Definition: BdsD.h:425
BError setMembers(BDictString &members)
Definition: BdsD.cc:685
BUInt32 id
The ID.
Definition: BdsD.h:418
BInt32 shared
This sensor is shared.
Definition: BdsD.h:428
BString serialNumber
The sensor's serial number. Only used when there is a unique physical sensor.
Definition: BdsD.h:423
BFloat64 gain
The overall gain of the sensor at the manufacturers calibration frequency. (For information only)
Definition: BdsD.h:426
BString type
The type of sensor. (Seismometer, Hydrophone etc)
Definition: BdsD.h:422
BUInt32 oldId
The Id from the old Autodrm database.
Definition: BdsD.h:427
BError getMember(BString name, BString &value)
Definition: BdsD.cc:669
BUInt32 numberChannels
The number of supported channels.
Definition: BdsD.h:424
This class defines a Source Priority entry.
Definition: BdsD.h:138
BError getMember(BString name, BString &value)
Definition: BdsD.cc:210
BString getType()
Definition: BdsD.cc:199
BUInt32 priority
The priority order, highest first.
Definition: BdsD.h:151
BTimeStamp startTime
The Start Time.
Definition: BdsD.h:148
BError setMembers(BDictString &members)
Definition: BdsD.cc:220
BTimeStamp endTime
The End Time the channel was available.
Definition: BdsD.h:149
BUInt32 id
Unique ID when stored in a database or for other uses.
Definition: BdsD.h:147
BString source
The source name.
Definition: BdsD.h:150
BError setMember(BString name, BString value)
Definition: BdsD.cc:230
This class defines a seismic data Source.
Definition: BdsD.h:118
BError setMember(BString name, BString value)
Definition: BdsD.cc:180
BUInt32 id
Unique ID when stored in a database or for other uses.
Definition: BdsD.h:127
BString alias
The short alias for data files.
Definition: BdsD.h:130
BString description
The description.
Definition: BdsD.h:131
BString source
The sensor data's source name.
Definition: BdsD.h:128
BString getType()
Definition: BdsD.cc:149
BString sourceMeta
The associated metadata's source name.
Definition: BdsD.h:129
BError getMember(BString name, BString &value)
Definition: BdsD.cc:160
BError setMembers(BDictString &members)
Definition: BdsD.cc:170
A Special channel identifier.
Definition: BdsD.h:927
BUInt32 id
Unique ID when stored in a database or for other uses.
Definition: BdsD.h:936
BString channel
The channels name, wildcards allowed (often as <channelType>_<channelAux>)
Definition: BdsD.h:941
BString network
The Network Name, wildcards allowed.
Definition: BdsD.h:939
BError getMember(BString name, BString &value)
Definition: BdsD.cc:1662
BTimeStamp startTime
The Start Time.
Definition: BdsD.h:937
BString station
The Stations name, wildcards allowed.
Definition: BdsD.h:940
BString getType()
Definition: BdsD.cc:1648
BTimeStamp endTime
The End Time the channel was available.
Definition: BdsD.h:938
BString description
The channels description.
Definition: BdsD.h:943
BString dataType
The Type of channel (ignore)
Definition: BdsD.h:942
BError setMembers(BDictString &members)
Definition: BdsD.cc:1675
BError setMember(BString name, BString value)
Definition: BdsD.cc:1688
This class defines a seismic station.
Definition: BdsD.h:187
BString description
Description.
Definition: BdsD.h:196
BString name
The name.
Definition: BdsD.h:193
BString alias
Alias name to be returned to the user.
Definition: BdsD.h:194
BUInt32 id
Unique ID when stored in a database or for other uses.
Definition: BdsD.h:191
BString type
The Station type. Set to "array" or "station".
Definition: BdsD.h:195
BList< ArrayChannel > channels
List of channels if an Array.
Definition: BdsD.h:197
BString network
The Network this station belongs to if for a partricular network.
Definition: BdsD.h:192
This class defines a TimePeriod.
Definition: BdsD.h:67
BTimeStamp endTime
The End time to the nearest us.
Definition: BdsD.h:77
BError setMembers(BDictString &members)
Definition: BdsD.cc:41
BTimeStamp startTime
The Start time to the nearest us.
Definition: BdsD.h:76
BError getMember(BString name, BString &value)
Definition: BdsD.cc:34
BError setMember(BString name, BString value)
Definition: BdsD.cc:48
BString getType()
Definition: BdsD.cc:26
This holds information on a user.
Definition: BdsD.h:732
BInt32 enabled
Whether the users account is enabled.
Definition: BdsD.h:748
BString name
The User's full name.
Definition: BdsD.h:744
BString address
The User's postal address.
Definition: BdsD.h:747
BString user
The User ID.
Definition: BdsD.h:742
BString telephone
The User's telephone number.
Definition: BdsD.h:746
BError setMembers(BDictString &members)
Definition: BdsD.cc:1202
BString password
The User's password.
Definition: BdsD.h:743
BUInt32 id
The unique user ID.
Definition: BdsD.h:741
BError setMember(BString name, BString value)
Definition: BdsD.cc:1216
BError getMember(BString name, BString &value)
Definition: BdsD.cc:1188
BString email
The User's email Address.
Definition: BdsD.h:745
BString getType()
Definition: BdsD.cc:1173
BList< BString > groups
The security groups the user belongs to.
Definition: BdsD.h:749
Definition: BdsC.cc:8
Priority
Priority levels.
Definition: BdsD.h:32
@ PriorityHigh
Definition: BdsD.h:32
@ PriorityLow
Definition: BdsD.h:32
@ PriorityNormal
Definition: BdsD.h:32
LocationSelect
Which Locations to select.
Definition: BdsD.h:53
@ LocationSelectStation
Definition: BdsD.h:53
@ LocationSelectChannel
Definition: BdsD.h:53
@ LocationSelectAll
Definition: BdsD.h:53
AvailType
A flag defining the data availability state.
Definition: BdsD.h:47
@ AvailNone
Definition: BdsD.h:47
@ AvailFull
Definition: BdsD.h:47
@ AvailPartial
Definition: BdsD.h:47
Mode
BdsServer mode.
Definition: BdsD.h:35
@ ModeSlave
Definition: BdsD.h:35
@ ModeMaster
Definition: BdsD.h:35
BList< DataFormat > DataFormats
A list of the available Sensor data formats.
Definition: BdsD.h:922
SelectionGroup
The Selection group when making selections.
Definition: BdsD.h:41
@ SelectionGroupMetaData
Definition: BdsD.h:41
@ SelectionGroupDataWithCount
Definition: BdsD.h:41
@ SelectionGroupData
Definition: BdsD.h:41
DataFlags
Flags when opening data files.
Definition: BdsD.h:38
@ DataFlagClipDataToChannels
Definition: BdsD.h:38
@ DataFlagClipDataToTime
Definition: BdsD.h:38
@ DataFlagNoMetadata
Definition: BdsD.h:38
@ DataFlagMergeSegments
Definition: BdsD.h:38
@ DataFlagNone
Definition: BdsD.h:38
SampleFormat
The actual format of a data sample.
Definition: BdsD.h:44
@ SampleFormatFloat32
Definition: BdsD.h:44
@ SampleFormatInt32
Definition: BdsD.h:44
@ SampleFormatUnknown
Definition: BdsD.h:44
@ SampleFormatInt16
Definition: BdsD.h:44
@ SampleFormatFloat64
Definition: BdsD.h:44
@ SampleFormatInt24
Definition: BdsD.h:44
DataFormatSet
Data format abilities bitset.
Definition: BdsD.h:50
@ DataFormatSetSensordataWrite
Definition: BdsD.h:50
@ DataFormatSetMetadataRead
Definition: BdsD.h:50
@ DataFormatSetMetadataWrite
Definition: BdsD.h:50
@ DataFormatSetNone
Definition: BdsD.h:50
@ DataFormatSetSensordataRead
Definition: BdsD.h:50
Errors
The System Error number list in addition to standard system error numbers.
Definition: BdsD.h:29
@ ErrorValidateTimeBackwards
Definition: BdsD.h:29
@ ErrorDataQuality
Definition: BdsD.h:29
@ ErrorValidateReorder
Definition: BdsD.h:29
@ ErrorValidateDuplicate
Definition: BdsD.h:29
@ ErrorValidateMetaData
Definition: BdsD.h:29
@ ErrorSlaveMode
Definition: BdsD.h:29
@ ErrorNoMetaData
Definition: BdsD.h:29
@ ErrorValidate
Definition: BdsD.h:29
@ ErrorTimeStamp
Definition: BdsD.h:29
@ ErrorValidateFix
Definition: BdsD.h:29
@ ErrorValidateFilenameTime
Definition: BdsD.h:29
@ ErrorValidateMissingBlocks
Definition: BdsD.h:29
@ ErrorValidateBdsFudge
Definition: BdsD.h:29