Bds::Location Class Reference

This class defines the physical location of a Station. More...

#include <BdsD.h>

Inheritance diagram for Bds::Location:

Public Member Functions
	Location (BUInt32 id=0, BTimeStamp startTime=BTimeStamp(), BTimeStamp endTime=BTimeStamp(), BString network=BString(), BString station=BString(), BString channel=BString(), BString datum=BString(), BFloat64 longitude=0, BFloat64 latitude=0, BFloat64 elevation=0, BFloat64 arrayOffsetEast=0, BFloat64 arrayOffsetNorth=0)
const char *	getType () const
BError	setMembers (BDictString &members)
BError	setMember (BString name, BString value)
BError	getMembers (BDictString &members)
BError	getMember (BString name, BString &value)
Public Member Functions inherited from BObj
	BObj ()
virtual	~BObj ()
virtual const char *	getType () const
virtual const BObjMember *	getMembers () const
virtual BError	getMembers (BDictString &members)
virtual BError	getMember (BString name, BString &value)
virtual BError	setMembers (BDictString &members)
virtual BError	setMember (BString name, BString value)
virtual void	membersPrint () const
virtual BString	getDebugString ()

Public Attributes
BUInt32	id
	The ID.
BTimeStamp	startTime
	The Start Time.
BTimeStamp	endTime
	The End Time the channel was available.
BString	network
	The Network/Organisation Name.
BString	station
	The station this location is for.
BString	channel
	The channel this location is for. If blank the location is for the Station itself.
BString	datum
	The locations Datum.
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 (Sea level)
BFloat64	arrayOffsetEast
	The read=only Array offset in an array in an easterly direction if array known/given. Note returns the Array's ArrayChannel offset information.
BFloat64	arrayOffsetNorth
	The read=only Array offset in an array in a northerly direction if array known/given. Note returns the Array's ArrayChannel offset information.

Detailed Description

This class defines the physical location of a Station.

This defines the physical location of the station using WGS84 longitude and latitude parameters. It also defines the stations elevation. If it is part of an array the arrayOffsetEast and arrayOffsetNorth will be filled in from the Array's ArrayChannel offset information. So although arrayOffsetEast and arrayOffsetNorth are part of a Location object they are not stored in the database StationLocations table.

Constructor & Destructor Documentation

Location()

Bds::Location::Location	(	BUInt32	id = 0,
		BTimeStamp	startTime = BTimeStamp(),
		BTimeStamp	endTime = BTimeStamp(),
		BString	network = BString(),
		BString	station = BString(),
		BString	channel = BString(),
		BString	datum = BString(),
		BFloat64	longitude = 0,
		BFloat64	latitude = 0,
		BFloat64	elevation = 0,
		BFloat64	arrayOffsetEast = 0,
		BFloat64	arrayOffsetNorth = 0
	)

Member Function Documentation

getType()

const char * Bds::Location::getType ( ) const

virtual

Reimplemented from BObj.

setMembers()

BError Bds::Location::setMembers ( BDictString &  members )

virtual

Reimplemented from BObj.

setMember()

BError Bds::Location::setMember ( BString  name, BString  value  )

virtual

Reimplemented from BObj.

getMembers()

BError Bds::Location::getMembers ( BDictString &  members )

virtual

Reimplemented from BObj.

getMember()

BError Bds::Location::getMember ( BString  name, BString &  value  )

virtual

Reimplemented from BObj.

Member Data Documentation

id

BUInt32 Bds::Location::id

The ID.

startTime

BTimeStamp Bds::Location::startTime

The Start Time.

endTime

BTimeStamp Bds::Location::endTime

The End Time the channel was available.

network

BString Bds::Location::network

The Network/Organisation Name.

station

BString Bds::Location::station

The station this location is for.

channel

BString Bds::Location::channel

The channel this location is for. If blank the location is for the Station itself.

datum

BString Bds::Location::datum

The locations Datum.

longitude

BFloat64 Bds::Location::longitude

The longitude in degrees using the WGS84 datum.

latitude

BFloat64 Bds::Location::latitude

The Latitude in degrees using the WGS84 datum.

elevation

BFloat64 Bds::Location::elevation

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

arrayOffsetEast

BFloat64 Bds::Location::arrayOffsetEast

The read=only Array offset in an array in an easterly direction if array known/given. Note returns the Array's ArrayChannel offset information.

arrayOffsetNorth

BFloat64 Bds::Location::arrayOffsetNorth

The read=only Array offset in an array in a northerly direction if array known/given. Note returns the Array's ArrayChannel offset information.

---

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

• BdsD.h
• BdsD.cc