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

This class defines information on a Sensor data file. More...

#include <BdsD.h>

Inheritance diagram for Bds::DataFileInfo:
BObj

Public Member Functions

 DataFileInfo (BUInt32 id=0, BTimeStamp startTime=BTimeStamp(), BTimeStamp endTime=BTimeStamp(), BString location=BString(), BString format=BString(), BString url=BString(), BString stream=BString(), BString comment=BString(), BUInt32 importUserId=0, BTimeStamp importTime=BTimeStamp(), BString state=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.
 
BString location
 The storage location.
 
BString format
 The data format.
 
BString url
 The URL for file access.
 
BString stream
 The real-time data stream.
 
BString comment
 A comment on the file.
 
BUInt32 importUserId
 The user ID of the importing user.
 
BTimeStamp importTime
 The Time the data was imported.
 
BString state
 Status info on the import (importing, realtime, failed, ok etc)
 

Detailed Description

This class defines information on a Sensor data file.

The raw sensor data for a seismic channel is stored in files in the BDS system. This class defines the database entry that describes this file, its storage location and status. A single file can store one or more channels of seismic data in different formats although noramlly the BDS data file format is used.

Constructor & Destructor Documentation

◆ DataFileInfo()

Bds::DataFileInfo::DataFileInfo ( BUInt32  id = 0,
BTimeStamp  startTime = BTimeStamp(),
BTimeStamp  endTime = BTimeStamp(),
BString  location = BString(),
BString  format = BString(),
BString  url = BString(),
BString  stream = BString(),
BString  comment = BString(),
BUInt32  importUserId = 0,
BTimeStamp  importTime = BTimeStamp(),
BString  state = BString() 
)

Member Function Documentation

◆ getType()

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

Reimplemented from BObj.

◆ setMembers()

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

Reimplemented from BObj.

◆ setMember()

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

Reimplemented from BObj.

◆ getMembers()

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

Reimplemented from BObj.

◆ getMember()

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

Reimplemented from BObj.

Member Data Documentation

◆ id

BUInt32 Bds::DataFileInfo::id

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

◆ startTime

BTimeStamp Bds::DataFileInfo::startTime

The Start Time.

◆ endTime

BTimeStamp Bds::DataFileInfo::endTime

The End Time.

◆ location

BString Bds::DataFileInfo::location

The storage location.

◆ format

BString Bds::DataFileInfo::format

The data format.

◆ url

BString Bds::DataFileInfo::url

The URL for file access.

◆ stream

BString Bds::DataFileInfo::stream

The real-time data stream.

◆ comment

BString Bds::DataFileInfo::comment

A comment on the file.

◆ importUserId

BUInt32 Bds::DataFileInfo::importUserId

The user ID of the importing user.

◆ importTime

BTimeStamp Bds::DataFileInfo::importTime

The Time the data was imported.

◆ state

BString Bds::DataFileInfo::state

Status info on the import (importing, realtime, failed, ok etc)


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