Skip to content

Index

The Entity class is the base for all simulated entity.

Bases: ABC

Source code in PyCloudSim\entity\v_entity.py 
 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
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
class Entity(ABC):
    _label: str
    _created_at: float
    _started_at: float
    _terminated_at: float
    _status: List[str]

    def __init__(
        self,
        label: Optional[str] = None,
        at: Union[int, float, Callable] = simulation.now,
        after: Optional[Entity | List[Entity]] = None,
    ):
        """The base class for all simulated entity

        Args:
            label (Optional[str], optional): short description of the entity. Defaults to None.
            at (Union[int, float, Callable], optional): when the entity should be created. Defaults to simulation.now.
            after (Optional[Entity  |  List[Entity]], optional): the entity must be created after. Defaults to None.
        """
        self._id = uuid4().int
        self._label = label if label else get_name()
        self._created_at = float()
        self._started_at = float()
        self._terminated_at = float()
        self._status = list()

        self._on_creation: Callable = lambda: None
        self._on_termination: Callable = lambda: None

        self._after = None
        if isinstance(after, list):
            self._after = [entity.terminator for entity in after]
        elif after is not None:
            self._after = after.terminator

        self._creator = Actor(
            at=at,
            after=self.after,
            action=self.creation,
            label=f"{self.__class__.__name__} {self.label} creation",
            priority=CREATION,
        )

        self._terminator = Actor(
            at=inf,
            action=self.__terminate,
            label=f"{self.__class__.__name__} {self.label} termination",
            active=False,
            priority=TERMINATION,
        )

    @abstractmethod
    def creation(self):
        """Creatation process of the entity."""
        self._created_at = simulation.now
        self.status.append(CREATED)
        LOGGER.info(
            f"{simulation.now:0.2f}:\t{self.__class__.__name__} {self.label} is created."
        )
        self.on_creation()

    @abstractmethod
    def termination(self):
        """Termination process of the entity."""
        pass

    def __terminate(self):
        if self.terminated:
            return
        LOGGER.info(
            f"{simulation.now:0.2f}:\t{self.__class__.__name__} {self.label} is terminated."
        )
        self._terminated_at = simulation.now
        self.status.append(TERMINATED)
        self.termination()
        self.on_termination()

    def terminate(self):
        """Terminate the entity."""
        if not self.created:
            raise RuntimeError(
                f"{simulation.now:0.2f}:\t{self.__class__.__name__} {self.label} is not created yet."
            )
        self.terminator.activate()

    @property
    def id(self) -> int:
        """The id of the entity."""
        return self._id

    @property
    def label(self) -> str:
        """The label of the entity."""
        return self._label

    @property
    def created_at(self) -> float:
        """The time when the entity is created."""
        return self._created_at

    @property
    def started_at(self) -> float:
        """The time when the entity is started."""
        return self._started_at

    @property
    def terminated_at(self) -> float:
        """The time when the entity is terminated."""
        return self._terminated_at

    @property
    def status(self) -> List[str]:
        """The status of the entity."""
        return self._status

    @property
    def created(self) -> bool:
        """Return True if the entity is created."""
        return CREATED in self._status

    @property
    def started(self) -> bool:
        """Return True if the entity is started."""
        return STARTED in self._status

    @property
    def terminated(self) -> bool:
        """Return True if the entity is terminated."""
        return TERMINATED in self._status

    @property
    def creator(self) -> Actor:
        """The creator of the entity."""
        return self._creator

    @property
    def terminator(self) -> Actor:
        """The terminator of the entity."""
        return self._terminator

    @property
    def after(self) -> Actor | List[Actor] | None:
        """The other enity that this entity must be created after."""
        return self._after

    @property
    def on_creation(self) -> Callable:
        """Callback function on creation process"""
        return self._on_creation

    @on_creation.setter
    def on_creation(self, func: Callable):
        self._on_creation = func

    @property
    def on_termination(self) -> Callable:
        """Callback function on termination process"""
        return self._on_termination

    @on_termination.setter
    def on_termination(self, func: Callable):
        self._on_termination = func

after: Actor | List[Actor] | None property

The other enity that this entity must be created after.

created: bool property

Return True if the entity is created.

created_at: float property

The time when the entity is created.

creator: Actor property

The creator of the entity.

id: int property

The id of the entity.

label: str property

The label of the entity.

on_creation: Callable property writable

Callback function on creation process

on_termination: Callable property writable

Callback function on termination process

started: bool property

Return True if the entity is started.

started_at: float property

The time when the entity is started.

status: List[str] property

The status of the entity.

terminated: bool property

Return True if the entity is terminated.

terminated_at: float property

The time when the entity is terminated.

terminator: Actor property

The terminator of the entity.

__init__(label=None, at=simulation.now, after=None)

The base class for all simulated entity

Parameters:

Name Type Description Default
label Optional[str]

short description of the entity. Defaults to None.

 None
at Union[int, float, Callable]

when the entity should be created. Defaults to simulation.now.

 now
after Optional[Entity | List[Entity]]

the entity must be created after. Defaults to None.

 None
Source code in PyCloudSim\entity\v_entity.py 
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
def __init__(
    self,
    label: Optional[str] = None,
    at: Union[int, float, Callable] = simulation.now,
    after: Optional[Entity | List[Entity]] = None,
):
    """The base class for all simulated entity

    Args:
        label (Optional[str], optional): short description of the entity. Defaults to None.
        at (Union[int, float, Callable], optional): when the entity should be created. Defaults to simulation.now.
        after (Optional[Entity  |  List[Entity]], optional): the entity must be created after. Defaults to None.
    """
    self._id = uuid4().int
    self._label = label if label else get_name()
    self._created_at = float()
    self._started_at = float()
    self._terminated_at = float()
    self._status = list()

    self._on_creation: Callable = lambda: None
    self._on_termination: Callable = lambda: None

    self._after = None
    if isinstance(after, list):
        self._after = [entity.terminator for entity in after]
    elif after is not None:
        self._after = after.terminator

    self._creator = Actor(
        at=at,
        after=self.after,
        action=self.creation,
        label=f"{self.__class__.__name__} {self.label} creation",
        priority=CREATION,
    )

    self._terminator = Actor(
        at=inf,
        action=self.__terminate,
        label=f"{self.__class__.__name__} {self.label} termination",
        active=False,
        priority=TERMINATION,
    )

creation() abstractmethod

Creatation process of the entity.

Source code in PyCloudSim\entity\v_entity.py 
73
74
75
76
77
78
79
80
81
@abstractmethod
def creation(self):
    """Creatation process of the entity."""
    self._created_at = simulation.now
    self.status.append(CREATED)
    LOGGER.info(
        f"{simulation.now:0.2f}:\t{self.__class__.__name__} {self.label} is created."
    )
    self.on_creation()

terminate()

Terminate the entity.

Source code in PyCloudSim\entity\v_entity.py 
 99
100
101
102
103
104
105
def terminate(self):
    """Terminate the entity."""
    if not self.created:
        raise RuntimeError(
            f"{simulation.now:0.2f}:\t{self.__class__.__name__} {self.label} is not created yet."
        )
    self.terminator.activate()

termination() abstractmethod

Termination process of the entity.

Source code in PyCloudSim\entity\v_entity.py 
83
84
85
86
@abstractmethod
def termination(self):
    """Termination process of the entity."""
    pass