Types¶

class caris.Type¶

class caris.StringType¶

string type

code¶

str – The code

name¶

str – The name

description¶

str – The description

min_length¶

int – The minimum string length

max_length¶

int – The maximum string length

default_value¶

str – The default value

__init__()¶

Constructor

Parameters:	code (str) – The code of the string type name (str) – The name of the string type description (str) – The description of the string type default_value (str, optional) – The default value of the string type min_length (int, optional) – The minimum string length max_length (int, optional) – The maximum string length

class caris.DateType¶

date type

code¶

str – The code

name¶

str – The name

description¶

str – The description

min_value¶

datetime.date – The minimum value

max_value¶

datetime.date – The maximum value

default_value¶

datetime.date – The default value

__init__()¶

Constructor

Parameters:	code (str) – The code of the date type name (str) – The name of the date type description (str) – The description of the date type default_value (datetime.date, optional) – The default value of the date type min_value (datetime.date, optional) – The minimum value max_value (datetime.date, optional) – The maximum value

class caris.DateTimeType¶

date & time type

code¶

str – The code

name¶

str – The name

description¶

str – The description

min_value¶

datetime.datetime – The minimum value

max_value¶

datetime.datetime – The maximum value

default_value¶

datetime.datetime – The default value

__init__()¶

Constructor

Parameters:	code (str) – The code of the datetime type name (str) – The name of the datetime type description (str) – The description of the datetime type default_value (datetime.dateTime, optional) – The default value of the datetime type min_value (datetime.dateTime, optional) – The minimum value max_value (datetime.dateTime, optional) – The maximum value

class caris.BoolType¶

bool type

code¶

str – The code

name¶

str – The name

description¶

str – The description

__init__()¶

Constructor

Parameters:	code (str) – The code of the bool type name (str) – The name of the bool type description (str) – The description of the bool type default_value (bool) – The default value of the bool type

class caris.DoubleType¶

double type

code¶

str – The code

name¶

str – The name

description¶

str – The description

min_value¶

float – The minimum value

max_value¶

float – The maximum value

default_value¶

float – The default value

__init__()¶

Constructor

Parameters:	code (str) – The code of the double type name (str) – The name of the double type description (str) – The description of the double type default_value (float, optional) – The default value of the double type min_value (float, optional) – The minimum value max_value (float, optional) – The maximum value

class caris.IntegerType¶

integer type

code¶

str – The code

name¶

str – The name

description¶

str – The description

min_value¶

int – The minimum value

max_value¶

int – The maximum value

default_value¶

int – The default value

__init__()¶

Constructor

Parameters:	code (str) – The code of the integer type name (str) – The name of the integer type description (str) – The description of the integer type default_value (int, optional) – The default value of the integer type min_value (int, optional) – The minimum value max_value (int, optional) – The maximum value

class caris.EnumType¶

enum type

code¶

str – The code

name¶

str – The name

description¶

str – The description

possible_values¶

dict(int, str) – The possible values

default_value¶

int – The default value

__init__()¶

Constructor

Parameters:	code (str) – The code of the enum type name (str) – The name of the enum type description (str) – The description of the enum type possible_values (dict) – The possible values default_value (int, optional) – The default value of the enum type

class caris.FileType¶

file type

code¶

str – The code

name¶

str – The name

description¶

str – The description

default_value¶

str – The default value

__init__()¶

Constructor

Parameters:	code (str) – The code of the file type name (str) – The name of the file type description (str) – The description of the file type default_value (str, optional) – The default value of the file type

class caris.QuantityType¶

quantity type

code¶

str – The code

name¶

str – The name

description¶

str – The description

min_value¶

Quantity – The minimum value

max_value¶

Quantity – The maximum value

default_value¶

Quantity – The default value

__init__()¶

Constructor

Parameters:	code (str) – The code of the quantity type name (str) – The name of the quantity type description (str) – The description of the quantity type default_value (Quantity, optional) – The default value of the quantity type min_value (Quantity, optional) – The minimum value max_value (Quantity, optional) – The maximum value

class caris.ComplexType¶

A complex type

code¶

str – The code of the complex type

name¶

str – The name of the complex type

description¶

str – The description of the complex type

attributes¶

AttributeDefinitionDictionary – The definitions of the attributes defined for this type

__init__()¶

Constructor

Parameters:	code (str) – The code of the complex type name (str) – The name of the complex type description (str) – The description of the complex type

add()¶

TODO

get_definition()¶

TODO

class caris.MeasurementType¶

measurement type

code¶

str – The code

name¶

str – The name

description¶

str – The description

min_value¶

Quantity – The minimum value

max_value¶

Quantity – The maximum value

default_value¶

Quantity – The default value

__init__()¶

Constructor

Parameters:	code (str) – The code of the measurement type name (str) – The name of the measurement type description (str) – The description of the measurement type default_value (Quantity, optional) – The default value of the measurement type min_value (Quantity, optional) – The minimum value max_value (Quantity, optional) – The maximum value