Package org.hlacerti.lib

Class HlaPublisher

  • All Implemented Interfaces:
    java.lang.Cloneable, HlaUpdatable, Actor, Executable, FiringsRecordable, Initializable, TypedActor, Changeable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable
    public class HlaPublisher
extends TypedAtomicActor
implements HlaUpdatable
    This actor provides updates to shared objects in an HLA (High Level Architecture) federation. The shared objects are are instances of classes defined in a FED file (Federation Execution Data). Each class has attributes, and this actor sends updates to an attribute of an instance of a class when it receives data on its input. If there are instances of HlaSubscriber that refer to the same attribute of the same instance, then those will be notified of the update. The HlaSubscriber will produce an output event with the same data and a time stamp that depends on the time management parameters of the HlaManager. This actor requires that there be an instance of HlaManager in the same model. That instance references the FED file that is required to define the class referred to in this HlaPublisher, and that class is required to have an attribute with a name matching the name given here. The name of the instance is arbitrary. If an instance with the specified name does not already exist, it will be created during initialization of the model. If two instances of this HlaPublisher actor refer to the same instance name, then they will send updates to the same HLA instance, but they are required to update distinct attributes of that instance. During initialization, the HlaManager will notify the RTI (Run Time Infrastructure) of the intent to update this particular attribute of this particular instance of the class. This actor throws an exception if the attribute name or the class name or the instance name is empty. An exception is also thrown if the class name or the attribute name is not defined in the FED file.

    Since:
    Ptolemy II 11.0
    Version:
    $Id: HlaPublisher.java 214 2018-04-01 13:32:02Z j.cardoso $
    Author:
    Gilles Lasnier, Contributors: Patricia Derler, David Come
    Pt.AcceptedRating:
    Red (glasnier)
    Pt.ProposedRating:
    Yellow (glasnier)

    • Field Detail

      • attributeName

        public Parameter attributeName
        The HLA attribute name the HLASubscriber is mapped to.

      • classObjectName

        public Parameter classObjectName
        The object class of the HLA attribute to publish.

      • classInstanceName

        public Parameter classInstanceName
        The name of the HLA class instance for this HlaSubscriber.

      • useCertiMessageBuffer

        public Parameter useCertiMessageBuffer
        Indicate if the event is wrapped in a CERTI message buffer.