BDS Public
BdsApi 4.0.1
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
60 class Point {
61 public:
62 Point(BFloat64 x = 0, BFloat64 y = 0);
63 public:
66 };
67
70 class TimePeriod : public BObj {
71 public:
73 const char* getType() const;
75 BError setMember(BString name, BString value);
77 BError getMember(BString name, BString& value);
78 public:
81 };
82
85 class ListRange : public BObj {
86 public:
88 const char* getType() const;
90 BError setMember(BString name, BString value);
92 BError getMember(BString name, BString& value);
93 public:
97 };
98
101 class Network : public BObj {
102 public:
104 const char* getType() const;
105 BError setMembers(BDictString& members);
106 BError setMember(BString name, BString value);
107 BError getMembers(BDictString& members);
108 BError getMember(BString name, BString& value);
109 public:
113 };
114
120 class Source : public BObj {
121 public:
123 const char* getType() const;
124 BError setMembers(BDictString& members);
125 BError setMember(BString name, BString value);
126 BError getMembers(BDictString& members);
127 BError getMember(BString name, BString& value);
128 public:
134 };
135
140 class SourcePriority : public BObj {
141 public:
143 const char* getType() const;
144 BError setMembers(BDictString& members);
145 BError setMember(BString name, BString value);
146 BError getMembers(BDictString& members);
147 BError getMember(BString name, BString& value);
148 public:
154 };
155
160 public:
162 public:
167 };
168
174 public:
176 public:
182 };
183
189 class Station {
190 public:
192 public:
200 };
201
207 class Location : public BObj {
208 public:
210 const char* getType() const;
211 BError setMembers(BDictString& members);
212 BError setMember(BString name, BString value);
213 BError getMembers(BDictString& members);
214 BError getMember(BString name, BString& value);
215 public:
228 };
229
230 //
233 class PoleZero {
234 public:
236 public:
239 };
240
241 //
243 class Fap {
244 public:
246 public:
250 };
251
252 //
254 class FirEntry {
255 public:
257 public:
260 };
261
262 //
265 class Fir {
266 public:
268 public:
271 };
272
273 //
276 public:
278 public:
283 };
284
285 //
289 public:
291 public:
301 };
302
303 //
313 class Response {
314 public:
316 public:
346 };
347
354 class Calibration : public BObj {
355 public:
357 const char* getType() const;
358 BError setMembers(BDictString& members);
360 BError getMembers(BDictString& members);
362 public:
383 };
384
387 class Digitiser : public BObj {
388 public:
390 const char* getType() const;
391 BError setMembers(BDictString& members);
393 BError getMembers(BDictString& members);
395 public:
407 };
408
411 class Sensor : public BObj {
412 public:
414 const char* getType() const;
415 BError setMembers(BDictString& members);
417 BError getMembers(BDictString& members);
419 public:
431 };
432
437 class ChannelInstrument : public BObj {
438 public:
440 const char* getType() const;
441 BError setMembers(BDictString& members);
442 BError setMember(BString name, BString value);
443 BError getMembers(BDictString& members);
444 BError getMember(BString name, BString& value);
445 public:
453 };
454
460 class Channel : public BObj {
461 public:
463 const char* getType() const;
464 BError setMembers(BDictString& members);
465 BError setMember(BString name, BString value);
466 BError getMembers(BDictString& members);
467 BError getMember(BString name, BString& value);
468 public:
479 };
480
484 public:
486 public:
496 };
497
501 public:
503 public:
508 };
509
517 class Selection {
518 public:
520 public:
538 };
539
545 public:
547 public:
559 };
560
567 public:
569 public:
572 };
573
578 class DataFileInfo : public BObj {
579 public:
581 const char* getType() const;
582 BError setMembers(BDictString& members);
583 BError setMember(BString name, BString value);
584 BError getMembers(BDictString& members);
585 BError getMember(BString name, BString& value);
586 public:
598 };
599
607 class DataChannel : public BObj {
608 public:
610 const char* getType() const;
611 BError setMembers(BDictString& members);
612 BError setMember(BString name, BString value);
613 BError getMembers(BDictString& members);
614 BError getMember(BString name, BString& value);
615 public:
634 };
635
643 class DataInfo {
644 public:
646 public:
656 };
657
659 class DataAvail {
660 public:
662 public:
666 };
667
677 public:
679 public:
687 };
688
691 public:
693 public:
696 };
697
710 class DataBlock {
711 public:
713 public:
720 };
721
724 public:
726 public:
731 };
732
735 class User : public BObj {
736 public:
738 const char* getType() const;
739 BError setMembers(BDictString& members);
741 BError getMembers(BDictString& members);
743 public:
753 };
754
758 class Group : public BObj {
759 public:
761 const char* getType() const;
762 BError setMembers(BDictString& members);
763 BError setMember(BString name, BString value);
764 BError getMembers(BDictString& members);
765 BError getMember(BString name, BString& value);
766 public:
770 };
771
775 class AccessGroup : public BObj {
776 public:
778 const char* getType() const;
779 BError setMembers(BDictString& members);
780 BError setMember(BString name, BString value);
781 BError getMembers(BDictString& members);
782 BError getMember(BString name, BString& value);
783 public:
790 };
791
796 class Change : public BObj {
797 public:
799 const char* getType() const;
800 BError setMembers(BDictString& members);
801 BError setMember(BString name, BString value);
802 BError getMembers(BDictString& members);
803 BError getMember(BString name, BString& value);
804 public:
811 };
812
817 class ChangeGroup : public BObj {
818 public:
820 const char* getType() const;
821 BError setMembers(BDictString& members);
822 BError setMember(BString name, BString value);
823 BError getMembers(BDictString& members);
824 BError getMember(BString name, BString& value);
825 public:
832 };
833
838 class Note : public BObj {
839 public:
841 const char* getType() const;
842 BError setMembers(BDictString& members);
843 BError setMember(BString name, BString value);
844 BError getMembers(BDictString& members);
845 BError getMember(BString name, BString& value);
846 public:
865 };
866
870 class Log : public BObj {
871 public:
873 const char* getType() const;
874 BError setMembers(BDictString& members);
875 BError setMember(BString name, BString value);
876 BError getMembers(BDictString& members);
877 BError getMember(BString name, BString& value);
878 public:
886 };
887
889 class LogSelect {
890 public:
892 public:
897 };
898
901 public:
903 public:
907 };
908
912 public:
914 public:
922 };
923
926
930 class SpecialChannel : public BObj {
931 public:
933 const char* getType() const;
934 BError setMembers(BDictString& members);
935 BError setMember(BString name, BString value);
936 BError getMembers(BDictString& members);
937 BError getMember(BString name, BString& value);
938 public:
947 };
948
952 class Event {
953 public:
955 public:
976 };
977
991}
992
993#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:775
BError setMember(BString name, BString value)
Definition BdsD.cc:1314
BString network
The Network Name.
Definition BdsD.h:788
const char * getType() const
Definition BdsD.cc:1280
BError setMembers(BDictString &members)
Definition BdsD.cc:1303
BTimeStamp startTime
The Start Time.
Definition BdsD.h:786
BTimeStamp endTime
The End Time.
Definition BdsD.h:787
BError getMember(BString name, BString &value)
Definition BdsD.cc:1292
BUInt32 id
The unique id.
Definition BdsD.h:784
BString station
The Station name.
Definition BdsD.h:789
BString group
The Group name.
Definition BdsD.h:785
This class defines an array's channel.
Definition BdsD.h:173
BFloat64 arrayOffsetNorth
The Location offset in in an array in a northerly direction in metres.
Definition BdsD.h:181
BFloat64 arrayOffsetEast
The Location offset in in an array in an easterly direction in metres.
Definition BdsD.h:180
BString station
The Stations name.
Definition BdsD.h:178
BString network
The Network this station belongs to if for a partricular network.
Definition BdsD.h:177
BString channel
The Channels name.
Definition BdsD.h:179
This class defines a calibration setting.
Definition BdsD.h:354
BString source
The source.
Definition BdsD.h:369
BError getMember(BString name, BString &value)
Definition BdsD.cc:477
BString rawCalibrationUnits
The raw data measurment SI units such as "m".
Definition BdsD.h:378
const char * getType() const
Definition BdsD.cc:451
BString channel
The channel.
Definition BdsD.h:368
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:377
BTimeStamp startTime
The Start Time.
Definition BdsD.h:364
BString network
The Network/Organisation Name.
Definition BdsD.h:366
BFloat64 calibrationFactor
The post response compensation scaling value to apply to the data to normalise data to the units....
Definition BdsD.h:373
BTimeStamp endTime
The End Time.
Definition BdsD.h:365
BString calibrationUnitsDesc
A description of the calibrationUnits.
Definition BdsD.h:375
BFloat64 rawCalibrationFrequency
The raw data frequency that the CalibrationFactor value is valid for in Hz.
Definition BdsD.h:376
BFloat64 samplingFrequency
The sample rate used in Hz.
Definition BdsD.h:371
BString name
The Calibrations name, "Main", "Measured".
Definition BdsD.h:370
BFloat64 horizontalAngle
The Sensors channel placement horizontal angle in degrees clockwise from north.
Definition BdsD.h:381
BError setMembers(BDictString &members)
Definition BdsD.cc:502
BString calibrationUnits
The post response compensation measurment SI units such as "m".
Definition BdsD.h:374
BFloat64 calibrationFrequency
The post response compensation frequency that the CalibrationFactor value is valid for in Hz.
Definition BdsD.h:372
BFloat64 waterLevel
Elevation of the water surface in meters for underwater sites, where 0 is sea level.
Definition BdsD.h:380
BString station
The station.
Definition BdsD.h:367
BError setMember(BString name, BString value)
Definition BdsD.cc:527
BFloat64 verticalAngle
The Sensors channel placement vertical angle in degrees degrees with zero = vertically up.
Definition BdsD.h:382
BUInt32 id
The ID.
Definition BdsD.h:363
BFloat64 depth
The depth of the sensor below ground level in meters.
Definition BdsD.h:379
This holds information on a set of Changes.
Definition BdsD.h:817
BString description
The Description of the change.
Definition BdsD.h:831
BString user
The user who made the change.
Definition BdsD.h:829
BError setMembers(BDictString &members)
Definition BdsD.cc:1413
BUInt32 id
The unique id.
Definition BdsD.h:826
BString type
The type of change.
Definition BdsD.h:828
const char * getType() const
Definition BdsD.cc:1390
BString title
The Changes title.
Definition BdsD.h:830
BError setMember(BString name, BString value)
Definition BdsD.cc:1424
BTimeStamp time
The Time the change was made.
Definition BdsD.h:827
BError getMember(BString name, BString &value)
Definition BdsD.cc:1402
This holds information on a Medatdata or Sensor data database change.
Definition BdsD.h:796
BError getMember(BString name, BString &value)
Definition BdsD.cc:1347
BUInt32 changeGroupId
The Change group ID.
Definition BdsD.h:806
const char * getType() const
Definition BdsD.cc:1335
BUInt32 id
The unique id.
Definition BdsD.h:805
BString table
The database table affected.
Definition BdsD.h:809
BString type
The change type.
Definition BdsD.h:808
BUInt32 rowId
The database row affected.
Definition BdsD.h:810
BTimeStamp time
The Time the change was made.
Definition BdsD.h:807
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:544
BTimeStamp startTime
The Start Time.
Definition BdsD.h:548
BString source
The data source.
Definition BdsD.h:554
Digitiser digitiser
The Digitiser in use.
Definition BdsD.h:555
BTimeStamp endTime
The End Time.
Definition BdsD.h:549
Location channelLocation
The Channel location.
Definition BdsD.h:553
Station station
The Station info.
Definition BdsD.h:550
BList< Response > responses
The list of frequency responses.
Definition BdsD.h:558
Location stationLocation
The Station location.
Definition BdsD.h:551
Calibration calibration
The Calibration info.
Definition BdsD.h:557
Sensor sensor
The Sensor in use.
Definition BdsD.h:556
Channel channel
The Channel data.
Definition BdsD.h:552
This class provides Metadata information on a set of channels.
Definition BdsD.h:566
Station array
The array if all channels are from an array.
Definition BdsD.h:570
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:571
This class defines a Channel's instrument.
Definition BdsD.h:437
const char * getType() const
Definition BdsD.cc:723
BString source
The source.
Definition BdsD.h:450
BUInt32 digitiserId
The Digitiser in use.
Definition BdsD.h:451
BError setMembers(BDictString &members)
Definition BdsD.cc:748
BUInt32 id
Unique ID when stored in a database or for other uses.
Definition BdsD.h:446
BError getMember(BString name, BString &value)
Definition BdsD.cc:736
BUInt32 sensorId
The sensor in use.
Definition BdsD.h:452
BError setMember(BString name, BString value)
Definition BdsD.cc:760
BTimeStamp endTime
The End Time the channel was available.
Definition BdsD.h:448
BTimeStamp startTime
The Start Time.
Definition BdsD.h:447
BUInt32 channelId
The channels Id.
Definition BdsD.h:449
This class defines a full channel name.
Definition BdsD.h:159
BString channel
The Channels name.
Definition BdsD.h:165
BString network
The Channels network.
Definition BdsD.h:163
BString station
The Channels station.
Definition BdsD.h:164
BString source
The Channels source.
Definition BdsD.h:166
This class defines a seismic data Channel.
Definition BdsD.h:460
BString network
The Network Name.
Definition BdsD.h:472
BString description
The channels description.
Definition BdsD.h:478
BString channelAux
The channels auxilary identifier (component of station field)
Definition BdsD.h:476
BError setMembers(BDictString &members)
Definition BdsD.cc:817
const char * getType() const
Definition BdsD.cc:786
BUInt32 id
Unique ID when stored in a database or for other uses.
Definition BdsD.h:469
BString dataType
The Type of data (seismic, seismicUnknown, data, log, unknown, empty)
Definition BdsD.h:477
BTimeStamp endTime
The End Time the channel was available.
Definition BdsD.h:471
BString channelType
The channels type (component of station field)
Definition BdsD.h:475
BString channel
The channels name (often as <channelType>_<channelAux>)
Definition BdsD.h:474
BString station
The Stations name.
Definition BdsD.h:473
BTimeStamp startTime
The Start Time.
Definition BdsD.h:470
BError setMember(BString name, BString value)
Definition BdsD.cc:832
BError getMember(BString name, BString &value)
Definition BdsD.cc:802
This defines the set of clean options used in the clean() function.
Definition BdsD.h:900
BInt32 deletedFiles
Clean deleted data files.
Definition BdsD.h:906
BInt32 logs
Clean the Logs.
Definition BdsD.h:904
BInt32 changes
Clean the changes.
Definition BdsD.h:905
This class defines avaiilablity information on a set of data.
Definition BdsD.h:676
BArray< DataAvail > segments
Data time segment availability info.
Definition BdsD.h:686
BString station
The Station name.
Definition BdsD.h:683
BString channel
The Channels name.
Definition BdsD.h:684
BTimeStamp startTime
The Start Time.
Definition BdsD.h:680
BTimeStamp endTime
The End Time.
Definition BdsD.h:681
BString network
The Network Name.
Definition BdsD.h:682
BString source
The Data Source.
Definition BdsD.h:685
This class provides availability information on a particular period of data.
Definition BdsD.h:659
BTimeStamp endTime
The End Time.
Definition BdsD.h:664
BTimeStamp startTime
The Start Time.
Definition BdsD.h:663
AvailType availType
The availability type. Can be: AvailNone, AvailPartial or AvailFull.
Definition BdsD.h:665
This class provides the actual seismic data values contained within a single data block along with th...
Definition BdsD.h:723
BString source
The Data Source or Sources.
Definition BdsD.h:730
BString station
The Station name or Stations.
Definition BdsD.h:728
BString network
The Network Name or names.
Definition BdsD.h:727
BString channel
The Channels name or Channels.
Definition BdsD.h:729
This class provides the actual Sensor data values contained within a single data block.
Definition BdsD.h:710
BArray< BArray< BFloat64 > > channelData
The raw channel data in a 2 dimensional array, ordered as per channel information in dataInfo.
Definition BdsD.h:718
BTimeStamp endTime
The End Time the channel was available.
Definition BdsD.h:715
BDict< BString > info
Extra information on data or ASCII data.
Definition BdsD.h:719
BUInt32 segmentNumber
The segment number. (1, 2, 3, ...)
Definition BdsD.h:717
BUInt32 channelNumber
The first channel number. (1, 2, 3 ...)
Definition BdsD.h:716
BTimeStamp startTime
The Start Time.
Definition BdsD.h:714
This class defines information on a single channel's set of data stored in a file.
Definition BdsD.h:607
BUInt32 sampleFormat
The data sample format.
Definition BdsD.h:626
BUInt32 dataFileChannel
The Data File Channel number. The channel number within the data file. (1, 2, 3 .....
Definition BdsD.h:628
BUInt64 numSamples
The total number of samples per channel if known, 0 otherwise.
Definition BdsD.h:624
const char * getType() const
Definition BdsD.cc:1012
BString importFormat
The original data format.
Definition BdsD.h:629
BError setMembers(BDictString &members)
Definition BdsD.cc:1059
BFloat64 sampleRate
The data's sample rate.
Definition BdsD.h:625
BDict< BString > info
Extra info on the channel.
Definition BdsD.h:633
BUInt32 id
Unique ID when stored in a database or for other uses.
Definition BdsD.h:616
BString importStream
The real-time data stream the import is from.
Definition BdsD.h:630
BString station
The Station name.
Definition BdsD.h:620
BTimeStamp endTime
The End Time.
Definition BdsD.h:618
BString channel
The Channels name.
Definition BdsD.h:621
BString network
The Network Name.
Definition BdsD.h:619
BString source
The Data Source.
Definition BdsD.h:622
BTimeStamp startTime
The Start Time.
Definition BdsD.h:617
BUInt32 dataFileId
The Data File Id. This links to the particular DataFileInfo where the data is stored.
Definition BdsD.h:627
BError setMember(BString name, BString value)
Definition BdsD.cc:1082
BTimeStamp importStartTime
The original import files start time.
Definition BdsD.h:632
BString importFilename
The original data file name.
Definition BdsD.h:631
BError getMember(BString name, BString &value)
Definition BdsD.cc:1036
BUInt32 numBlocks
The total number of blocks per channel if known, 0 otherwise.
Definition BdsD.h:623
This class defines information on a Sensor data file.
Definition BdsD.h:578
BTimeStamp startTime
The Start Time.
Definition BdsD.h:588
BError getMember(BString name, BString &value)
Definition BdsD.cc:942
BError setMember(BString name, BString value)
Definition BdsD.cc:974
BUInt32 importUserId
The user ID of the importing user.
Definition BdsD.h:595
BString comment
A comment on the file.
Definition BdsD.h:594
BTimeStamp importTime
The Time the data was imported.
Definition BdsD.h:596
BString format
The data format.
Definition BdsD.h:591
BString location
The storage location.
Definition BdsD.h:590
BString stream
The real-time data stream.
Definition BdsD.h:593
BError setMembers(BDictString &members)
Definition BdsD.cc:958
BTimeStamp endTime
The End Time.
Definition BdsD.h:589
BString state
Status info on the import (importing, realtime, failed, ok etc)
Definition BdsD.h:597
BString url
The URL for file access.
Definition BdsD.h:592
BUInt32 id
Unique ID when stored in a database or for other uses.
Definition BdsD.h:587
const char * getType() const
Definition BdsD.cc:925
This holds information on a Sensor data format.
Definition BdsD.h:911
BInt32 dataRead
Ability to read Sensor data.
Definition BdsD.h:916
BList< BString > names
The format names.
Definition BdsD.h:915
BInt32 metadataWrite
MetaData write supported.
Definition BdsD.h:919
BInt32 metadataRead
MetaData read supported.
Definition BdsD.h:918
BString extension
Default filename extension.
Definition BdsD.h:920
BString description
The description.
Definition BdsD.h:921
BInt32 dataWrite
Ability to write Sensor data.
Definition BdsD.h:917
This defines a handle to a sensor data stream/file when opened for read or write.
Definition BdsD.h:690
BUInt32 dataFileId
The data file ID if opened for write.
Definition BdsD.h:695
BUInt32 handle
Opaque file handle.
Definition BdsD.h:694
This class defines information on a set of data.
Definition BdsD.h:643
BArray< BArray< DataChannel > > channels
The Data channels. Each channel can have multiple segments of data.
Definition BdsD.h:652
BTimeStamp endTime
The End Time.
Definition BdsD.h:648
BTimeStamp startTime
The Start Time.
Definition BdsD.h:647
BList< BString > warnings
Warnings on the data set.
Definition BdsD.h:655
BString array
The Seismic Array that all of the channels are from, if just one.
Definition BdsD.h:649
BDict< BString > infoExtra
Extra Info on the set of channels. Used for extended error/logging information.
Definition BdsD.h:654
BUInt32 synchronous
The channels are synchronously sampled.
Definition BdsD.h:651
BDict< BString > info
Info on the set of channels.
Definition BdsD.h:653
BString description
The Comment.
Definition BdsD.h:650
This class defines a seismic Digitiser.
Definition BdsD.h:387
BError setMember(BString name, BString value)
Definition BdsD.cc:616
BInt32 shared
This digitiser is shared.
Definition BdsD.h:406
BTimeStamp startTime
The Start Time.
Definition BdsD.h:397
BUInt32 id
The ID.
Definition BdsD.h:396
BString serialNumber
The digitisers's serial number.
Definition BdsD.h:401
BTimeStamp endTime
The End Time the channel was available.
Definition BdsD.h:398
BFloat64 gain
The overall gain of the digitiser at the manufacturers calibration frequency. (For information only)
Definition BdsD.h:405
const char * getType() const
Definition BdsD.cc:567
BString type
The Digitisers type.
Definition BdsD.h:400
BString name
The Digitisers name.
Definition BdsD.h:399
BFloat64 initialSamplingFrequency
The initial pre-decimation sampling frequency.
Definition BdsD.h:404
BError getMember(BString name, BString &value)
Definition BdsD.cc:584
BUInt32 numberChannels
The number of supported channels.
Definition BdsD.h:402
BFloat64 baseSamplingFrequency
The base sampling frequency.
Definition BdsD.h:403
BError setMembers(BDictString &members)
Definition BdsD.cc:600
This class defines a seismic event.
Definition BdsD.h:952
BFloat64 magnitude
Magnitude of the event.
Definition BdsD.h:970
BString description
General description of the Event/Project.
Definition BdsD.h:972
BString source
Unique source for this event if a project.
Definition BdsD.h:961
BFloat64 elevation
The ground level elevation in meters from the WGS84 ellipsoid (or sea level)
Definition BdsD.h:967
BFloat64 waterDepth
Water depth in meters of the event if in water.
Definition BdsD.h:968
BTimeStamp eventTime
The actual time of the event to the nearest microsecond.
Definition BdsD.h:964
BString notes
General notes on the Event/project.
Definition BdsD.h:973
BString network
Unique network for this event if a project.
Definition BdsD.h:960
BString type
The event type (a hierarchy of types)
Definition BdsD.h:958
BUInt32 userId
User ID for initial creator of this event. This allows them to edit these events.
Definition BdsD.h:957
BDict< BString > extra
An array of name value pairs for extra metadata specific to particular events.
Definition BdsD.h:974
BTimeStamp startTime
The startTime of the event to the nearest microsecond. For data access.
Definition BdsD.h:962
BTimeStamp endTime
The endTime of the event to the nearest microsecond. For data access.
Definition BdsD.h:963
BString magnitudeUnits
Magnitude Units.
Definition BdsD.h:971
BFloat64 eventDepth
The events depth in meters below the local elevation using WGS84 (negative if above ground/water surf...
Definition BdsD.h:969
BFloat64 longitude
The longitude in degrees using the WGS84 datum.
Definition BdsD.h:965
BString title
Some text describing the event.
Definition BdsD.h:959
BUInt32 id
Unique id defining this event within the BDS system.
Definition BdsD.h:956
BFloat64 latitude
The Latitude in degrees using the WGS84 datum.
Definition BdsD.h:966
BList< SelectionChannel > dataChannels
List of BDS Channels of associated sensor data files if any.
Definition BdsD.h:975
This class defines an entry in an Amplitude/Phase Response table.
Definition BdsD.h:243
BFloat64 phase
The Phase.
Definition BdsD.h:249
BFloat64 amplitude
The Amplitude.
Definition BdsD.h:248
BFloat64 frequency
The frequency.
Definition BdsD.h:247
This class defines an entry in a FIR coefficient table.
Definition BdsD.h:254
BFloat64 error
FIR Coefficien Error.
Definition BdsD.h:259
BFloat64 coefficient
FIR Coefficient Value.
Definition BdsD.h:258
This class defines an FIR response table.
Definition BdsD.h:265
BArray< FirEntry > a
FIR Denominator array.
Definition BdsD.h:270
BArray< FirEntry > b
FIR Numerator array.
Definition BdsD.h:269
This holds information on a User security group.
Definition BdsD.h:758
BString group
The Group name.
Definition BdsD.h:768
BUInt32 id
The unique id.
Definition BdsD.h:767
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:769
BError setMembers(BDictString &members)
Definition BdsD.cc:1254
const char * getType() const
Definition BdsD.cc:1237
This class defines an integer based range.
Definition BdsD.h:85
BInt32 reverse
List from end.
Definition BdsD.h:96
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
const char * getType() const
Definition BdsD.cc:62
BUInt32 number
The number of items.
Definition BdsD.h:95
BUInt32 start
The start position.
Definition BdsD.h:94
This class defines the physical location of a Station.
Definition BdsD.h:207
BTimeStamp endTime
The End Time the channel was available.
Definition BdsD.h:218
const char * getType() const
Definition BdsD.cc:279
BTimeStamp startTime
The Start Time.
Definition BdsD.h:217
BString network
The Network/Organisation Name.
Definition BdsD.h:219
BError getMember(BString name, BString &value)
Definition BdsD.cc:297
BFloat64 elevation
The ground level elevation in meters from the WGS84 ellipsoid (Sea level)
Definition BdsD.h:225
BError setMember(BString name, BString value)
Definition BdsD.cc:331
BUInt32 id
The ID.
Definition BdsD.h:216
BError setMembers(BDictString &members)
Definition BdsD.cc:314
BFloat64 arrayOffsetNorth
The read=only Array offset in an array in a northerly direction if array known/given....
Definition BdsD.h:227
BString station
The station this location is for.
Definition BdsD.h:220
BFloat64 longitude
The longitude in degrees using the WGS84 datum.
Definition BdsD.h:223
BFloat64 arrayOffsetEast
The read=only Array offset in an array in an easterly direction if array known/given....
Definition BdsD.h:226
BFloat64 latitude
The Latitude in degrees using the WGS84 datum.
Definition BdsD.h:224
BString channel
The channel this location is for. If blank the location is for the Station itself.
Definition BdsD.h:221
BString datum
The locations Datum.
Definition BdsD.h:222
This defines the selection cirteria when requesting a set of log entries.
Definition BdsD.h:889
BUInt32 priority
The priority 0 to 5. Will return log entries at or above the priority given.
Definition BdsD.h:895
BString type
The Type.
Definition BdsD.h:894
BTimeStamp startTime
The start time.
Definition BdsD.h:893
BString subSystem
The SubSystem.
Definition BdsD.h:896
This holds information on a Log entry.
Definition BdsD.h:870
const char * getType() const
Definition BdsD.cc:1561
BString title
The Changes title.
Definition BdsD.h:884
BTimeStamp time
The Time.
Definition BdsD.h:880
BString subSystem
The SubSystem.
Definition BdsD.h:883
BError getMember(BString name, BString &value)
Definition BdsD.cc:1574
BString description
The Description of the change.
Definition BdsD.h:885
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:881
BUInt32 id
The unique id.
Definition BdsD.h:879
BUInt32 priority
The priority 0 to 5.
Definition BdsD.h:882
This class defines a seismic Network organisation.
Definition BdsD.h:101
BUInt32 id
Unique ID when stored in a database or for other uses.
Definition BdsD.h:110
BString description
The organisations description.
Definition BdsD.h:112
BError setMember(BString name, BString value)
Definition BdsD.cc:127
const char * getType() const
Definition BdsD.cc:102
BError setMembers(BDictString &members)
Definition BdsD.cc:119
BString network
The name.
Definition BdsD.h:111
BError getMember(BString name, BString &value)
Definition BdsD.cc:111
This holds information on a Note for general information.
Definition BdsD.h:838
BString user
The user.
Definition BdsD.h:855
BString importFilename
The import filename.
Definition BdsD.h:863
BUInt32 id
The unique id.
Definition BdsD.h:847
BString type
The Type (note, warning, error ...)
Definition BdsD.h:854
BInt32 errorNumber
Error number if error.
Definition BdsD.h:857
BError getMember(BString name, BString &value)
Definition BdsD.cc:1481
BUInt32 eventId
The event ID associated with this note.
Definition BdsD.h:864
BUInt32 dataFileId
The data file id associated with this note.
Definition BdsD.h:862
BError setMember(BString name, BString value)
Definition BdsD.cc:1527
BString docUrl
Document Url if any.
Definition BdsD.h:861
BString station
The Station/Array name.
Definition BdsD.h:851
BString source
The Data Source.
Definition BdsD.h:853
BTimeStamp timeAdded
The Time Entered.
Definition BdsD.h:856
BString channel
The Channels name.
Definition BdsD.h:852
BString title
The title.
Definition BdsD.h:858
BTimeStamp endTime
The End Time note is for.
Definition BdsD.h:849
const char * getType() const
Definition BdsD.cc:1457
BString network
The Network Name.
Definition BdsD.h:850
BString docFormat
Document format if any.
Definition BdsD.h:860
BError setMembers(BDictString &members)
Definition BdsD.cc:1504
BTimeStamp startTime
The Start Time note is for.
Definition BdsD.h:848
BString description
The Description.
Definition BdsD.h:859
This class defines an X,Y location.
Definition BdsD.h:60
BFloat64 x
Definition BdsD.h:64
BFloat64 y
Definition BdsD.h:65
This class defines a Pole/Zero Response.
Definition BdsD.h:233
BArray< BComplex > zeros
Zeros.
Definition BdsD.h:238
BArray< BComplex > poles
Poles.
Definition BdsD.h:237
This class defines an entry in a Polynomial coefficient table.
Definition BdsD.h:275
BFloat64 minusError
Minus uncertainty or error in measured value.
Definition BdsD.h:281
BFloat64 coefficient
The coefficient.
Definition BdsD.h:279
BFloat64 plusError
Plus uncertainty or error in measured value.
Definition BdsD.h:280
BString measurementMethod
The measurement method.
Definition BdsD.h:282
This class defines an Polynomial response table.
Definition BdsD.h:288
BFloat64 maximumError
Maximum Absolute Error.
Definition BdsD.h:299
BFloat64 frequencyLowerBound
Lower Valid Frequency Bound.
Definition BdsD.h:295
BFloat64 approximationLowerBound
Lower Bound of Approximation.
Definition BdsD.h:297
BArray< PolynomialEntry > coefficients
The Coeficients.
Definition BdsD.h:300
BString validFrequencyUnits
Valid Frequency Units.
Definition BdsD.h:294
BFloat64 approximationUpperBound
Upper Bound of Approximation.
Definition BdsD.h:298
BString approximationType
Polynomial Approximation Type.
Definition BdsD.h:293
BString transferType
Transfer Type.
Definition BdsD.h:292
BFloat64 frequencyUpperBound
Upper Valid Frequency Bound.
Definition BdsD.h:296
This class defines a seismic Response characteristic.
Definition BdsD.h:313
BUInt32 stage
The stage (0, 1, 2, 3, ...). 0 is a special overall response sometimes used.
Definition BdsD.h:324
BUInt32 id
The ID.
Definition BdsD.h:317
BString stageType
The stage type: A - Analog (rad/sec), B - Analog (Hz), C - Composite, D - Digital.
Definition BdsD.h:333
Polynomial polynomial
The polynomial response.
Definition BdsD.h:330
BFloat64 decimationOffset
Decimation sample offset.
Definition BdsD.h:335
BFloat64 gain
Overall gain at gainFrequency.
Definition BdsD.h:331
BFloat64 gainFrequency
Frequency that gain is valid for.
Definition BdsD.h:332
BArray< Fap > faps
The FAP Frequency/Amplitude/Phase table.
Definition BdsD.h:328
BFloat64 sampleRate
The stage's sample rate.
Definition BdsD.h:341
BString source
The source.
Definition BdsD.h:323
BFloat64 decimationCorr
Decimation correction performed.
Definition BdsD.h:337
Fir fir
The FIR filters coefficients.
Definition BdsD.h:329
BString channel
The channel.
Definition BdsD.h:322
BFloat64 decimation
Decimation factor performed post filter.
Definition BdsD.h:334
BString type
The type of response (PoleZero, FIR, FAP, Polynomial or blank if no frequency response)
Definition BdsD.h:326
BTimeStamp startTime
The start time when ret response is valid from.
Definition BdsD.h:318
BTimeStamp endTime
The end time the response is valid to.
Definition BdsD.h:319
BString inputUnits
The units of the data as input from the perspective of data acquisition. After correcting data for th...
Definition BdsD.h:342
BString symmetry
Symmetry for FIR coefficients (A = asymmetric, B = symmetric[odd], C = symmetric[even])
Definition BdsD.h:338
BString description
Misc description.
Definition BdsD.h:339
BString station
The station.
Definition BdsD.h:321
BString inputUnitsDesc
The input units description.
Definition BdsD.h:343
PoleZero poleZeros
The PoleZeros.
Definition BdsD.h:327
BInt32 measured
Boolean if response was a measured response.
Definition BdsD.h:340
BString outputUnits
The units of the data as output from the perspective of data acquisition. These would be the units of...
Definition BdsD.h:344
BString name
The response name. (Anti-Aliasing filter, Digitiser, post filter etc)
Definition BdsD.h:325
BString network
The Network/Organisation Name.
Definition BdsD.h:320
BString outputUnitsDesc
The output units description.
Definition BdsD.h:345
BFloat64 decimationDelay
Decimation delay in seconds.
Definition BdsD.h:336
This class defines an idividual channel for selection.
Definition BdsD.h:500
BString station
Definition BdsD.h:505
BString network
Definition BdsD.h:504
BString channel
Definition BdsD.h:506
BString source
Definition BdsD.h:507
This class defines the set of Metadata or Siesmic sensor data to be selected when getSelectionInfo() ...
Definition BdsD.h:483
BList< BString > sources
The list of Data Sources.
Definition BdsD.h:494
BList< BString > networks
The list of Network Names.
Definition BdsD.h:489
BUInt32 numDataChannels
The number of sets of data in the system matching the criteria.
Definition BdsD.h:495
BTimeStamp endTime
The End Time.
Definition BdsD.h:488
BList< BString > arraysAndStations
The list of Array and Station names.
Definition BdsD.h:492
BList< BString > stations
The list of Station names.
Definition BdsD.h:491
BList< BString > channels
The list of Channels.
Definition BdsD.h:493
BTimeStamp startTime
The Start Time.
Definition BdsD.h:487
BList< BString > arrays
The list of Array names.
Definition BdsD.h:490
This class defines a generic Metadata or Sensor data selection.
Definition BdsD.h:517
BTimeStamp endTime
The End Time.
Definition BdsD.h:524
BList< SelectionChannel > channels
The data channels to select.
Definition BdsD.h:525
BUInt32 sensorOldId
The Sensor old id.
Definition BdsD.h:529
BString excludeChannels
Comma separated wildcard list of channels to be excluded.
Definition BdsD.h:537
BTimeStamp startTime
The Start Time.
Definition BdsD.h:523
BUInt32 eventId
A particular event's ID.
Definition BdsD.h:533
BUInt32 digitiserId
The Digitiser id.
Definition BdsD.h:527
BUInt32 sensorId
The Sensor id.
Definition BdsD.h:528
BString calibrationName
Calibration name to use.
Definition BdsD.h:531
BInt32 completeSegments
Do not clip the segment times to match the required time period.
Definition BdsD.h:530
LocationSelect locationSelect
Which locations to select, those for stations, channels or all of them when used in a locationGetList...
Definition BdsD.h:535
BUInt32 id
The ID of the record to return.
Definition BdsD.h:521
ListRange range
The range of data to return.
Definition BdsD.h:522
BString name
Match the name, title or some other string in the objects to select.
Definition BdsD.h:534
BString array
Channels are based on the given array (for array offsets)
Definition BdsD.h:532
BUInt32 channelId
The Channel id.
Definition BdsD.h:526
BString dataTypes
Place holder as yet for: A comma separated list of Channel dataTypes to select when returning Channel...
Definition BdsD.h:536
This class defines a seismic Sensor.
Definition BdsD.h:411
BTimeStamp endTime
The End Time.
Definition BdsD.h:422
const char * getType() const
Definition BdsD.cc:647
BString name
The Sensors name.
Definition BdsD.h:423
BTimeStamp startTime
The Start Time.
Definition BdsD.h:421
BError setMember(BString name, BString value)
Definition BdsD.cc:696
BString gainUnits
The gain units.
Definition BdsD.h:427
BError setMembers(BDictString &members)
Definition BdsD.cc:680
BUInt32 id
The ID.
Definition BdsD.h:420
BInt32 shared
This sensor is shared.
Definition BdsD.h:430
BString serialNumber
The sensor's serial number. Only used when there is a unique physical sensor.
Definition BdsD.h:425
BFloat64 gain
The overall gain of the sensor at the manufacturers calibration frequency. (For information only)
Definition BdsD.h:428
BString type
The type of sensor. (Seismometer, Hydrophone etc)
Definition BdsD.h:424
BUInt32 oldId
The Id from the old Autodrm database.
Definition BdsD.h:429
BError getMember(BString name, BString &value)
Definition BdsD.cc:664
BUInt32 numberChannels
The number of supported channels.
Definition BdsD.h:426
This class defines a Source Priority entry.
Definition BdsD.h:140
BError getMember(BString name, BString &value)
Definition BdsD.cc:205
const char * getType() const
Definition BdsD.cc:194
BUInt32 priority
The priority order, highest first.
Definition BdsD.h:153
BTimeStamp startTime
The Start Time.
Definition BdsD.h:150
BError setMembers(BDictString &members)
Definition BdsD.cc:215
BTimeStamp endTime
The End Time the channel was available.
Definition BdsD.h:151
BUInt32 id
Unique ID when stored in a database or for other uses.
Definition BdsD.h:149
BString source
The source name.
Definition BdsD.h:152
BError setMember(BString name, BString value)
Definition BdsD.cc:225
This class defines a seismic data Source.
Definition BdsD.h:120
BError setMember(BString name, BString value)
Definition BdsD.cc:175
BUInt32 id
Unique ID when stored in a database or for other uses.
Definition BdsD.h:129
BString alias
The short alias for data files.
Definition BdsD.h:132
BString description
The description.
Definition BdsD.h:133
BString source
The sensor data's source name.
Definition BdsD.h:130
const char * getType() const
Definition BdsD.cc:144
BString sourceMeta
The associated metadata's source name.
Definition BdsD.h:131
BError getMember(BString name, BString &value)
Definition BdsD.cc:155
BError setMembers(BDictString &members)
Definition BdsD.cc:165
A Special channel identifier.
Definition BdsD.h:930
BUInt32 id
Unique ID when stored in a database or for other uses.
Definition BdsD.h:939
BString channel
The channels name, wildcards allowed (often as <channelType>_<channelAux>)
Definition BdsD.h:944
BString network
The Network Name, wildcards allowed.
Definition BdsD.h:942
BError getMember(BString name, BString &value)
Definition BdsD.cc:1662
const char * getType() const
Definition BdsD.cc:1648
BTimeStamp startTime
The Start Time.
Definition BdsD.h:940
BString station
The Stations name, wildcards allowed.
Definition BdsD.h:943
BTimeStamp endTime
The End Time the channel was available.
Definition BdsD.h:941
BString description
The channels description.
Definition BdsD.h:946
BString dataType
The Type of channel (ignore)
Definition BdsD.h:945
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:189
BString description
Description.
Definition BdsD.h:198
BString name
The name.
Definition BdsD.h:195
BString alias
Alias name to be returned to the user.
Definition BdsD.h:196
BUInt32 id
Unique ID when stored in a database or for other uses.
Definition BdsD.h:193
BString type
The Station type. Set to "array" or "station".
Definition BdsD.h:197
BList< ArrayChannel > channels
List of channels if an Array.
Definition BdsD.h:199
BString network
The Network this station belongs to if for a partricular network.
Definition BdsD.h:194
This class defines a TimePeriod.
Definition BdsD.h:70
BTimeStamp endTime
The End time to the nearest us.
Definition BdsD.h:80
BError setMembers(BDictString &members)
Definition BdsD.cc:41
BTimeStamp startTime
The Start time to the nearest us.
Definition BdsD.h:79
const char * getType() const
Definition BdsD.cc:26
BError getMember(BString name, BString &value)
Definition BdsD.cc:34
BError setMember(BString name, BString value)
Definition BdsD.cc:48
This holds information on a user.
Definition BdsD.h:735
BInt32 enabled
Whether the users account is enabled.
Definition BdsD.h:751
BString name
The User's full name.
Definition BdsD.h:747
BString address
The User's postal address.
Definition BdsD.h:750
BString user
The User ID.
Definition BdsD.h:745
BString telephone
The User's telephone number.
Definition BdsD.h:749
BError setMembers(BDictString &members)
Definition BdsD.cc:1202
BString password
The User's password.
Definition BdsD.h:746
BUInt32 id
The unique user ID.
Definition BdsD.h:744
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:748
const char * getType() const
Definition BdsD.cc:1173
BList< BString > groups
The security groups the user belongs to.
Definition BdsD.h:752
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
MetadataOption
Metadata fetch options.
Definition BdsD.h:56
@ MetadataOptionNone
Definition BdsD.h:56
@ MetadataOptionFixedChannels
Definition BdsD.h:56
@ MetadataOptionAllTime
Definition BdsD.h:56
@ MetadataOptionAllowIncomplete
Definition BdsD.h:56
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:925
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
@ DataFormatSetMetadataRead
Definition BdsD.h:50
@ DataFormatSetNone
Definition BdsD.h:50
@ DataFormatSetSensordataRead
Definition BdsD.h:50
@ DataFormatSetMetadataWrite
Definition BdsD.h:50
@ DataFormatSetSensordataWrite
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