Qore DataProvider Module Reference  1.0
DataProviderTypeEntry.qc.dox.h
1 // -*- mode: c++; indent-tabs-mode: nil -*-
3 
25 // assume local scope for variables, do not use "$" signs
26 // require type definitions everywhere
27 // strict argument handling
28 // enable all warnings
29 
31 namespace DataProvider {
35  string name;
36 
38  string path;
39 
41 
43  bool has_type;
44 
46  *list<string> children;
47 };
48 
51 
52 public:
53 protected:
55  string path;
56 
58  string name;
59 
61  *hash<string, DataProviderTypeEntry> children;
62 
65 
66 public:
67 
69 
71  constructor();
72 
73 
75 
77  constructor(string path, string name);
78 
79 
81  string getName();
82 
83 
85  string getPath();
86 
87 
89 
93  addChild(string child);
94 
95 
97 
102 
103 
105 
107  hash<DataProviderTypeEntryInfo> getInfo();
108 
109 
111 
115  *list<string> listTypes();
116 
117 
119 
121  *list<string> getChildNames();
122 
123 
125 
128 
129 
131 
136 
137 
139 
141  *DataProviderTypeEntry getChild(string child);
142 
143 
145 
149  *DataProviderTypeEntry getChildEx(string child);
150 
151 
153 
156 
157 };
158 };
DataProvider::DataProviderTypeEntry::getTypeEx
*AbstractDataProviderType getTypeEx()
Returns the type at the entry level, if any, otherwise throws an exception.
DataProvider::DataProviderTypeEntry::path
string path
The path to this entry.
Definition: DataProviderTypeEntry.qc.dox.h:55
DataProvider::AbstractDataProviderType
describes a data type
Definition: AbstractDataProviderType.qc.dox.h:161
DataProvider::DataProviderTypeEntry::constructor
constructor()
Creates the entry as a root node.
DataProvider::DataProviderTypeEntry::getType
*AbstractDataProviderType getType()
Returns the type at the entry level, if any.
DataProvider::DataProviderTypeEntry::name
string name
The name of this entry.
Definition: DataProviderTypeEntry.qc.dox.h:58
DataProvider::DataProviderTypeEntry::children
*hash< string, DataProviderTypeEntry > children
Children of this entry.
Definition: DataProviderTypeEntry.qc.dox.h:61
DataProvider::DataProviderTypeEntry::getPath
string getPath()
Returns the path of the entry.
DataProvider
Qore AbstractDataField class definition.
Definition: AbstractDataField.qc.dox.h:32
DataProvider::DataProviderTypeEntry::setType
setType(AbstractDataProviderType type)
Sets the type for the entry.
DataProvider::DataProviderTypeEntry::getChildEx
*DataProviderTypeEntry getChildEx(string child)
Returns the given child, if any, otherwise throws an exception.
DataProvider::DataProviderTypeEntry::getChild
*DataProviderTypeEntry getChild(string child)
Returns the given child, if any.
DataProvider::DataProviderTypeEntryInfo::name
string name
The name of the entry.
Definition: DataProviderTypeEntry.qc.dox.h:35
DataProvider::DataProviderTypeEntryInfo
Data provider type entry info.
Definition: DataProviderTypeEntry.qc.dox.h:33
DataProvider::DataProviderTypeEntryInfo::children
*list< string > children
The names of any children.
Definition: DataProviderTypeEntry.qc.dox.h:46
DataProvider::DataProviderTypeEntry::getName
string getName()
Returns the name of the entry.
DataProvider::DataProviderTypeEntry
the DataProviderTypeEntry class
Definition: DataProviderTypeEntry.qc.dox.h:50
DataProvider::DataProviderTypeEntryInfo::path
string path
The path to the entry including the name as the last element.
Definition: DataProviderTypeEntry.qc.dox.h:38
DataProvider::DataProviderTypeEntry::listTypes
*list< string > listTypes()
Returns a list of registered data provider type paths.
DataProvider::DataProviderTypeEntry::addChild
addChild(string child)
Adds a child node to the entry.
DataProvider::DataProviderTypeEntry::getChildNames
*list< string > getChildNames()
Returns a list of child entry names, if any.
DataProvider::DataProviderTypeEntryInfo::has_type
bool has_type
True if the entry has a type
Definition: DataProviderTypeEntry.qc.dox.h:43
DataProvider::DataProviderTypeEntry::getCreateChild
DataProviderTypeEntry getCreateChild(string child)
Returns the given child and creates it if necessary.
DataProvider::DataProviderTypeEntry::getInfo
hash< DataProviderTypeEntryInfo > getInfo()
Returns information about this entry.
DataProvider::DataProviderTypeEntry::type
*AbstractDataProviderType type
The type at this location.
Definition: DataProviderTypeEntry.qc.dox.h:64