Skip to content

Midas C++ API - MVOdb

This page contains the full API reference for MVOdb, the C++ interface for reading and writing ODB values (mvodb.h). The same interface can also read ODB contents saved in XML or JSON files.

For the concepts and day-to-day use, see ODB: overview.

For explanations and examples of using the ODB from code, see ODB: programming.

mvodb/mvodb.h

Classes

MVOdb

Defined in mvodb/mvodb.h:20

Methods
Chdir virtualpure virtual 
virtual MVOdb*Chdir(const char* subdirname, bool create = false, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:35

Delete virtualpure virtual 
virtual void Delete(const char* odbname, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:173

GetPrintError virtualconstpure virtual 
virtual bool GetPrintError() const = 0

Defined in mvodb/mvodb.h:177

IsReadOnly virtualconstpure virtual 
virtual bool IsReadOnly() const = 0

check if this ODB interface allows writing

Defined in mvodb/mvodb.h:27

RB virtualpure virtual 
virtual void RB(const char* varname, bool *value, bool create = false, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:63

RBA virtualpure virtual 
virtual void RBA(const char* varname, std::vector<bool> *value, bool create = false, size_t create_size = 0, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:97

RBAI virtualpure virtual 
virtual void RBAI(const char* varname, int index, bool *value, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:120

RD virtualpure virtual 
virtual void RD(const char* varname, double *value, bool create = false, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:65

RDA virtualpure virtual 
virtual void RDA(const char* varname, std::vector<double> *value, bool create = false, size_t create_size = 0, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:99

RDAI virtualpure virtual 
virtual void RDAI(const char* varname, int index, double *value, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:122

ReadDir virtualpure virtual 
virtual void ReadDir(std::vector<std::string>* varname, std::vector<int> *tid, std::vector<int> *num_values, std::vector<int> *total_size, std::vector<int> *item_size, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:46

ReadKey virtualpure virtual 
virtual void ReadKey(const char* varname, int *tid, int *num_values, int *total_size, int *item_size, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:39

ReadKeyLastWritten virtualpure virtual 
virtual void ReadKeyLastWritten(const char* varname, int *last_written, MVOdbError* error = NULL) = 0

read last time a key was written

Defined in mvodb/mvodb.h:42

RF virtualpure virtual 
virtual void RF(const char* varname, float *value, bool create = false, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:66

RFA virtualpure virtual 
virtual void RFA(const char* varname, std::vector<float> *value, bool create = false, size_t create_size = 0, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:100

RFAI virtualpure virtual 
virtual void RFAI(const char* varname, int index, float *value, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:123

RI virtualpure virtual 
virtual void RI(const char* varname, int *value, bool create = false, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:64

RIA virtualpure virtual 
virtual void RIA(const char* varname, std::vector<int> *value, bool create = false, size_t create_size = 0, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:98

RIAI virtualpure virtual 
virtual void RIAI(const char* varname, int index, int *value, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:121

RS virtualpure virtual 
virtual void RS(const char* varname, std::string *value, bool create = false, size_t create_string_length = 0, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:67

RSA virtualpure virtual 
virtual void RSA(const char* varname, std::vector<std::string> *value, bool create = false, size_t create_size = 0, size_t create_string_length = 0, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:101

RSAI virtualpure virtual 
virtual void RSAI(const char* varname, int index, std::string *value, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:124

RU16 virtualpure virtual 
virtual void RU16(const char* varname, uint16_t *value, bool create = false, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:68

RU16A virtualpure virtual 
virtual void RU16A(const char* varname, std::vector<uint16_t> *value, bool create = false, size_t create_size = 0, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:102

RU16AI virtualpure virtual 
virtual void RU16AI(const char* varname, int index, uint16_t *value, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:125

RU32 virtualpure virtual 
virtual void RU32(const char* varname, uint32_t *value, bool create = false, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:69

RU32A virtualpure virtual 
virtual void RU32A(const char* varname, std::vector<uint32_t> *value, bool create = false, size_t create_size = 0, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:103

RU32AI virtualpure virtual 
virtual void RU32AI(const char* varname, int index, uint32_t *value, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:126

RU64 virtualpure virtual 
virtual void RU64(const char* varname, uint64_t *value, bool create = false, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:70

RU64A virtualpure virtual 
virtual void RU64A(const char* varname, std::vector<uint64_t> *value, bool create = false, size_t create_size = 0, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:104

RU64AI virtualpure virtual 
virtual void RU64AI(const char* varname, int index, uint64_t *value, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:127

SetPrintError virtualpure virtual 
virtual void SetPrintError(bool v) = 0

report errors to stderr or not

Defined in mvodb/mvodb.h:176

WB virtualpure virtual 
virtual void WB(const char* varname, bool v, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:131

WBA virtualpure virtual 
virtual void WBA(const char* varname, const std::vector<bool>& v, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:148

WBAI virtualpure virtual 
virtual void WBAI(const char* varname, int index, bool v, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:162

WD virtualpure virtual 
virtual void WD(const char* varname, double v, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:133

WDA virtualpure virtual 
virtual void WDA(const char* varname, const std::vector<double>& v, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:150

WDAI virtualpure virtual 
virtual void WDAI(const char* varname, int index, double v, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:164

WF virtualpure virtual 
virtual void WF(const char* varname, float v, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:134

WFA virtualpure virtual 
virtual void WFA(const char* varname, const std::vector<float>& v, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:151

WFAI virtualpure virtual 
virtual void WFAI(const char* varname, int index, float v, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:165

WI virtualpure virtual 
virtual void WI(const char* varname, int v, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:132

WIA virtualpure virtual 
virtual void WIA(const char* varname, const std::vector<int>& v, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:149

WIAI virtualpure virtual 
virtual void WIAI(const char* varname, int index, int v, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:163

WS virtualpure virtual 
virtual void WS(const char* varname, const char* v, int string_length = 0, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:135

WSA virtualpure virtual 
virtual void WSA(const char* varname, const std::vector<std::string>& v, int string_length, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:152

WSAI virtualpure virtual 
virtual void WSAI(const char* varname, int index, const char* v, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:166

WU16 virtualpure virtual 
virtual void WU16(const char* varname, uint16_t v, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:136

WU16A virtualpure virtual 
virtual void WU16A(const char* varname, const std::vector<uint16_t>& v, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:153

WU16AI virtualpure virtual 
virtual void WU16AI(const char* varname, int index, uint16_t v, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:167

WU32 virtualpure virtual 
virtual void WU32(const char* varname, uint32_t v, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:137

WU32A virtualpure virtual 
virtual void WU32A(const char* varname, const std::vector<uint32_t>& v, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:154

WU32AI virtualpure virtual 
virtual void WU32AI(const char* varname, int index, uint32_t v, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:168

WU64 virtualpure virtual 
virtual void WU64(const char* varname, uint64_t v, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:138

WU64A virtualpure virtual 
virtual void WU64A(const char* varname, const std::vector<uint64_t>& v, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:155

WU64AI virtualpure virtual 
virtual void WU64AI(const char* varname, int index, uint64_t v, MVOdbError* error = NULL) = 0

Defined in mvodb/mvodb.h:169

~MVOdb virtualpure virtual 
virtual ~MVOdb() = 0

dtor

Declared in mvodb/mvodb.h:24, defined in mvodb/mvodb.cxx:17

MVOdbError

Defined in mvodb/mvodb.h:193

Methods
MVOdbError 
MVOdbError()

Declared in mvodb/mvodb.h:202, defined in mvodb/mvodb.cxx:29

Attributes
fError 
bool fError

true if there is an error, false if no error

Defined in mvodb/mvodb.h:196

fErrorString 
std::string fErrorString

error text suitable for printing an error message

Defined in mvodb/mvodb.h:197

fPath 
std::string fPath

odb path corresponding to the error

Defined in mvodb/mvodb.h:198

fStatus 
int fStatus

MIDAS ODB status numerical value

Defined in mvodb/mvodb.h:199

Functions

MakeFileDumpOdb 

MVOdb*MakeFileDumpOdb(const char* buf, size_t bufsize, MVOdbError* error = NULL)

Access ODB from a midas file dump. Format could be .xml, .json or .odb

Declared in mvodb/mvodb.h:191, defined in mvodb/mvodb.cxx:94

MakeJsonBufferOdb 

MVOdb*MakeJsonBufferOdb(const char* buf, size_t bufsize, MVOdbError* error = NULL)

Declared in mvodb/mvodb.h:187, defined in mvodb/mjsonodb.cxx:704

MakeJsonFileOdb 

MVOdb*MakeJsonFileOdb(const char* filename, MVOdbError* error = NULL)

Declared in mvodb/mvodb.h:186, defined in mvodb/mjsonodb.cxx:666

MakeMidasOdb 

MVOdb*MakeMidasOdb(int hDB, MVOdbError* error = NULL)

Declared in mvodb/mvodb.h:181, defined in mvodb/midasodb.cxx:981

MakeNullOdb 

MVOdb*MakeNullOdb()

Declared in mvodb/mvodb.h:180, defined in mvodb/nullodb.cxx:137

MakeXmlBufferOdb 

MVOdb*MakeXmlBufferOdb(const char* buf, size_t bufsize, MVOdbError* error = NULL)

Declared in mvodb/mvodb.h:184, defined in mvodb/mxmlodb.cxx:753

MakeXmlFileOdb 

MVOdb*MakeXmlFileOdb(const char* filename, MVOdbError* error = NULL)

Declared in mvodb/mvodb.h:183, defined in mvodb/mxmlodb.cxx:722

SetError 

void SetError(MVOdbError* error, bool print, const std::string& path, const std::string& message)

Declared in mvodb/mvodb.h:206, defined in mvodb/mvodb.cxx:73

SetMidasStatus 

void SetMidasStatus(MVOdbError* error, bool print, const std::string& path, const char* midas_func_name, int status)

Declared in mvodb/mvodb.h:207, defined in mvodb/mvodb.cxx:44

SetOk 

void SetOk(MVOdbError* error)

Declared in mvodb/mvodb.h:205, defined in mvodb/mvodb.cxx:34