Did you know ... Search Documentation:
Pack logtalk -- logtalk-3.102.0/docs/apis/_sources/ccsds_aos_frames_4.rst.txt

.. index:: single: ccsds_aos_frames(FrameLength,InsertZoneLength,HasOCF,HasFECF) .. _ccsds_aos_frames/4:

.. rst-class:: right

object

ccsds_aos_frames(FrameLength,InsertZoneLength,HasOCF,HasFECF)

  • FrameLength - Fixed AOS transfer frame length in octets.
  • InsertZoneLength - Length in octets of the optional insert zone when present.
  • HasOCF - Boolean indicating if frames include the operational control field.
  • HasFECF - Boolean indicating if frames include the frame error control field. CCSDS advanced orbiting systems transfer frame parser and generator.

    | Availability: | logtalk_load(ccsds_frames(loader))

    | Author: Paulo Moura | Version: 1:0:2 | Date: 2026-06-24

    | Compilation flags: | static, context_switching_calls

    | Implements: | public :ref:`ccsds_frame_protocol <ccsds_frame_protocol/0>` | Uses: | :ref:`list <list/0>` | :ref:`reader <reader/0>` | :ref:`type <type/0>`

    | Remarks: | (none)

    | Inherited public predicates: | Â :ref:ccsds_frame_protocol/0::data_field/2 Â :ref:ccsds_frame_protocol/0::fecf/2 Â :ref:ccsds_frame_protocol/0::frame_type/2 Â :ref:ccsds_frame_protocol/0::generate/2 Â :ref:ccsds_frame_protocol/0::generate/3 Â :ref:ccsds_frame_protocol/0::ocf/2 Â :ref:ccsds_frame_protocol/0::parse/2 Â :ref:ccsds_frame_protocol/0::spacecraft_id/2 Â :ref:ccsds_frame_protocol/0::valid/1 Â :ref:ccsds_frame_protocol/0::version/2 Â :ref:ccsds_frame_protocol/0::virtual_channel_id/2 Â

    .. contents:: :local: :backlinks: top

Public predicates

.. index:: virtual_channel_frame_count/2 .. _ccsds_aos_frames/4::virtual_channel_frame_count/2:

virtual_channel_frame_count/2 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Extracts the virtual channel frame count.

| Compilation flags: | static

| Template: | virtual_channel_frame_count(Frame,Count) | Mode and number of proofs: | virtual_channel_frame_count(+compound,-integer) - one


.. index:: signaling_field/2 .. _ccsds_aos_frames/4::signaling_field/2:

signaling_field/2 ^^^^^^^^^^^^^^^^^^^^^

Extracts the signaling field term.

| Compilation flags: | static

| Template: | signaling_field(Frame,SignalingField) | Mode and number of proofs: | signaling_field(+compound,-compound) - one


.. index:: insert_zone/2 .. _ccsds_aos_frames/4::insert_zone/2:

insert_zone/2 ^^^^^^^^^^^^^^^^^

Extracts the optional insert zone. Returns none when absent.

| Compilation flags: | static

| Template: | insert_zone(Frame,InsertZone) | Mode and number of proofs: | insert_zone(+compound,-compound) - one


.. index:: update_fecf/2 .. _ccsds_aos_frames/4::update_fecf/2:

update_fecf/2 ^^^^^^^^^^^^^^^^^

Computes the correct AOS transfer frame FECF for the selected object configuration and returns the corresponding updated frame term.

| Compilation flags: | static

| Template: | update_fecf(Frame,UpdatedFrame) | Mode and number of proofs: | update_fecf(+compound,-compound) - one_or_error

| Exceptions: | Frame is a variable: | instantiation_error | Frame is neither a variable nor a valid AOS transfer frame term: | domain_error(ccsds_frame_term,Frame)


.. index:: verify_fecf/1 .. _ccsds_aos_frames/4::verify_fecf/1:

verify_fecf/1 ^^^^^^^^^^^^^^^^^

True if the AOS transfer frame term contains the correct FECF for the selected object configuration.

| Compilation flags: | static

| Template: | verify_fecf(Frame) | Mode and number of proofs: | verify_fecf(@compound) - zero_or_one


Protected predicates

(no local declarations; see entity ancestors if any)

Private predicates

(no local declarations; see entity ancestors if any)

Operators

(none)