Tome::CustomType Class Reference

User-defined type of any field. More...

#include <customtype.h>

Public Member Functions
QString	getBaseType () const
	Convenience function for retrieving the BaseType fundamental facet of this type, if available. Returns an empty string, if not. More...
QStringList	getEnumeration () const
	Convenience function for retrieving the Enumeration fundamental facet of this type, if available. Returns an empty list, if not. More...
QString	getItemType () const
	Convenience function for retrieving the Item Type fundamental facet of this type, if available. Returns an empty string, if not. More...
QString	getKeyType () const
	Convenience function for retrieving the Key Type fundamental facet of this type, if available. Returns an empty string, if not. More...
QString	getValueType () const
	Convenience function for retrieving the Value Type fundamental facet of this type, if available. Returns an empty string, if not. More...
bool	isDerivedType () const
	Checks whether this custom type is a derived type. More...
bool	isEnumeration () const
	Checks whether this custom type is an enumeration. More...
bool	isList () const
	Checks whether this custom type is a list type. More...
bool	isMap () const
	Checks whether this custom type is a map type. More...
void	setBaseType (const QString &baseType)
	Sets the BaseType fundamental facet of this type. More...
void	setEnumeration (const QStringList &enumeration)
	Sets the Enumeration fundamental facet of this type. More...
void	setItemType (const QString &itemType)
	Sets the Item Type fundamental facet of this type. More...
void	setKeyType (const QString &keyType)
	Sets the Key Type fundamental facet of this type. More...
void	setValueType (const QString &valueType)
	Sets the Value Type fundamental facet of this type. More...

Public Attributes
QString	name
	Name of this custom type.
QVariantMap	fundamentalFacets
	Values of fundamental facets of this type, e.g. type of the keys of a map.
QVariantMap	constrainingFacets
	Values of constraining facets of this type, e.g. maximum value of an integer.
QString	typeSetName
	Name of the set this custom type belongs to.

Detailed Description

User-defined type of any field.

Member Function Documentation

getBaseType()

QString CustomType::getBaseType

(

)

const

Convenience function for retrieving the BaseType fundamental facet of this type, if available. Returns an empty string, if not.

Returns

BaseType of this derived type, if available, and an empty string otherwise.

getEnumeration()

QStringList CustomType::getEnumeration

(

)

const

Convenience function for retrieving the Enumeration fundamental facet of this type, if available. Returns an empty list, if not.

Returns

Enumeration of allowed field values, if available, and an empty list otherwise.

getItemType()

QString CustomType::getItemType

(

)

const

Convenience function for retrieving the Item Type fundamental facet of this type, if available. Returns an empty string, if not.

Returns

Item Type of this list, if available, and an empty string otherwise.

getKeyType()

QString CustomType::getKeyType

(

)

const

Convenience function for retrieving the Key Type fundamental facet of this type, if available. Returns an empty string, if not.

Returns

Key Type of this map, if available, and an empty string otherwise.

getValueType()

QString CustomType::getValueType

(

)

const

Convenience function for retrieving the Value Type fundamental facet of this type, if available. Returns an empty string, if not.

Returns

Value Type of this map, if available, and an empty string otherwise.

isDerivedType()

bool CustomType::isDerivedType

(

)

const

Checks whether this custom type is a derived type.

Returns

true, if this custom type is a derived type, and false otherwise.

isEnumeration()

bool CustomType::isEnumeration

(

)

const

Checks whether this custom type is an enumeration.

Returns

true, if this custom type is an enumeration, and false otherwise.

isList()

bool CustomType::isList

(

)

const

Checks whether this custom type is a list type.

Returns

true, if this custom type is a list type, and false otherwise.

isMap()

bool CustomType::isMap

(

)

const

Checks whether this custom type is a map type.

Returns

true, if this custom type is a map type, and false otherwise.

setBaseType()

void CustomType::setBaseType

(

const QString &

baseType

)

Sets the BaseType fundamental facet of this type.

Parameters

baseType

Type this type is based on.

setEnumeration()

void CustomType::setEnumeration

(

const QStringList &

enumeration

)

Sets the Enumeration fundamental facet of this type.

Parameters

enumeration

Allowed values for fields of this type.

setItemType()

void CustomType::setItemType

(

const QString &

itemType

)

Sets the Item Type fundamental facet of this type.

Parameters

itemType

Type of the list items.

setKeyType()

void CustomType::setKeyType

(

const QString &

keyType

)

Sets the Key Type fundamental facet of this type.

Parameters

keyType

Type of the map keys.

setValueType()

void CustomType::setValueType

(

const QString &

valueType

)

Sets the Value Type fundamental facet of this type.

Parameters

valueType

Type of the map values.

---

The documentation for this class was generated from the following files:

• Source/Tome/Features/Types/Model/customtype.h
• Source/Tome/Features/Types/Model/customtype.cpp