Class OscSender

  • All Implemented Interfaces:
    java.lang.Cloneable, Actor, Executable, FiringsRecordable, Initializable, TypedActor, Changeable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable

    public class OscSender
    extends TypedAtomicActor
    An actor that generates Open Sound Control (OSC) Messages via the provided input ports.

    Add input ports to this actor and name the ports to match the desired tag name. Any token received via an input port will have a tag equal to the name. A tag prefix common to all ports can be defined by the help of the tagPrefix PortParameter. If specified, this prefix will be prepended to all the tags, defined by the port names.

    Tokens that are received simultaneously at multiple input ports, i.e., that have the same time stamp, will be bundled into a single OSCBundle object and will be sent out as a single OSC message.

    Since:
    Ptolemy II 10.0
    Version:
    $Id$, $Id$
    Author:
    Ilge Akkaya
    See Also:
    OscReceiver
    Pt.AcceptedRating:
    Pt.ProposedRating:
    Red (ilgea)
    • Field Detail

      • remoteHost

        public Parameter remoteHost
        IP Address of the remote host.
      • remotePort

        public Parameter remotePort
        Remote port to which the OSC messages will be sent to.
      • localPort

        public Parameter localPort
        Local port from which the OSC messages will be sent.
      • tagPrefix

        public PortParameter tagPrefix
        OSC prefix tag that will be prepended to each port name.
    • Method Detail

      • attributeChanged

        public void attributeChanged​(Attribute attribute)
                              throws IllegalActionException
        Description copied from class: NamedObj
        React to a change in an attribute. This method is called by a contained attribute when its value changes. In this base class, the method does nothing. In derived classes, this method may throw an exception, indicating that the new attribute value is invalid. It is up to the caller to restore the attribute to a valid value if an exception is thrown.
        Overrides:
        attributeChanged in class NamedObj
        Parameters:
        attribute - The attribute that changed.
        Throws:
        IllegalActionException - If the change is not acceptable to this container (not thrown in this base class).
      • wrapup

        public void wrapup()
                    throws IllegalActionException
        Description copied from class: AtomicActor
        Do nothing except invoke the wrapup() methods of any objects that have been registered with addInitializable(). Derived classes override this method to define operations to be performed exactly once at the end of a complete execution of an application. It typically closes files, displays final results, etc.
        Specified by:
        wrapup in interface Initializable
        Overrides:
        wrapup in class AtomicActor<TypedIOPort>
        Throws:
        IllegalActionException - Not thrown in this base class.