BdsApi 3.1.4
This is the Blacknest BDS API.
|
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< BString > | extra |
An array of name value pairs for extra metadata specific to particular events. More... | |
BList< SelectionChannel > | dataChannels |
List of BDS Channels of associated sensor data files if any. More... | |
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. Given this information the BDS is able, given an Event title, to export all of the Metadata and Sensor data relevent to this 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 >() |
||
) |
BUInt32 Bds::Event::id |
Unique id defining this event within the BDS system.
BUInt32 Bds::Event::userId |
User ID for initial creator of this event. This allows them to edit these events.
BString Bds::Event::type |
The event type (a hierarchy of types)
BString Bds::Event::title |
Some text describing the event.
BString Bds::Event::network |
Unique network for this event if a project.
BString Bds::Event::source |
Unique source for this event if a project.
BTimeStamp Bds::Event::startTime |
The startTime of the event to the nearest microsecond. For data access.
BTimeStamp Bds::Event::endTime |
The endTime of the event to the nearest microsecond. For data access.
BTimeStamp Bds::Event::eventTime |
The actual time of the event to the nearest microsecond.
BFloat64 Bds::Event::longitude |
The longitude in degrees using the WGS84 datum.
BFloat64 Bds::Event::latitude |
The Latitude in degrees using the WGS84 datum.
BFloat64 Bds::Event::elevation |
The ground level elevation in meters from the WGS84 ellipsoid (Sea level)
BFloat64 Bds::Event::waterDepth |
Water depth of the event if in water.
BFloat64 Bds::Event::magnitude |
Magnitude of the event.
BString Bds::Event::magnitudeUnits |
Magnitude Units.
BString Bds::Event::description |
General description of the Event/Project.
BString Bds::Event::notes |
General notes on the Event/project.
An array of name value pairs for extra metadata specific to particular events.
BList<SelectionChannel > Bds::Event::dataChannels |
List of BDS Channels of associated sensor data files if any.