BdsApi  2.2.6
This is the Blacknest BDS API.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
Bds::DataFileSeed Class Reference

Data file convertor for SEED file formats. More...

#include <BdsDataFileSeed.h>

Inheritance diagram for Bds::DataFileSeed:
Bds::DataFile

Public Member Functions

 DataFileSeed ()
 
 ~DataFileSeed ()
 
BError close ()
 Close the file. More...
 
DataOrder getDataOrder ()
 Get the expected order of writing data, by sample or by channel. More...
 
int getFeatures ()
 Get bitmask of supported features. More...
 
BError setFormat (BString format)
 Set the sub-format. 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...
 
BError getMetaData (ChannelInfos &channelInfos, BUInt32 options, BList< DataError > &errors)
 Return all known MetaData in the file. More...
 
BError setInfo (const DataInfo &dataInfo, const ChannelInfos &channelInfos, WriteOptionsList options=WriteOptionSensorData)
 Set information on data for write. More...
 
BError start (BUInt channel, BUInt segment)
 Start writing next segment of data. More...
 
BError writeData (const DataBlock &data)
 Write a block of data. More...
 
BError end ()
 End write segment. More...
 
void msrFileWrite (void *data, int len)
 
- 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 BString getFileName ()
 Return the file name. 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...
 
void dataErrorFixup (const 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 (const DataBlock &data1, const 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...
 

Static Public Attributes

static BError omsrErr
 MSR processing error. More...
 
static int onoLock
 Disable libmseed locking. More...
 

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
 

Detailed Description

Data file convertor for SEED file formats.

Constructor & Destructor Documentation

Bds::DataFileSeed::DataFileSeed ( )
Bds::DataFileSeed::~DataFileSeed ( )

Member Function Documentation

BError Bds::DataFileSeed::close ( )
virtual

Close the file.

Reimplemented from Bds::DataFile.

BError Bds::DataFileSeed::end ( )
virtual

End write segment.

Reimplemented from Bds::DataFile.

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

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

Reimplemented from Bds::DataFile.

int Bds::DataFileSeed::getFeatures ( )
virtual

Get bitmask of supported features.

Reimplemented from Bds::DataFile.

DataFormat Bds::DataFileSeed::getFormats ( )
static
BError Bds::DataFileSeed::getInfo ( DataInfo dataInfo,
DataFileOptions  options,
BList< DataError > &  errors 
)
virtual

Get info on data.

Reimplemented from Bds::DataFile.

BError Bds::DataFileSeed::getMetaData ( ChannelInfos channelInfos,
BUInt32  options,
BList< DataError > &  errors 
)
virtual

Return all known MetaData in the file.

Reimplemented from Bds::DataFile.

void Bds::DataFileSeed::msrFileWrite ( void *  data,
int  len 
)
BError Bds::DataFileSeed::readData ( BUInt32  channel,
BUInt  segment,
BUInt32  blockNumber,
DataBlock dataBlock 
)
virtual

Read a block.

Reimplemented from Bds::DataFile.

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

Set the sub-format.

Reimplemented from Bds::DataFile.

BError Bds::DataFileSeed::setInfo ( const DataInfo dataInfo,
const ChannelInfos channelInfos,
WriteOptionsList  options = WriteOptionSensorData 
)
virtual

Set information on data for write.

Reimplemented from Bds::DataFile.

BError Bds::DataFileSeed::start ( BUInt  channel,
BUInt  segment 
)
virtual

Start writing next segment of data.

Reimplemented from Bds::DataFile.

BError Bds::DataFileSeed::writeData ( const DataBlock data)
virtual

Write a block of data.

Reimplemented from Bds::DataFile.

Member Data Documentation

BError Bds::DataFileSeed::omsrErr
static

MSR processing error.

int Bds::DataFileSeed::onoLock
static

Disable libmseed locking.

Disable libmseed lock, for sequential programs.


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