pathsim.utils.portreference module

class pathsim.utils.portreference.PortReference(block=None, ports=None)

Bases: object

Container class that holds a reference to a block and a list of ports. Optimized with cached integer indices for ultra-fast transfers.

Note

The default port, when no ports are defined in the arguments is 0.

Parameters:

• block (Block) – internal block reference

• ports (list[int, str]) – list of port indices or names

block

ports

to(other)

Transfer the data between two PortReference instances, in this direction self -> other. From outputs to inputs.

Uses numpy fancy indexing with cached integer indices.

Parameters:

other (PortReference) – the PortReference instance to transfer data to from self

get_inputs()

Return the input values of the block at specified ports

Returns:

out – input values of block

Return type:

numpy.ndarray

set_inputs(vals)

Set the block inputs with values at specified ports

Parameters:

vals (array-like) – values to set at block input ports

get_outputs()

Return the output values of the block at specified ports

Returns:

out – output values of block

Return type:

numpy.ndarray

set_outputs(vals)

Set the block outputs with values at specified ports

Parameters:

vals (array-like) – values to set at block output ports

to_dict()

Serialization into dict