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

This class defines the offsets of station:channels relative to an arrays centre. More...

#include <BdsD.h>

Inheritance diagram for Bds::ArrayOffset:
BObj

Public Member Functions

 ArrayOffset (BUInt32 id=0, BTimeStamp startTime=BTimeStamp(), BTimeStamp endTime=BTimeStamp(), BString network=BString(), BString array=BString(), BString station=BString(), BString channel=BString(), BFloat64 arrayOffsetEast=0, BFloat64 arrayOffsetNorth=0)
 
BString getType ()
 
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 BObjMembergetMembers () const
 
virtual void membersPrint () const
 
virtual BString getDebugString ()
 

Public Attributes

BUInt32 id
 The ID. More...
 
BTimeStamp startTime
 The Start Time. More...
 
BTimeStamp endTime
 The End Time the channel was available. More...
 
BString network
 The Network/Organisation Name. More...
 
BString array
 The array this offset is for. More...
 
BString station
 The station this offset is for. More...
 
BString channel
 The channel this offset is for. If blank the offset is for the Station itself. More...
 
BFloat64 arrayOffsetEast
 The Array offset in in an array in an easterly direction in metres. More...
 
BFloat64 arrayOffsetNorth
 The Array offset in in an array in a northerly direction in metres. More...
 

Detailed Description

This class defines the offsets of station:channels relative to an arrays centre.

This defines defines the offsets of station:channels relative to an arrays centre.

Constructor & Destructor Documentation

◆ ArrayOffset()

Bds::ArrayOffset::ArrayOffset ( BUInt32  id = 0,
BTimeStamp  startTime = BTimeStamp(),
BTimeStamp  endTime = BTimeStamp(),
BString  network = BString(),
BString  array = BString(),
BString  station = BString(),
BString  channel = BString(),
BFloat64  arrayOffsetEast = 0,
BFloat64  arrayOffsetNorth = 0 
)

Member Function Documentation

◆ getMember()

BError Bds::ArrayOffset::getMember ( BString  name,
BString value 
)
virtual

Reimplemented from BObj.

◆ getMembers()

BError Bds::ArrayOffset::getMembers ( BDictString members)
virtual

Reimplemented from BObj.

◆ getType()

BString Bds::ArrayOffset::getType ( )

◆ setMember()

BError Bds::ArrayOffset::setMember ( BString  name,
BString  value 
)
virtual

Reimplemented from BObj.

◆ setMembers()

BError Bds::ArrayOffset::setMembers ( BDictString members)
virtual

Reimplemented from BObj.

Member Data Documentation

◆ array

BString Bds::ArrayOffset::array

The array this offset is for.

◆ arrayOffsetEast

BFloat64 Bds::ArrayOffset::arrayOffsetEast

The Array offset in in an array in an easterly direction in metres.

◆ arrayOffsetNorth

BFloat64 Bds::ArrayOffset::arrayOffsetNorth

The Array offset in in an array in a northerly direction in metres.

◆ channel

BString Bds::ArrayOffset::channel

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

◆ endTime

BTimeStamp Bds::ArrayOffset::endTime

The End Time the channel was available.

◆ id

BUInt32 Bds::ArrayOffset::id

The ID.

◆ network

BString Bds::ArrayOffset::network

The Network/Organisation Name.

◆ startTime

BTimeStamp Bds::ArrayOffset::startTime

The Start Time.

◆ station

BString Bds::ArrayOffset::station

The station this offset is for.


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