$darkmode
Qore DataProvider Module Reference 2.7.5
HashDataType.qc.dox.h
1 // -*- mode: c++; indent-tabs-mode: nil -*-
3 
26 namespace DataProvider {
28 
36 class HashDataType : public QoreDataType {
37 
38 public:
39 protected:
41  string name;
42 
44  hash<string, AbstractDataField> fields;
45 
48  AbstractDataProviderType::get(AbstractDataProviderType::anyType);
49 
52 
55 
56 public:
57 
59  constructor(string name = AutoHashType.getName(), *hash<auto> options, *hash<auto> tags) ;
60 
61 
63  constructor(Type base_type, *string name, *hash<auto> options, *hash<auto> tags) ;
64 
65 
67  constructor(string name = AutoHashType.getName(), hash<string, AbstractDataField> fields, *hash<auto> options, *hash<auto> tags) ;
68 
69 
72 
73 
76 
77 
80 
81 
83  string getName();
84 
85 
87 
93  auto acceptsValue(auto input_value);
94 
95 
97 
101 
102 
105 
106 
109 
110 
112  *hash<string, AbstractDataField> getFields();
113 
114 
116 
119 
120 
122  hash<DataTypeInfo> getInfo();
123 
124 
126 
129 
130 };
131 };
describes a data type based on a hashdecl
Definition: AbstractDataField.qc.dox.h:47
describes a data type
Definition: AbstractDataProviderType.qc.dox.h:206
*hash< auto > tags
type tags
Definition: AbstractDataProviderType.qc.dox.h:222
hash< auto > options
type options
Definition: AbstractDataProviderType.qc.dox.h:219
static AbstractDataProviderType get(Type type, *hash< auto > options, *hash< auto > tags)
Returns an appropriate object for the given type.
describes a data type based on a hash
Definition: HashDataType.qc.dox.h:36
AbstractDataProviderType getOrNothingType()
Returns an "or nothing" type equivalent to the current type.
bool manual_default_other_field_type
default other field type set mamnually?
Definition: HashDataType.qc.dox.h:51
constructor(string name=AutoHashType.getName(), hash< string, AbstractDataField > fields, *hash< auto > options, *hash< auto > tags)
creates the object from the given record description and assigns the name as the type
*AbstractDataProviderType getDefaultOtherFieldType()
Returns the default field type for undeclared fields, if any.
constructor(string name=AutoHashType.getName(), *hash< auto > options, *hash< auto > tags)
creates the object and assigns the name as the type
bool isAssignableFrom(AbstractDataProviderType t)
Returns True if this type can be assigned from values of the argument type.
*hash< string, AbstractDataField > getFields()
Returns the fields of the data structure; if any.
hash< string, AbstractDataField > fields
fields
Definition: HashDataType.qc.dox.h:44
*AbstractDataField getField(string name)
Returns the given field, if present, or NOTHING if not.
HashDataType addField(AbstractDataField field)
adds a field to the type
setDefaultOtherFieldType(*AbstractDataProviderType default_other_field_type)
Sets the default field type for unlisted fields.
bool has_default_other_field_type
if the type requires validation
Definition: HashDataType.qc.dox.h:54
string getName()
Returns the type name.
AbstractDataProviderType getSoftType()
Returns a "soft" type equivalent to the current type.
string name
the name of the type
Definition: HashDataType.qc.dox.h:41
*AbstractDataProviderType default_other_field_type
allow other fields
Definition: HashDataType.qc.dox.h:47
auto acceptsValue(auto input_value)
Returns the value if the value can be assigned to the type.
hash< DataTypeInfo > getInfo()
returns a description of the type as a hash
bool hasDefaultOtherFieldType()
Returns True if the type has a default field type for undeclared fields.
constructor(Type base_type, *string name, *hash< auto > options, *hash< auto > tags)
creates the object and assigns the name as the given name or the base type's name
describes a data type based on a Qore data type
Definition: QoreDataType.qc.dox.h:31
const False
Qore AbstractDataField class definition.
Definition: AbstractDataField.qc.dox.h:27