Types¶

class caris.Type¶

class caris.StringType¶

string type

code¶

The code

Type

str

name¶

The name

Type

str

description¶

The description

Type

str

min_length¶

The minimum string length

Type

int

max_length¶

The maximum string length

Type

int

default_value¶

The default value

Type

str

__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¶

The code

Type

str

name¶

The name

Type

str

description¶

The description

Type

str

min_value¶

The minimum value

Type

datetime.date

max_value¶

The maximum value

Type

datetime.date

default_value¶

The default value

Type

datetime.date

__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¶

The code

Type

str

name¶

The name

Type

str

description¶

The description

Type

str

min_value¶

The minimum value

Type

datetime.datetime

max_value¶

The maximum value

Type

datetime.datetime

default_value¶

The default value

Type

datetime.datetime

__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¶

The code

Type

str

name¶

The name

Type

str

description¶

The description

Type

str

__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¶

The code

Type

str

name¶

The name

Type

str

description¶

The description

Type

str

min_value¶

The minimum value

Type

float

max_value¶

The maximum value

Type

float

default_value¶

The default value

Type

float

__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¶

The code

Type

str

name¶

The name

Type

str

description¶

The description

Type

str

min_value¶

The minimum value

Type

int

max_value¶

The maximum value

Type

int

default_value¶

The default value

Type

int

__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¶

The code

Type

str

name¶

The name

Type

str

description¶

The description

Type

str

possible_values¶

The possible values

Type

dict(int, str)

default_value¶

The default value

Type

int

__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¶

The code

Type

str

name¶

The name

Type

str

description¶

The description

Type

str

default_value¶

The default value

Type

str

__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¶

The code

Type

str

name¶

The name

Type

str

description¶

The description

Type

str

min_value¶

The minimum value

Type

Quantity

max_value¶

The maximum value

Type

Quantity

default_value¶

The default value

Type

Quantity

__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¶

The code of the complex type

Type

str

name¶

The name of the complex type

Type

str

description¶

The description of the complex type

Type

str

attributes¶

The definitions of the attributes defined for this type

Type

AttributeDefinitionDictionary

__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¶

The code

Type

str

name¶

The name

Type

str

description¶

The description

Type

str

min_value¶

The minimum value

Type

Quantity

max_value¶

The maximum value

Type

Quantity

default_value¶

The default value

Type

Quantity

__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