BdsApi  2.0.11
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
Bds::DataFileWra Class Reference

#include <BdsDataFileWra.h>

Inheritance diagram for Bds::DataFileWra:
Bds::DataFile

Public Member Functions

 DataFileWra ()
 
BError setFormat (BString format)
 Set the sub-format. More...
 
int getFeatures ()
 Get bitmask of supported features. More...
 
DataOrder getDataOrder ()
 Get the expected order of writing data, by sample or by channel. More...
 
BError getInfo (DataInfo &dataInfo, DataFileOptions options, BList< DataError > &errors)
 Get info on data. More...
 
BError readData (BUInt32 channel, BUInt segment, BUInt32 blockNumber, DataBlock &data)
 Read a block. More...
 
- Public Member Functions inherited from Bds::DataFile
 DataFile ()
 
virtual ~DataFile ()
 
virtual void init ()
 Initialise. More...
 
virtual BError open (BString fileName, BString mode)
 Open the file for read or write. More...
 
virtual BError close ()
 Close the file. More...
 
virtual BString getFileName ()
 Return the file name. More...
 
virtual BError setInfo (const DataInfo &dataInfo, const ChannelInfos &channelInfos, WriteOptionsList options=WriteOptionNone)
 Set information on data for write. More...
 
virtual BError start (BUInt channel, BUInt segment)
 Start next segment of data. More...
 
virtual BError writeData (const DataBlock &data)
 Write a block of data. More...
 
virtual BError end ()
 End segment. More...
 
virtual BError flush ()
 Flush data to disk. More...
 
virtual BError fileNameProcess ()
 Parse the file name for a date/time. More...
 
virtual BError getFormat (BString &format)
 Get sub-format. More...
 
virtual BError seekBlock (BUInt32 channel, BUInt segment, BTimeStamp time, BUInt32 &blockNumber, BUInt64 &sampleNumber, DataBlock &data)
 Find requested block on given channel given a time. More...
 
virtual BError getMetaData (ChannelInfos &channelInfos)
 Return all known MetaData in the file. More...
 
void dataErrorFixup (DataInfo &dataInfo, BList< DataError > &errors)
 Fixup data errors, mainly start/end times to be within data. More...
 
BInt64 timeCompare (BTimeStamp t1, BTimeStamp t2, BUInt diff)
 Compare timestamps with a margin. More...
 
int duplicateCheck (DataBlock &data1, DataBlock &data2, BUInt channel=0)
 Check if blocks are duplicates. More...
 
BUInt64 getFilePosition ()
 

Static Public Member Functions

static DataFormat getFormats ()
 
- Static Public Member Functions inherited from Bds::DataFile
static DataFormat getFormats ()
 Get list of supported formats. More...
 

Private Member Functions

BError readBlock (BUInt32 channel, BUInt64 pos, DataBlock &data)
 

Private Attributes

int omagic
 
int oyear
 
int oblockYear
 
BUInt32 oblockSize
 
BUInt32 onumChannels
 
double osampleRate
 
DataInfo odataInfo
 
BArray< BUInt64 > oblockPositions
 

Additional Inherited Members

- Public Types inherited from Bds::DataFile
enum  DataOrder { DataOrderUnknown, DataOrderAll, DataOrderSample, DataOrderChannel }
 
enum  Features { FeatureNone = 0x00, FeatureCanWrite = 0x01, FeatureCanRead = 0x02 }
 
enum  WriteOptionsList { WriteOptionNone = 0x00, WriteOptionSensorData = 0x01, WriteOptionNoMetadata = 0x02 }
 
enum  ReadOptionsList {
  ReadOptionNone = 0x00, ReadOptionValidate = 0x01, ReadOptionFileNameProcess = 0x02, ReadOptionValidateCorruptions = 0x04,
  ReadOptionReorder = 0x08, ReadOptionDeleteDuplicates = 0x10, ReadOptionInfoExtra = 0x20, ReadOptionIgnoreSamplerate = 0x40,
  ReadOptionPrintBlocks = 0x80
}
 
- Protected Attributes inherited from Bds::DataFile
BString ofileName
 
BString omode
 
BTimeStamp ofileNameTime
 
BFile ofile
 
BString oformat
 

Constructor & Destructor Documentation

◆ DataFileWra()

Bds::DataFileWra::DataFileWra ( )

Member Function Documentation

◆ getDataOrder()

DataFile::DataOrder Bds::DataFileWra::getDataOrder ( )
virtual

Get the expected order of writing data, by sample or by channel.

Reimplemented from Bds::DataFile.

◆ getFeatures()

int Bds::DataFileWra::getFeatures ( )
virtual

Get bitmask of supported features.

Reimplemented from Bds::DataFile.

◆ getFormats()

DataFormat Bds::DataFileWra::getFormats ( )
static

◆ getInfo()

BError Bds::DataFileWra::getInfo ( DataInfo dataInfo,
DataFileOptions  options,
BList< DataError > &  errors 
)
virtual

Get info on data.

Reimplemented from Bds::DataFile.

◆ readBlock()

BError Bds::DataFileWra::readBlock ( BUInt32  channel,
BUInt64  pos,
DataBlock data 
)
private

◆ readData()

BError Bds::DataFileWra::readData ( BUInt32  channel,
BUInt  segment,
BUInt32  blockNumber,
DataBlock dataBlock 
)
virtual

Read a block.

Reimplemented from Bds::DataFile.

◆ setFormat()

BError Bds::DataFileWra::setFormat ( BString  format)
virtual

Set the sub-format.

Reimplemented from Bds::DataFile.

Member Data Documentation

◆ oblockPositions

BArray<BUInt64> Bds::DataFileWra::oblockPositions
private

◆ oblockSize

BUInt32 Bds::DataFileWra::oblockSize
private

◆ oblockYear

int Bds::DataFileWra::oblockYear
private

◆ odataInfo

DataInfo Bds::DataFileWra::odataInfo
private

◆ omagic

int Bds::DataFileWra::omagic
private

◆ onumChannels

BUInt32 Bds::DataFileWra::onumChannels
private

◆ osampleRate

double Bds::DataFileWra::osampleRate
private

◆ oyear

int Bds::DataFileWra::oyear
private

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