BdsApi  3.0.12
This is the Blacknest BDS API.
Public Member Functions | Public Attributes | List of all members
Bds::Event Class Reference

This class defines a seismic event. More...

#include <BdsD.h>

Public Member Functions

 Event (BUInt32 id=0, BUInt32 userId=0, BString type=BString(), BString title=BString(), BString network=BString(), BString source=BString(), BTimeStamp startTime=BTimeStamp(), BTimeStamp endTime=BTimeStamp(), BTimeStamp eventTime=BTimeStamp(), BFloat64 longitude=0, BFloat64 latitude=0, BFloat64 elevation=0, BFloat64 waterDepth=0, BFloat64 magnitude=0, BString magnitudeUnits=BString(), BString description=BString(), BString notes=BString(), BDict< BString > extra=BDict< BString >(), BList< SelectionChannel > dataChannels=BList< SelectionChannel >())
 

Public Attributes

BUInt32 id
 Unique id defining this event within the BDS system. More...
 
BUInt32 userId
 User ID for initial creator of this event. This allows them to edit these events. More...
 
BString type
 The event type (a hierarchy of types) More...
 
BString title
 Some text describing the event. More...
 
BString network
 Unique network for this event if a project. More...
 
BString source
 Unique source for this event if a project. More...
 
BTimeStamp startTime
 The startTime of the event to the nearest microsecond. For data access. More...
 
BTimeStamp endTime
 The endTime of the event to the nearest microsecond. For data access. More...
 
BTimeStamp eventTime
 The actual time of the event to the nearest microsecond. More...
 
BFloat64 longitude
 The longitude in degrees using the WGS84 datum. More...
 
BFloat64 latitude
 The Latitude in degrees using the WGS84 datum. More...
 
BFloat64 elevation
 The ground level elevation in meters from the WGS84 ellipsoid (Sea level) More...
 
BFloat64 waterDepth
 Water depth of the event if in water. More...
 
BFloat64 magnitude
 Magnitude of the event. More...
 
BString magnitudeUnits
 Magnitude Units. More...
 
BString description
 General description of the Event/Project. More...
 
BString notes
 General notes on the Event/project. More...
 
BDict< BStringextra
 An array of name value pairs for extra metadata specific to particular events. More...
 
BList< SelectionChanneldataChannels
 List of BDS Channels of associated sensor data files if any. More...
 

Detailed Description

This class defines a seismic event.

Each event defines Metadata for a seismic event. this includes a list of all of the data channels relavent to the event.

Constructor & Destructor Documentation

◆ Event()

Bds::Event::Event ( BUInt32  id = 0,
BUInt32  userId = 0,
BString  type = BString(),
BString  title = BString(),
BString  network = BString(),
BString  source = BString(),
BTimeStamp  startTime = BTimeStamp(),
BTimeStamp  endTime = BTimeStamp(),
BTimeStamp  eventTime = BTimeStamp(),
BFloat64  longitude = 0,
BFloat64  latitude = 0,
BFloat64  elevation = 0,
BFloat64  waterDepth = 0,
BFloat64  magnitude = 0,
BString  magnitudeUnits = BString(),
BString  description = BString(),
BString  notes = BString(),
BDict< BString extra = BDict<BString >(),
BList< SelectionChannel dataChannels = BList<SelectionChannel >() 
)

Member Data Documentation

◆ dataChannels

BList<SelectionChannel > Bds::Event::dataChannels

List of BDS Channels of associated sensor data files if any.

◆ description

BString Bds::Event::description

General description of the Event/Project.

◆ elevation

BFloat64 Bds::Event::elevation

The ground level elevation in meters from the WGS84 ellipsoid (Sea level)

◆ endTime

BTimeStamp Bds::Event::endTime

The endTime of the event to the nearest microsecond. For data access.

◆ eventTime

BTimeStamp Bds::Event::eventTime

The actual time of the event to the nearest microsecond.

◆ extra

BDict<BString > Bds::Event::extra

An array of name value pairs for extra metadata specific to particular events.

◆ id

BUInt32 Bds::Event::id

Unique id defining this event within the BDS system.

◆ latitude

BFloat64 Bds::Event::latitude

The Latitude in degrees using the WGS84 datum.

◆ longitude

BFloat64 Bds::Event::longitude

The longitude in degrees using the WGS84 datum.

◆ magnitude

BFloat64 Bds::Event::magnitude

Magnitude of the event.

◆ magnitudeUnits

BString Bds::Event::magnitudeUnits

Magnitude Units.

◆ network

BString Bds::Event::network

Unique network for this event if a project.

◆ notes

BString Bds::Event::notes

General notes on the Event/project.

◆ source

BString Bds::Event::source

Unique source for this event if a project.

◆ startTime

BTimeStamp Bds::Event::startTime

The startTime of the event to the nearest microsecond. For data access.

◆ title

BString Bds::Event::title

Some text describing the event.

◆ type

BString Bds::Event::type

The event type (a hierarchy of types)

◆ userId

BUInt32 Bds::Event::userId

User ID for initial creator of this event. This allows them to edit these events.

◆ waterDepth

BFloat64 Bds::Event::waterDepth

Water depth of the event if in water.


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