Communication Provider Interface (i_communication_provider)

class pypint.communicators.i_communication_provider.ICommunicationProvider(*args, **kwargs)[source]

Bases: builtins.object

Interface for communication providers

Notes

This communication interface uses buffered communication.

__init__(*args, **kwargs)[source]
Parameters:buffer (Message) – initial buffer
Raises:ValueError – if buffer is not a Message

Linking the specified communicators with this one

Notes

Behaviour is implementation dependent.

receive(*args, **kwargs)[source]

Receiving data from a specified communicator

Notes

Behaviour is implementation dependent.

send(*args, **kwargs)[source]

Sending data to a specified communicator

Notes

Behaviour is implementation dependent.

write_buffer(tag=None, **kwargs)[source]

Writes data into this communicator’s buffer

Parameters:
  • value – data values to be send to the next solver
  • time_point (float) – time point of the data values
  • flag (Message.SolverFlag) – message flag
Raises:

ValueError –

  • if no arguments are given
  • if time_point is not a float
__weakref__

list of weak references to the object (if defined)

buffer[source]

Read-only accessor for this communicator’s buffer

Returns:buffer
Return type:Message