def out_strm_list(self):
# type: () -> typing.Iterable[_frame.Frame]
'''Output Stream List.
The Output Stream List property provides a list of frames for use with
the replay feature (:any:`out_strm_timng` property set to
:any:`OutStrmTimng` ``REPLAY_EXCLUSIVE`` or ``REPLAY_INCLUSIVE``). In
Replay Exclusive mode, the hardware transmits only frames that do not
appear in the list. In Replay Inclusive mode, the hardware transmits
only frames that appear in the list. For a LIN interface, the header of
each frame written to stream output is transmitted, and the Exclusive
or Inclusive mode controls the response transmission. Using these
modes, you can either emulate an ECU (Replay Inclusive, where the list
contains the frames the ECU transmits) or test an ECU (Replay
Exclusive, where the list contains the frames the ECU transmits), or
some other combination.
This property's data type is an array of database handles to frames. If
you are not using a database file or prefer to specify the frames using
CAN arbitration IDs or LIN unprotected IDs, you can use
Interface:Output Stream List By ID instead of this property.
.. note:: Only CAN and LIN interfaces currently support this property.
'''
for ref in _props.get_session_intf_out_strm_list(self._handle):
yield _frame.Frame(ref)
def tx_frms(self):
# type: () -> typing.Iterable[_frame.Frame]
"""list of :any:`Frame<_frame.Frame>`: Get or set a list of frames the ECU transmits.
This property defines all frames the ECU transmits.
All frames an ECU transmits in a given cluster must be defined in the same cluster.
"""
for ref in _props.get_ecu_tx_frm_refs(self._handle):
yield _frame.Frame(_handle=ref)
def frm(self):
# type: () -> _frame.Frame
""":any:`Frame<_frame.Frame>`: Returns the reference to the parent frame.
The parent frame is defined when the subframe is created,
and you cannot change it afterwards.
"""
handle = _props.get_subframe_frm_ref(self._handle)
return _frame.Frame(_handle=handle)
def frame(self):
# type: () -> _frame.Frame
""":any:`Frame<_frame.Frame>`: Returns the signal parent frame object.
The parent frame is defined when the signal object is created. You cannot change it afterwards.
"""
from nixnet.database import _frame # NOQA: F811
ref = _props.get_signal_frame_ref(self._handle)
return _frame.Frame(_handle=ref)
def frms(self):
# type: () -> typing.Iterable[_frame.Frame]
"""list of :any:`Frame<_frame.Frame>`: Returns a list of all frames to which the PDU is mapped.
A PDU is transmitted within the frames to which it is mapped.
To map a PDU to a frame,
use the :any:`Frame.pdu_properties` property.
You can map one PDU to multiple frames.
"""
for handle in _props.get_pdu_frm_refs(self._handle):
yield _frame.Frame(_handle=handle)
def frames(self):
# type: () -> typing.Iterable[_frame.Frame]
"""list of :any:`Frame<_frame.Frame>`: Get or set a list of frames for this LIN schedule entry.
If :any:`LinSchedEntry.type` is ``UNCONDITIONAL``,
this list contains one frame,
which is the single unconditional frame for this entry.
If :any:`LinSchedEntry.type` is ``SPORADIC``,
this list contains one or more unconditional frames for this entry.
When multiple frames are pending for this entry,
the order in the list determines the priority to transmit.
If :any:`LinSchedEntry.type` is ``EVENT_TRIGGERED``,
this list contains one or more unconditional frames for this entry.
When multiple frames for this entry are pending to be sent by distinct slaves,
this property uses the :any:`LinSchedEntry.collision_res_sched` to process the frames.
"""
for ref in _props.get_lin_sched_entry_frames(self._handle):
yield _frame.Frame(_handle=ref)
def frames(self):
# type: () -> typing.Iterable[_frame.Frame]
for ref in _props.get_lin_sched_entry_frames(self._handle):
yield _frame.Frame(ref)