BDS Public
BdsApi 4.0.1
This is the Blacknest BDS API.
Loading...
Searching...
No Matches
Bds::SpecialChannel Class Reference

A Special channel identifier. More...

#include <BdsD.h>

Inheritance diagram for Bds::SpecialChannel:
BObj

Public Member Functions

 SpecialChannel (BUInt32 id=0, BTimeStamp startTime=BTimeStamp(), BTimeStamp endTime=BTimeStamp(), BString network=BString(), BString station=BString(), BString channel=BString(), BString dataType=BString(), BString description=BString())
 
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 BObjMembergetMembers () 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
 Unique ID when stored in a database or for other uses.
 
BTimeStamp startTime
 The Start Time.
 
BTimeStamp endTime
 The End Time the channel was available.
 
BString network
 The Network Name, wildcards allowed.
 
BString station
 The Stations name, wildcards allowed.
 
BString channel
 The channels name, wildcards allowed (often as <channelType>_<channelAux>)
 
BString dataType
 The Type of channel (ignore)
 
BString description
 The channels description.
 

Detailed Description

A Special channel identifier.

This specifies a particular Channel as a special one. The Channels Network,Station and Channel are regular expresions to define one or more channels. If selected the dataType field is effectively applied to this channel. The dataType "ignore" allows Cahnnels to be ignored on export by default.

Constructor & Destructor Documentation

◆ SpecialChannel()

Bds::SpecialChannel::SpecialChannel ( BUInt32  id = 0,
BTimeStamp  startTime = BTimeStamp(),
BTimeStamp  endTime = BTimeStamp(),
BString  network = BString(),
BString  station = BString(),
BString  channel = BString(),
BString  dataType = BString(),
BString  description = BString() 
)

Member Function Documentation

◆ getType()

const char * Bds::SpecialChannel::getType ( ) const
virtual

Reimplemented from BObj.

◆ setMembers()

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

Reimplemented from BObj.

◆ setMember()

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

Reimplemented from BObj.

◆ getMembers()

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

Reimplemented from BObj.

◆ getMember()

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

Reimplemented from BObj.

Member Data Documentation

◆ id

BUInt32 Bds::SpecialChannel::id

Unique ID when stored in a database or for other uses.

◆ startTime

BTimeStamp Bds::SpecialChannel::startTime

The Start Time.

◆ endTime

BTimeStamp Bds::SpecialChannel::endTime

The End Time the channel was available.

◆ network

BString Bds::SpecialChannel::network

The Network Name, wildcards allowed.

◆ station

BString Bds::SpecialChannel::station

The Stations name, wildcards allowed.

◆ channel

BString Bds::SpecialChannel::channel

The channels name, wildcards allowed (often as <channelType>_<channelAux>)

◆ dataType

BString Bds::SpecialChannel::dataType

The Type of channel (ignore)

◆ description

BString Bds::SpecialChannel::description

The channels description.


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