NDEVR
API Documentation
Database.h
1/*--------------------------------------------------------------------------------------------
2Copyright (c) 2019, NDEVR LLC
3tyler.parke@ndevr.org
4 __ __ ____ _____ __ __ _______
5 | \ | | | __ \ | ___|\ \ / / | __ \
6 | \ | | | | \ \ | |___ \ \ / / | |__) |
7 | . \| | | |__/ / | |___ \ V / | _ /
8 | |\ |_|_____/__|_____|___\_/____| | \ \
9 |__| \__________________________________| \__\
10
11Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants
12Licensee a limited, non-exclusive, non-transferable, royalty-free license
13(without the right to sublicense) to use the API solely for the purpose of
14Licensee's internal development efforts to develop applications for which
15the API was provided.
16
17The above copyright notice and this permission notice shall be included in all
18copies or substantial portions of the Software.
19
20THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
21INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
22PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
23FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
24OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
25DEALINGS IN THE SOFTWARE.
26
27Library: Database
28File: Database
29Included in API: True
30Author(s): Tyler Parke
31 *-----------------------------------------------------------------------------------------**/
32#pragma once
33#include <NDEVR/Table.h>
34#include <NDEVR/Pointer.h>
35#include <NDEVR/Dictionary.h>
36namespace NDEVR
37{
43 class NDEVR_DATABASE_API Database
44 {
45 public:
55 {
56 return m_tables[name];
57 }
58
65 virtual void addTable(DynamicPointer<Table>& table);
66
75
81 {
82 return m_tables;
83 }
84 protected:
86 };
87}
Provides access to a set of named database tables.
Definition Database.h:44
virtual void addTable(DynamicPointer< Table > &table)
Adds a table to the database.
Dictionary< String, DynamicPointer< Table > > m_tables
Maps table names to their corresponding Table pointers.
Definition Database.h:85
virtual const Dictionary< String, DynamicPointer< Table > > & tables() const
Returns a const reference to the dictionary of all tables.
Definition Database.h:80
virtual DynamicPointer< Table > & getTable(const String &name)
Retrieves a table by name from the database.
Definition Database.h:54
virtual Dictionary< String, DynamicPointer< Table > > & tables()
Returns a mutable reference to the dictionary of all tables.
Definition Database.h:71
A hash-based key-value store, useful for quick associative lookups.
Definition Dictionary.h:64
Provides a modifiable pointer that has shared ownership of a dynamically allocated object.
Definition Pointer.hpp:356
The core String class for the NDEVR API.
Definition String.h:95
The primary namespace for the NDEVR SDK.
@ name
The display name of the object.