Base class to represent an active entity in a manufacturing system,
such as machines, splits, or joints.
| Parameters: |
-
id
(str)
–
-
node_setup_time
(int, or float, default:
0
)
–
Initial setup time for the node. Can be:
- int or float: Used as a constant delay.
-
in_edges
(list, default:
None
)
–
List of input edges connected to the node.
-
out_edges
(list, default:
None
)
–
List of output edges connected to the node.
|
| Raises: |
-
TypeError
–
If the type of env or id is incorrect.
-
ValueError
–
If node_setup_time input is invalid.
|
Source code in src/factorysimpy/nodes/node.py
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42 | def __init__(self,env,id, in_edges = None, out_edges = None, node_setup_time= 0):
# Type checks
if not isinstance(env, simpy.Environment):
raise TypeError("env must be a simpy.Environment instance")
if not isinstance(id, str):
raise TypeError("name must be a string")
self.env = env
self.id = id # Identifier for the node.
self.node_setup_time = node_setup_time # Time taken to set up the node.
self.in_edges = in_edges # List of input edges connected to the node.
self.out_edges = out_edges #List of output edges connected to the node.
if isinstance(node_setup_time, (int, float)):
self.node_setup_time = node_setup_time
else:
raise ValueError(
"Invalid node_setup_time value. Provide constant ( int or float)."
)
|
get_delay(delay)
Returns value based on the type of parameter delay provided.
| Parameters: |
-
delay
(int, float, generator, or callable)
–
The delay time, which can be:
- int or float: Used as a constant delay.
- generator: A generator instance yielding delay values.
- callable: A function that returns a delay values.
|
| Returns: |
-
–
Returns a constant delay if delay is an int or float, a value yielded if delay is a generator, or the value returned from a Callable function if delay is callable.
|
Source code in src/factorysimpy/nodes/node.py
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 | def get_delay(self,delay):
"""
Returns value based on the type of parameter `delay` provided.
Args:
delay (int, float, generator, or callable): The delay time, which can be:
- int or float: Used as a constant delay.
- generator: A generator instance yielding delay values.
- callable: A function that returns a delay values.
Returns:
Returns a constant delay if `delay` is an int or float, a value yielded if `delay` is a generator, or the value returned from a Callable function if `delay` is callable.
"""
if hasattr(delay, '__next__'):
# Generator instance
val = next(delay)
elif callable(delay):
# Function
val = delay()
else:
# int or float
val = delay
#print(self.id)
assert val >= 0, f"{self.id}- Delay must be non-negative"
return val
|
update_state(new_state, current_time)
Update node state and track the time spent in the previous state.
| Parameters: |
-
new_state
(str)
–
The new state to transition to. Must be one of "SETUP_STATE", "GENERATING_STATE", "BLOCKED_STATE".
-
current_time
(float)
–
The current simulation time.
|
Source code in src/factorysimpy/nodes/node.py
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89 | def update_state(self, new_state: str, current_time: float):
"""
Update node state and track the time spent in the previous state.
Args:
new_state (str): The new state to transition to. Must be one of "SETUP_STATE", "GENERATING_STATE", "BLOCKED_STATE".
current_time (float): The current simulation time.
"""
if self.state is not None and self.stats["last_state_change_time"] is not None:
elapsed = current_time - self.stats["last_state_change_time"]
self.stats["total_time_spent_in_states"][self.state] = (
self.stats["total_time_spent_in_states"].get(self.state, 0.0) + elapsed
)
self.state = new_state
self.stats["last_state_change_time"] = current_time
|