$darkmode
![]() |
Qore DataProvider Module Reference 2.7.1
|
describes a data type based on a hashdecl More...
#include <QoreDataField.qc.dox.h>
Public Member Functions | |
appendDescription (string separator, string new_desc) | |
adds a string to the description More... | |
constructor (string name, *string desc, AbstractDataProviderType type, auto default_value, *softlist< auto > allowed_values) | |
creates the field from the arguments | |
constructor (string name, *string desc, Type type, auto default_value, *softlist< auto > allowed_values) | |
creates the field from the arguments | |
*string | getDescription () |
returns the description, if any | |
hash< DataFieldInfo > | getInfo () |
returns information about the field | |
string | getName () |
returns the name of the field | |
AbstractDataField | getOrNothingType () |
returns a field with an "or nothing" type equivalent to the current type More... | |
AbstractDataField | getSoftType () |
returns a field with a "soft" type equivalent to the current type More... | |
AbstractDataProviderType | getType () |
returns the type of the field | |
![]() | |
auto | acceptsValue (auto value) |
returns the value if the value can be assigned to the type More... | |
*hash< string, bool > | getAllowedValueMap () |
Get allowed values. | |
*list< auto > | getAllowedValues () |
Get allowed values. | |
auto | getDefaultValue () |
get default value, if any | |
abstract *string | getDescription () |
returns the description, if any | |
hash< DataFieldInfo > | getInfo () |
returns information about the field | |
hash< DataFieldInfo > | getInputInfo () |
returns information about the field as an input field More... | |
abstract string | getName () |
returns the name of the field | |
*hash< auto > | getOptions () |
returns options set on the field's type | |
auto | getOptionValue (string opt) |
returns the value of the given option on the field's type | |
AbstractDataField | getOrNothingType () |
returns a field with an "or nothing" type equivalent to the current type More... | |
AbstractDataField | getSoftType () |
returns a field with a "soft" type equivalent to the current type More... | |
*hash< string, hash< DataProviderTypeOptionInfo > > | getSupportedOptions () |
returns supported options on the field's type | |
abstract AbstractDataProviderType | getType () |
returns the type of the field | |
string | getTypeName () |
returns the type name | |
bool | hasType () |
returns True if the field's type is not a wildcard type | |
bool | isAssignableFrom (AbstractDataProviderType t) |
returns True if this field's type can be assigned from values of the argument type | |
bool | isAssignableFrom (Type t) |
returns True if this field's type can be assigned from values of the argument type | |
bool | isList () |
returns True if this field's type is a list | |
bool | isMandatory () |
returns True if the field's type must have a value | |
setAllowedValues (list< auto > allowed_values) | |
Sets allowed values for enum types. | |
setDefaultValue (auto default_value) | |
sets the default value for the field | |
setOption (string opt, auto value) | |
sets the given option on the field's type More... | |
setOptions (hash< auto > options) | |
sets the given options on the field's type More... | |
Protected Member Functions | |
AbstractDataField | getNewFieldType (AbstractDataProviderType new_type) |
returns a field with the new type More... | |
Protected Attributes | |
*string | desc |
description of the field | |
string | name |
name of the field | |
AbstractDataProviderType | type |
field type | |
![]() | |
list< auto > | allowed_values |
for enum fields; raw allowed values | |
hash< string, bool > | allowed_values_map |
for enum fields; allowed values More... | |
auto | default_value |
the default value for the field, if any | |
describes a data type based on a hashdecl
adds a string to the description
separator | string to add first if there is already a description |
new_desc | the new string to add to the description |
|
protected |
returns a field with the new type
AbstractDataField DataProvider::QoreDataField::getOrNothingType | ( | ) |
returns a field with an "or nothing" type equivalent to the current type
AbstractDataField DataProvider::QoreDataField::getSoftType | ( | ) |
returns a field with a "soft" type equivalent to the current type