Beamlib  3.0.1
This is the Beam C++ class library.
BObj.h
Go to the documentation of this file.
1 /*******************************************************************************
2  * BObj.h Beam Object
3  * T.Barnaby, BEAM Ltd, 2008-06-04
4  * Copyright (c) 2022 All Right Reserved, Beam Ltd, https://www.beam.ltd.uk
5  * For license see LICENSE.txt at the root of the beamlib source tree.
6  *******************************************************************************
7  */
8 #ifndef BObj_H
9 #define BObj_H 1
10 
11 #include <BTypes.h>
12 #include <BDict.h>
13 #include <BString.h>
14 #include <BError.h>
15 
17 class BObj {
18 public:
19  BObj();
20  virtual ~BObj();
21 
22  // member interface
23  virtual const char* getType() const;
24  virtual const BObjMember* getMembers() const;
25 
26  // Old member interface
27  virtual BError getMembers(BDictString& members);
28  virtual BError getMember(BString name, BString& value);
29  virtual BError setMembers(BDictString& members);
30  virtual BError setMember(BString name, BString value);
31 
32  // Debug functions
33  virtual void membersPrint() const;
34  virtual BString getDebugString();
35 };
36 
37 #endif
Dictionary list class using templates.
Definition: BDict.h:24
Error return class. This class is used to return the error status from a function....
Definition: BError.h:31
A generic object base class that has runtime definable data feilds.
Definition: BObj.h:17
virtual BError setMember(BString name, BString value)
Definition: BObj.cpp:49
virtual const BObjMember * getMembers() const
Definition: BObj.cpp:20
BObj()
Definition: BObj.cpp:10
virtual BError setMembers(BDictString &members)
Definition: BObj.cpp:43
virtual const char * getType() const
Definition: BObj.cpp:16
virtual ~BObj()
Definition: BObj.cpp:13
virtual BError getMember(BString name, BString &value)
Definition: BObj.cpp:37
virtual void membersPrint() const
Prints out members.
Definition: BObj.cpp:55
virtual BString getDebugString()
Returns contents as a debug string.
Definition: BObj.cpp:64
This class stores and manipulates ASCII strings.
Definition: BString.h:20
A structure to define a member of a generic BObj.
Definition: BTypes.h:106