.. _`Publisher Block`:



###############
Publisher Block
###############

The Publisher block represents a DDS publisher entity.

In DDS, a publisher is "an object responsible for data distribution.  It may publish data of different data types."

This block is optional on a DDS Simulink model diagram.    If it is not present on a model diagram, each writer will create a default publisher.

.. figure:: images/publisher_block.png 
        :alt: DDS Publisher Block



=========== ========= ======= =========================== ====================
  Port Type  Optional Name    Description                 Output consumed by
=========== ========= ======= =========================== ====================
Input       yes       pp      DDS Domain Participant      
                              entity instance             
Output      no        ppub    DDS Publisher entity        Writer
                              instance   
=========== ========= ======= =========================== ====================


Publisher Block Parameters
**************************

.. figure:: images/publisher_block_parameters.png 
        :alt: Publisher Block Parameters 

Ports Tab
=========
The **Ports** tab allows the user to toggle on or off optional ports.

QoS Tab
=======
The **QoS** tab is used to set the QoS profile.   By default, the OSPL default profile is used.

In DDS - The Data-Distribution Service (DDS) relies on the usage of QoS.  A QoS (Quality of Service) is a set of characteristics that controls some aspect of the behavior of the DDS Service.

Each DDS block has an associated QoS profile.   By default, the OSPL default profile is used.  An XML file that specifies QoS profiles can be used to set the QoS of a DDS block.

.. raw:: latex

    \newpage

.. _`Pub-Override-Partition`:

**Override Partition**

The **QoS** tab is also used to override the partition name of the Publisher QoS. By default, the **Override Partition** field is not selected and the partition name given in the QoS provider file is used.

.. figure:: images/publisher_qos_partition_set.png 
        :alt: Publisher Block Parameters : Override Partition QoS

Checking the **Override Partition** field specifies that it will override the partition name of the Publisher QoS.

The **Partition Name(s)** field is for providing comma separated strings for partition names. Leaving it empty means the partition name will be set to the default value.