HashDataType.qc.dox.h
// -*- mode: c++; indent-tabs-mode: nil -*-
// assume local scope for variables, do not use "$" signs
// require type definitions everywhere
// enable all warnings
namespace DataProvider {
class HashDataType : public QoreDataType {
public:
protected:
string name;
hash<string, AbstractDataField> fields;
*AbstractDataProviderType default_other_field_type =
AbstractDataProviderType::get(AbstractDataProviderType::anyType);
bool has_default_other_field_type = False;
public:
constructor(string name = AutoHashType.getName(), *hash<auto> options) ;
constructor(Type base_type, *string name, *hash<auto> options) ;
constructor(string name = AutoHashType.getName(), hash<string, AbstractDataField> fields, *hash<auto> options)
;
setDefaultOtherFieldType(*AbstractDataProviderType default_other_field_type);
string getName();
auto acceptsValue(auto value);
bool isAssignableFrom(AbstractDataProviderType t);
addField(AbstractDataField field);
*AbstractDataField getField(string name);
*hash<string, AbstractDataField> getFields();
AbstractDataProviderType getSoftType();
hash<DataTypeInfo> getInfo();
AbstractDataProviderType getOrNothingType();
};
};
DataProvider::AbstractDataField
describes a data type based on a hashdecl
Definition: AbstractDataField.qc.dox.h:44
DataProvider::AbstractDataProviderType
describes a data type
Definition: AbstractDataProviderType.qc.dox.h:91
DataProvider::AbstractDataProviderType::options
hash< auto > options
type options
Definition: AbstractDataProviderType.qc.dox.h:101
DataProvider::AbstractDataProviderType::get
static AbstractDataProviderType get(Type type, *hash< auto > options)
Returns an appropriate object for the given type.
DataProvider::HashDataType
describes a data type based on a hash
Definition: HashDataType.qc.dox.h:39
DataProvider::HashDataType::constructor
constructor(string name=AutoHashType.getName(), hash< string, AbstractDataField > fields, *hash< auto > options)
creates the object from the given record description and assigns the name as the type
DataProvider::HashDataType::getOrNothingType
AbstractDataProviderType getOrNothingType()
Returns an "or nothing" type equivalent to the current type.
DataProvider::HashDataType::addField
addField(AbstractDataField field)
adds a field to the type
DataProvider::HashDataType::isAssignableFrom
bool isAssignableFrom(AbstractDataProviderType t)
Returns True if this type can be assigned from values of the argument type.
DataProvider::HashDataType::getFields
*hash< string, AbstractDataField > getFields()
Returns the fields of the data structure; if any.
DataProvider::HashDataType::fields
hash< string, AbstractDataField > fields
fields
Definition: HashDataType.qc.dox.h:47
DataProvider::HashDataType::getField
*AbstractDataField getField(string name)
Returns the given field, if present, or NOTHING if not.
DataProvider::HashDataType::setDefaultOtherFieldType
setDefaultOtherFieldType(*AbstractDataProviderType default_other_field_type)
Sets the default field type for unlisted fields.
DataProvider::HashDataType::has_default_other_field_type
bool has_default_other_field_type
if the type requires validation
Definition: HashDataType.qc.dox.h:54
DataProvider::HashDataType::constructor
constructor(Type base_type, *string name, *hash< auto > options)
creates the object and assigns the name as the given name or the base type's name
DataProvider::HashDataType::getName
string getName()
Returns the type name.
DataProvider::HashDataType::getSoftType
AbstractDataProviderType getSoftType()
Returns a "soft" type equivalent to the current type.
DataProvider::HashDataType::name
string name
the name of the type
Definition: HashDataType.qc.dox.h:44
DataProvider::HashDataType::acceptsValue
auto acceptsValue(auto value)
Returns the value if the value can be assigned to the type.
DataProvider::HashDataType::constructor
constructor(string name=AutoHashType.getName(), *hash< auto > options)
creates the object and assigns the name as the type
DataProvider::HashDataType::default_other_field_type
*AbstractDataProviderType default_other_field_type
allow other fields
Definition: HashDataType.qc.dox.h:50
DataProvider::HashDataType::getInfo
hash< DataTypeInfo > getInfo()
returns a description of the type as a hash
DataProvider::QoreDataType
describes a data type based on a Qore data type
Definition: QoreDataType.qc.dox.h:37
False
const False
DataProvider
Qore AbstractDataField class definition.
Definition: AbstractDataField.qc.dox.h:27