| Qore DataProvider Module Reference 1.2.1

QoreDataField.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
28 // enable all warnings
29
30
32 namespace DataProvider {
34 class QoreDataField : public AbstractDataField {
35
36 public:
37 protected:
39 string name;
40
42 *string desc;
43
45 AbstractDataProviderType type;
46
47 public:
48
50 constructor(string name, *string desc, Type type, auto default_value);
51
52
54 constructor(string name, *string desc, AbstractDataProviderType type, auto default_value);
55
56
58 string getName();
59
60
62 *string getDescription();
63
64
66 AbstractDataProviderType getType();
67
68
70
73 appendDescription(string separator, string new_desc);
74
75
77 hash<DataFieldInfo> getInfo();
78
79
81
83 AbstractDataField getSoftType();
84
85
87
89 AbstractDataField getOrNothingType();
90
91
93
95 protected:
96 AbstractDataField getNewFieldType(AbstractDataProviderType new_type);
97 public:
98
99 };
100 };
DataProvider::AbstractDataField::default_value
auto default_value
the default value for the field, if any
Definition: AbstractDataField.qc.dox.h:49
DataProvider::QoreDataField::getDescription
*string getDescription()
returns the description, if any
DataProvider::QoreDataField::type
AbstractDataProviderType type
field type
Definition: QoreDataField.qc.dox.h:45
DataProvider::QoreDataField::name
string name
name of the field
Definition: QoreDataField.qc.dox.h:39
DataProvider::QoreDataField::desc
*string desc
description of the field
Definition: QoreDataField.qc.dox.h:42
DataProvider::QoreDataField::getName
string getName()
returns the name of the field
DataProvider::QoreDataField::getOrNothingType
AbstractDataField getOrNothingType()
returns a field with an "or nothing" type equivalent to the current type
DataProvider::QoreDataField
describes a data type based on a hashdecl
Definition: QoreDataField.qc.dox.h:34
DataProvider::QoreDataField::getNewFieldType
AbstractDataField getNewFieldType(AbstractDataProviderType new_type)
returns a field with the new type
DataProvider::AbstractDataProviderType
describes a data type
Definition: AbstractDataProviderType.qc.dox.h:88
DataProvider::QoreDataField::getInfo
hash< DataFieldInfo > getInfo()
returns information about the field
DataProvider::AbstractDataField
describes a data type based on a hashdecl
Definition: AbstractDataField.qc.dox.h:44
DataProvider::QoreDataField::constructor
constructor(string name, *string desc, Type type, auto default_value)
creates the field from the arguments
DataProvider::QoreDataField::getSoftType
AbstractDataField getSoftType()
returns a field with a "soft" type equivalent to the current type
DataProvider
Qore AbstractDataField class definition.
Definition: AbstractDataField.qc.dox.h:27
DataProvider::QoreDataField::appendDescription
appendDescription(string separator, string new_desc)
adds a string to the description
DataProvider::QoreDataField::getType
AbstractDataProviderType getType()
returns the type of the field