BdsApi  2.2.6
This is the Blacknest BDS API.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Public Member Functions | Public Attributes | List of all members
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 comment=BString(), BUInt32 importUserId=0, BTimeStamp importTime=BTimeStamp(), BString state=BString())
 
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
 Unique ID when stored in a database or for other uses. More...
 
BTimeStamp startTime
 The Start Time. More...
 
BTimeStamp endTime
 The End Time. More...
 
BString location
 The storage location. More...
 
BString format
 The data format. More...
 
BString url
 The URL for file access. More...
 
BString comment
 A comment on the file. More...
 
BUInt32 importUserId
 The user ID of the importing user. More...
 
BTimeStamp importTime
 The Time the data was imported. More...
 
BString state
 Status info on the import (importing, realtime, failed, ok etc) More...
 

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.

Constructor & Destructor Documentation

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

Member Function Documentation

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

Reimplemented from BObj.

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

Reimplemented from BObj.

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

Reimplemented from BObj.

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

Reimplemented from BObj.

Member Data Documentation

BString Bds::DataFileInfo::comment

A comment on the file.

BTimeStamp Bds::DataFileInfo::endTime

The End Time.

BString Bds::DataFileInfo::format

The data format.

BUInt32 Bds::DataFileInfo::id

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

BTimeStamp Bds::DataFileInfo::importTime

The Time the data was imported.

BUInt32 Bds::DataFileInfo::importUserId

The user ID of the importing user.

BString Bds::DataFileInfo::location

The storage location.

BTimeStamp Bds::DataFileInfo::startTime

The Start Time.

BString Bds::DataFileInfo::state

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

BString Bds::DataFileInfo::url

The URL for file access.


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