BdsLib.h

Go to the documentation of this file.

/*******************************************************************************
 *  BdsLib.h    Data File Access
 *          T.Barnaby,  BEAM Ltd,   2008-12-03
 *******************************************************************************
 */
#ifndef BdsLib_H
#define BdsLib_H
 
#include <BdsD.h>
#include <BdsC.h>
#include <BString.h>
 
namespace Bds {
 
const int   NetworkNameLen = 3;     
const int   StationNameLen = 5;     
const int   ChannelTypeLen = 3;     
const int   ChannelAuxLen = 2;      
const int   SourceLen = 16;         
 
class ResponseObj : public Response {
public:
            ResponseObj(const Response& response);
            ~ResponseObj();
    
    BString     getString();
    void        setString(BString str);
};
 
class DataError {
public:
            DataError();
            DataError(int errorNumber, BString title, BString filename, BTimeStamp startTime, BTimeStamp endTime, DataInfo& dataInfo, BUInt channel, BString description, BString user = "");
    DataError&  set(int errorNumber, BString title, BString importFilename, BTimeStamp startTime, BTimeStamp endTime, DataInfo& dataInfo, BUInt channel, BString description, BString user = "");
    void        mergeDataInfo(const DataInfo& dataInfo, BUInt channel);
 
    int     getErrorNumber() const;             
    BString     getTitle() const;               
 
    BError      setString(BString str);             
    BError      setStringUser(BString str, BString user);   
    BString     getString() const;              
 
    int     num() const;                    
    const char* str() const;                    
    
            operator int() const;               
 
public:
    BInt32          oerrorNumber;       
    BString         otitle;         
    BString         odescription;       
    BString         ofilename;      
    BTimeStamp      ostartTime;     
    BTimeStamp      oendTime;       
    BString         onetwork;       
    BString         ostation;       
    BString         ochannel;       
    BString         osource;        
    BString         ouser;          
};
 
 
BError bdsLibInit(DataAccess& bds);                     
BError bdsLibInit(DataAddAccess& bds);                      
BError bdsLibInit(AdminAccess& bds);                        
 
// Bds Channel name manipulations
void    bdsChannelGetTypeAux(BString name, BString& type, BString& aux);    
BString bdsChannelGetName(BString type, BString aux);               
 
// Bds Data Meta data manipulations
BError  bdsDataInfoSetTimeRange(DataInfo& dataInfo);                    
BError  bdsDataInfoFromInfo(BDictString info, DataInfo& dataInfo, Bool append = 0); 
BError  bdsInfoFromDataInfo(const DataInfo& dataInfo, BDictString& info);       
BError  bdsDataInfoFlatten(DataInfo& dataInfo);                     
BError  bdsDataInfoMergeFlatten(DataInfo& dataInfo, const DataInfo& dataInfoAdd);   
BString bdsUnitsConvert(BString units);                         
BError  bdsDataInfoFromChannelInfos(const ChannelInfos& channelInfos, DataInfo& dataInfo);  
 
BError  bdsMetadataImportFix(ChannelInfos& channelInfos, BString& changedMessage, Bool stageRenumber);          
BError  bdsMetadataExportFix(ChannelInfos& channelInfos, BString& changedMessage, Bool singleResponse, Bool stageRenumber, Bool changeUnits, Bool stageGains, Bool decimation, Bool toDisplacement, Bool toNm); 
 
BString bdsStationAlias(Station station);                           
BString bdsDataChannelInfo(const DataChannel& dataChannel);                 
BString bdsDataChannelRef(const DataChannel& dataChannel);                  
BString bdsDataChannelRef(const ChannelInfo& channelInfo);                  
BError  bdsDataChannelOverallResponse(const ChannelInfo& channelInfo, Response& response);  
BString bdsSelectionChannelInfo(const Selection& selection, BUInt channel);         
BString bdsFileNameExpand(BString fileName, ChannelInfo& channelInfo);              
BString bdsFileNameExpand(BString fileName, ChannelInfos& channelInfos);            
BString bdsFileNameExpand(BString fileName, Selection& sel);                    
 
// BDS Metadata higher level functionality
void bdsSpecialChannelsSet(const BList<SpecialChannel> specialChannels);            
BList<SpecialChannel> bdsSpecialChannels();                         
Bool bdsSpecialChannelIgnore(BString network, BString station, BString channel);        
char    seedChannelInstrumentCode(BString dataType);                        
BString seedChannelDataType(BString channel);                           
BStringList bdsDataTypes();                                 
BStringList bdsUnits();                                     
BString bdsUnitCase(BString unit);                              
 
// Calculations
double  bdsPoleZeroGain(const PoleZero& poleZero, double frequency);        
void    bdsPoleZeroGainPhase(const PoleZero& poleZero, double frequency, double& gain, double& phase);  
void    bdsPoleZeroToFap(const PoleZero& poleZero, BUInt nPoints, double calibrationFrequency, double sampleFrequency, BArray<Fap>& fap);   
 
// Bds Debug functions
void    bdsDumpSelection(Selection sel);                
void    bdsDumpSelectionInfo(SelectionInfo sel);            
void    bdsDumpDataInfo(DataInfo dataInfo, int includeInfo = 0);    
void    bdsDumpChannelInfos(const ChannelInfos& channelInfos);      
void    bdsDumpData(const DataBlock& dataBlock, int nSamples = 0);  
void    bdsDumpPoleZeros(PoleZero poleZeros);               
void    bdsDumpLocation(Location location);             
 
}
#endif