Package org.hlacerti.lib

Interface HlaReflectable

  • All Superinterfaces:
    Nameable
    All Known Implementing Classes:
    HlaAttributeReflector, HlaSubscriber
    public interface HlaReflectable
extends Nameable
    FIXME
    Since:
    Ptolemy II 11.0
    Version:
    $Id: HlaPublisher.java 214 2018-04-01 13:32:02Z j.cardoso $
    Author:
    Janette Cardoso and Edward A. Lee
    Pt.AcceptedRating:
    Red (glasnier)
    Pt.ProposedRating:
    Yellow (glasnier)

    • Method Detail

      • getAttributeHandle

        int getAttributeHandle()
        Return the HLA attribute handle.
        Returns:
        The HLA attribute handle.

      • getClassHandle

        int getClassHandle()
        Return the HLA class handle.
        Returns:
        the HLA class handle.

      • getInstanceHandle

        int getInstanceHandle()
        Returns the HLA object instance handle.
        Returns:
        The HLA object instance handle.

      • getOutputPort

        TypedIOPort getOutputPort()
        FIXME: This should probably not be here. See HlaManager.

      • setAttributeHandle

        void setAttributeHandle​(int attributeHandle)
        Set the HLA attribute handle.
        Parameters:
        attributeHandle - The attributeHandle to set.

      • setClassHandle

        void setClassHandle​(int classHandle)
        Set the HLA class handle.
        Parameters:
        classHandle - The classHandle to set.

      • setInstanceHandle

        void setInstanceHandle​(int instanceHandle)
        Set the HLA object instance handle only when wildcard (joker_) is used.
        Parameters:
        instanceHandle - The HLA object instance to set.

      • putReflectedHlaAttribute

        void putReflectedHlaAttribute​(HlaTimedEvent event)
                       throws IllegalActionException
        Store each updated value of the HLA attribute (mapped to this actor) in the token queue. Then, program the next firing time of this actor to send the token at its expected time. This method is called by the HlaManager attribute.
        Parameters:
        event - The event containing the new value of the HLA attribute and its time-stamp.
        Throws:
        IllegalActionException - Not thrown here.

      • getHlaAttributeName

        java.lang.String getHlaAttributeName()
                              throws IllegalActionException
        Return the value of the attributeName parameter.
        Returns:
        The value of the attributeName parameter.
        Throws:
        IllegalActionException - If the class name is empty.

      • getHlaClassName

        java.lang.String getHlaClassName()
                          throws IllegalActionException
        Return the value of the className parameter.
        Returns:
        The value of the className parameter.
        Throws:
        IllegalActionException - If the class name is empty.

      • getHlaInstanceName

        java.lang.String getHlaInstanceName()
                             throws IllegalActionException
        Return the value of the instanceName parameter.
        Returns:
        The value of the instanceName parameter.
        Throws:
        IllegalActionException - If the class name is empty.

      • useCertiMessageBuffer

        boolean useCertiMessageBuffer()
        Indicate if the HLA publisher actor uses the CERTI message buffer API.
        Returns:
        true if the HLA publisher actor uses the CERTI message and false if it doesn't.