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 eventDepth=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.
BUInt32	userId
	User ID for initial creator of this event. This allows them to edit these events.
BString	type
	The event type (a hierarchy of types)
BString	title
	Some text describing the event.
BString	network
	Unique network for this event if a project.
BString	source
	Unique source for this event if a project.
BTimeStamp	startTime
	The startTime of the event to the nearest microsecond. For data access.
BTimeStamp	endTime
	The endTime of the event to the nearest microsecond. For data access.
BTimeStamp	eventTime
	The actual time of the event to the nearest microsecond.
BFloat64	longitude
	The longitude in degrees using the WGS84 datum.
BFloat64	latitude
	The Latitude in degrees using the WGS84 datum.
BFloat64	elevation
	The ground level elevation in meters from the WGS84 ellipsoid (or sea level)
BFloat64	waterDepth
	Water depth in meters of the event if in water.
BFloat64	eventDepth
	The events depth in meters below the local elevation using WGS84 (negative if above ground/water surface)
BFloat64	magnitude
	Magnitude of the event.
BString	magnitudeUnits
	Magnitude Units.
BString	description
	General description of the Event/Project.
BString	notes
	General notes on the Event/project.
BDict< BString >	extra
	An array of name value pairs for extra metadata specific to particular events.
BList< SelectionChannel >	dataChannels
	List of BDS Channels of associated sensor data files if any.

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. Given this information the BDS is able, given an Event title, to export all of the Metadata and Sensor data relevent to this 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	eventDepth = 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

id

BUInt32 Bds::Event::id

Unique id defining this event within the BDS system.

userId

BUInt32 Bds::Event::userId

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

type

BString Bds::Event::type

The event type (a hierarchy of types)

title

BString Bds::Event::title

Some text describing the event.

network

BString Bds::Event::network

Unique network for this event if a 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.

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.

longitude

BFloat64 Bds::Event::longitude

The longitude in degrees using the WGS84 datum.

latitude

BFloat64 Bds::Event::latitude

The Latitude in degrees using the WGS84 datum.

elevation

BFloat64 Bds::Event::elevation

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

waterDepth

BFloat64 Bds::Event::waterDepth

Water depth in meters of the event if in water.

eventDepth

BFloat64 Bds::Event::eventDepth

The events depth in meters below the local elevation using WGS84 (negative if above ground/water surface)

magnitude

BFloat64 Bds::Event::magnitude

Magnitude of the event.

magnitudeUnits

BString Bds::Event::magnitudeUnits

Magnitude Units.

description

BString Bds::Event::description

General description of the Event/Project.

notes

BString Bds::Event::notes

General notes on the Event/project.

extra

BDict<BString > Bds::Event::extra

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

dataChannels

BList<SelectionChannel > Bds::Event::dataChannels

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

---

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

• BdsD.h
• BdsD.cc