231 hash<DataProviderTypeEntryInfo>
getInfo(*
bool rec_children_only);
348class DataProviderTypeEntryPrivate :
public DataProviderTypeEntry {
352 static forceRemoveChild(DataProviderTypeEntry entry,
string child);
describes a data type
Definition AbstractDataProviderType.qc.dox.h:139
the DataProviderTypeEntry class
Definition DataProviderTypeEntry.qc.dox.h:70
bool setType(AbstractDataProviderType type, bool locked=False)
Sets the type for the entry.
bool isParent()
Returns True if the entry is a "parent" entry, meaning that all children were added with this entry.
bool clear()
Clears the type hierarchy of all non-locked types.
*int epheremal_type_id
Epheremal ID for the type.
Definition DataProviderTypeEntry.qc.dox.h:101
constructor()
Creates the entry as a root node.
bool checkRemoveChild(string child)
Checks if the given child can be removed, if it exists.
string getPath()
Returns the path of the entry.
*AbstractDataProviderType getType()
Returns the type at the entry level, if any.
*hash< auto > info
Free-form information related to the type.
Definition DataProviderTypeEntry.qc.dox.h:104
setTypeChildren()
Sets up attributes as children.
*list< string > listParentTypes()
Returns a list of registered data provider type paths where each type listed is a "parent" type.
constructor(string path, string name)
Creates the entry as a child node.
*AbstractDataProviderType getTypeEx()
Returns the type at the entry level, if any, otherwise throws an exception.
*hash< string, DataProviderTypeEntry > rec_children
Names of attributes that can be referenced as children that have their own fields.
Definition DataProviderTypeEntry.qc.dox.h:87
constructor(string path, string name, AbstractDataProviderType type)
Creates the entry as a child node.
*hash< string, DataProviderTypeEntry > type_children
Names of attributes that can be referenced as children.
Definition DataProviderTypeEntry.qc.dox.h:84
string getDesc()
Returns the description of the entry.
bool checkLocked(*bool throw_exception)
Returns the locked status and optionally throws an exception if locked.
static Sequence seq(1)
Sequence for epheremal IDs for types.
*int getEpheremalTypeId()
Returns the epheremal type ID.
bool hasType()
Returns True if the entry has a type.
string path
The path to this entry.
Definition DataProviderTypeEntry.qc.dox.h:75
lockAll()
Locks all types.
bool locked
True if the entry is locked and therefore cannot be deleted or updated
Definition DataProviderTypeEntry.qc.dox.h:95
static bool neg
If epheremal IDs should be negative.
Definition DataProviderTypeEntry.qc.dox.h:107
hash< DataProviderTypeEntryInfo > getInfo(*bool rec_children_only)
Returns information about this entry.
*DataProviderTypeEntry getChildEx(string child)
Returns the given child, if any, otherwise throws an exception.
string getName()
Returns the name of the entry.
*hash< auto > getFreeFormInfo()
Returns free-form information related to the type, if any.
addChild(string child)
Adds a child node to the entry.
DataProviderTypeEntry removeChild(string child)
Removes the given child, if it exists.
bool isLocked()
Returns the locked status.
*list< string > listTypes()
Returns a list of registered data provider type paths.
bool lock()
Locks the entry, so it can't be removed or changed.
string getDisplayName()
Returns the display name of the entry.
static setEpheremalIdStart(int n)
Sets the start of the sequence for epheremal IDs.
*AbstractDataProviderType type
The type at this location.
Definition DataProviderTypeEntry.qc.dox.h:90
bool parent
True if this entry is a "parent" type; if the children were added atomically with this entry
Definition DataProviderTypeEntry.qc.dox.h:98
bool checkRemoveChildEx(string child)
Checks if the given child can be removed, if it exists.
string name
The name of this entry.
Definition DataProviderTypeEntry.qc.dox.h:78
DataProviderTypeEntry getCreateChild(string child)
Returns the given child and creates it if necessary.
*DataProviderTypeEntry getChild(string child)
Returns the given child, if any.
*hash< string, DataProviderTypeEntry > children
Children of this entry.
Definition DataProviderTypeEntry.qc.dox.h:81
*AbstractDataProviderType setOrReplaceType(AbstractDataProviderType type, *int id, *hash< auto > info)
Sets or replaces the type for the entry.
string getShortDescription()
Returns the short description of the entry.
*list< string > getChildNames()
Returns a list of child entry names, if any.
Qore AbstractDataField class definition.
Definition AbstractDataField.qc.dox.h:27
Private definitions.
Definition AbstractDataProviderType.qc.dox.h:454
Data provider type entry info.
Definition DataProviderTypeEntry.qc.dox.h:33
*int epheremal_type_id
Epheremal ID for types.
Definition DataProviderTypeEntry.qc.dox.h:63
*list< string > children
The names of any children.
Definition DataProviderTypeEntry.qc.dox.h:60
string name
The name of the entry.
Definition DataProviderTypeEntry.qc.dox.h:35
*hash< auto > info
Free-form information related to the type.
Definition DataProviderTypeEntry.qc.dox.h:66
bool locked
True if the entry is locked and therefore cannot be deleted or updated
Definition DataProviderTypeEntry.qc.dox.h:57
string display_name
The display name for the entry.
Definition DataProviderTypeEntry.qc.dox.h:38
bool has_type
True if the entry has a type
Definition DataProviderTypeEntry.qc.dox.h:52
string desc
The description of the entry.
Definition DataProviderTypeEntry.qc.dox.h:44
string path
The path to the entry including the name as the last element.
Definition DataProviderTypeEntry.qc.dox.h:47
string short_desc
A short description for the entry, plain text formatting.
Definition DataProviderTypeEntry.qc.dox.h:41