Floe Ports

Copyright (C) 2023 Cadence Design Systems, Inc. (Cadence)

class floe.api.ports.BinaryInputPort(name=None, title=None, required=False, initializer=False, cube=None)

class floe.api.ports.BinaryOutputPort(name=None, title=None, required=False, initializer=False, cube=None)

class floe.api.ports.BinaryPortSerializer(name=None, title=None, required=False, initializer=False, cube=None)

A Port that only uses bytes

class floe.api.ports.InputPort(name=None, title=None, required=False, initializer=False, cube=None)

An input port

connect(dest_port)

Connections are made source => dest NOT dest <= source

class floe.api.ports.JsonInputPort(name=None, title=None, required=False, initializer=False, cube=None)

class floe.api.ports.JsonOutputPort(name=None, title=None, required=False, initializer=False, cube=None)

class floe.api.ports.JsonPortSerializer(name=None, title=None, required=False, initializer=False, cube=None)

A Port that only uses JSON, requires all string data to be of the same type

class floe.api.ports.OutputPort(name=None, title=None, required=False, initializer=False, cube=None)

An output port

class floe.api.ports.Port(name=None, title=None, required=False, initializer=False, cube=None)

A base class for Ports

connected()

Returns True if this port has been connected

emit(data)

To be implemented in a derived class, should handle the emitting of one item

neighbors()

Returns the cube, port tuple on the other end of this port

floe.api.ports.connect_port(src_port, dest_port)

Connects this port to another