pygrenade_vx.common.Vertex

class pygrenade_vx.common.Vertex

Bases: pybind11_builtins.pybind11_object

__init__(*args, **kwargs): Initialize self. See help(type(self)) for accurate signature.

Methods

`__init__`(args, *kwargs)	Initialize self.
`get_input_ports`(self)	Get the input ports of vertex.
`get_output_ports`(self)	Get the output port of vertex.
`get_strong_component_invariant`(self)	Get invariant of vertex which is required to be equal across its strong component.
`get_time_domain`(self)	Get identifier of time domain of vertex.
`valid`(self, time_domain_runtimes)
`valid_edge_from`(self, source, edge)	Get whether the edge from the source vertex to this vertex is valid.
`valid_edge_to`(self, target, edge)	Get whether the edge to the target vertex from this vertex is valid.
`valid_input_port_data`(self, …)	Get whether given data is valid for input port on vertex.
`valid_output_port_data`(self, …)	Get whether given data is valid for output port on vertex.

class Port

Bases: pybind11_builtins.pybind11_object

class ExecutionInstanceTransitionConstraint

Bases: pybind11_builtins.pybind11_object

Members:

not_supported

supported

required

property name

not_supported = <ExecutionInstanceTransitionConstraint.not_supported: 0>

required = <ExecutionInstanceTransitionConstraint.required: 2>

supported = <ExecutionInstanceTransitionConstraint.supported: 1>

property value

class RequiresOrGeneratesData

Bases: pybind11_builtins.pybind11_object

Members:

no

yes

property name

no = <RequiresOrGeneratesData.no: 0>

property value

yes = <RequiresOrGeneratesData.yes: 1>

class SumOrSplitSupport

Bases: pybind11_builtins.pybind11_object

Members:

no

yes

property name

no = <SumOrSplitSupport.no: 0>

property value

yes = <SumOrSplitSupport.yes: 1>

property execution_instance_transition_constraint

get_channels(self: pygrenade_common.Vertex.Port) → pygrenade_common.MultiIndexSequence: Get multi-index sequence of independent signal channels.

get_type(self: pygrenade_common.Vertex.Port) → pygrenade_common.VertexPortType: Get signal type.

property requires_or_generates_data

set_channels(self: pygrenade_common.Vertex.Port, value: pygrenade_common.MultiIndexSequence) → None: Set multi-index sequence of independent signal channels.

set_type(self: pygrenade_common.Vertex.Port, value: pygrenade_common.VertexPortType) → None: Set signal type.

property sum_or_split_support

class StrongComponentInvariant

Bases: pybind11_builtins.pybind11_object

copy(self: pygrenade_common.Vertex.StrongComponentInvariant) → pygrenade_common.Vertex.StrongComponentInvariant

move(self: pygrenade_common.Vertex.StrongComponentInvariant) → pygrenade_common.Vertex.StrongComponentInvariant

property time_domain

get_input_ports(self: pygrenade_common.Vertex) → list[pygrenade_common.Vertex.Port]: Get the input ports of vertex. The position of a port in the return value is used to encode the connectivity of an edge to a port.

get_output_ports(self: pygrenade_common.Vertex) → list[pygrenade_common.Vertex.Port]: Get the output port of vertex. The position of a port in the return value is used to encode the connectivity of an edge from a port.

get_strong_component_invariant(self: pygrenade_common.Vertex) → pygrenade_common.Vertex.StrongComponentInvariant: Get invariant of vertex which is required to be equal across its strong component.

get_time_domain(self: pygrenade_common.Vertex) → Optional[pygrenade_common.TimeDomainOnTopology]: Get identifier of time domain of vertex. All vertices onto the same time domain are expected to share the time dimension and are allowed to interact instantaneously with each other. If no time domain is returned, the vertices is offline without time dimension.

valid(self: pygrenade_common.Vertex, time_domain_runtimes: pygrenade_common.TimeDomainRuntimes) → bool

valid_edge_from(self: pygrenade_common.Vertex, source: pygrenade_common.Vertex, edge: grenade::common::Edge) → bool: Get whether the edge from the source vertex to this vertex is valid.

valid_edge_to(self: pygrenade_common.Vertex, target: pygrenade_common.Vertex, edge: grenade::common::Edge) → bool: Get whether the edge to the target vertex from this vertex is valid.

valid_input_port_data(self: pygrenade_common.Vertex, input_port_on_vertex: int, data: pygrenade_common.PortData) → bool: Get whether given data is valid for input port on vertex.

valid_output_port_data(self: pygrenade_common.Vertex, output_port_on_vertex: int, data: pygrenade_common.PortData) → bool: Get whether given data is valid for output port on vertex.