Skip to content

DimensionField class

Bases: FieldValidator[int]

A descriptor used to validate dimensions in an optimization model.

The DimensionField class is a field validator specifically designed for model's dimension fields. It ensures that the dimension value is within specified bounds and is an integer number. It allows setting minimum and maximum limits for the dimension.

This class is a subclass of FieldValidator and inherits its functionality for validating and formatting field values.

Source code in pyorlib/validators/fields/dimension_field.py 
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
class DimensionField(FieldValidator[int]):
    """
    A descriptor used to validate dimensions in an optimization model.

    The `DimensionField` class is a field validator specifically designed for model's dimension fields. It ensures that
    the dimension value is within specified bounds and is an integer number. It allows setting minimum and maximum
    limits for the dimension.

    This class is a subclass of `FieldValidator` and inherits its functionality for validating and formatting field
    values.
    """

    __slots__ = ["_min", "_max"]

    @property
    def min(self) -> int | None:
        """
        Get the minimum value allowed.
        :return: The minimum value or None if not set.
        """
        return self._min

    @property
    def max(self) -> int | None:
        """
        Get the maximum value allowed.
        :return: The maximum value or None if not set.
        """
        return self._max

    def __init__(self, min: int | None = None, max: int | None = None):
        """
        Initialize a new DimensionField instance.
        :param min: The minimum value allowed for the dimension field. Defaults to None.
        :param max: The maximum value allowed for the dimension field. Defaults to None.
        """
        # Calls the base init method
        super().__init__()

        # Applies validations
        if min is not None and not ValueTypeValidator.is_integer(min):
            raise ValueError(f"{self._public_name} 'min' value must be an integer number.")

        if max is not None and not ValueTypeValidator.is_integer(max):
            raise ValueError(f"{self._public_name} 'max' value must be an integer number.")

        if min is not None and min < 0:
            raise ValueError(f"{self._public_name} 'min' value must be greater than or equal to 0.")

        if max is not None and min is not None and min > max:
            raise ValueError(f"{self._public_name} 'min' value cannot be greater than maximum.")

        # Instance attributes
        self._min: int | None = min
        self._max: int | None = max

    def validate(self, value: int | None) -> None:
        if value is None:
            raise ValueError(f"{self._public_name} value cannot be None.")

        if not ValueTypeValidator.is_integer(value):
            raise ValueError(f"{self._public_name} value must be an integer number.")

        if self._min is not None and value < self._min:
            raise ValueError(f"{self._public_name} value must be greater than or equal to {self._min}.")

        if self._max is not None and value > self._max:
            raise ValueError(f"{self._public_name} value must be less than or equal to {self._max}.")

Attributes

min property 

min: int | None

Get the minimum value allowed.

RETURNS DESCRIPTION
int | None

The minimum value or None if not set.

max property 

max: int | None

Get the maximum value allowed.

RETURNS DESCRIPTION
int | None

The maximum value or None if not set.

Functions

__init__ 

__init__(min: int | None = None, max: int | None = None)

Initialize a new DimensionField instance.

PARAMETER DESCRIPTION
min

The minimum value allowed for the dimension field. Defaults to None.

TYPE: int | None DEFAULT: None

max

The maximum value allowed for the dimension field. Defaults to None.

TYPE: int | None DEFAULT: None

Source code in pyorlib/validators/fields/dimension_field.py 
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
def __init__(self, min: int | None = None, max: int | None = None):
    """
    Initialize a new DimensionField instance.
    :param min: The minimum value allowed for the dimension field. Defaults to None.
    :param max: The maximum value allowed for the dimension field. Defaults to None.
    """
    # Calls the base init method
    super().__init__()

    # Applies validations
    if min is not None and not ValueTypeValidator.is_integer(min):
        raise ValueError(f"{self._public_name} 'min' value must be an integer number.")

    if max is not None and not ValueTypeValidator.is_integer(max):
        raise ValueError(f"{self._public_name} 'max' value must be an integer number.")

    if min is not None and min < 0:
        raise ValueError(f"{self._public_name} 'min' value must be greater than or equal to 0.")

    if max is not None and min is not None and min > max:
        raise ValueError(f"{self._public_name} 'min' value cannot be greater than maximum.")

    # Instance attributes
    self._min: int | None = min
    self._max: int | None = max

validate 

validate(value: int | None) -> None
Source code in pyorlib/validators/fields/dimension_field.py 
61
62
63
64
65
66
67
68
69
70
71
72
def validate(self, value: int | None) -> None:
    if value is None:
        raise ValueError(f"{self._public_name} value cannot be None.")

    if not ValueTypeValidator.is_integer(value):
        raise ValueError(f"{self._public_name} value must be an integer number.")

    if self._min is not None and value < self._min:
        raise ValueError(f"{self._public_name} value must be greater than or equal to {self._min}.")

    if self._max is not None and value > self._max:
        raise ValueError(f"{self._public_name} value must be less than or equal to {self._max}.")