Interface TransceiverInterface

    • Method Detail

      • getAddressFields

        MetaData getAddressFields()
        Specification of arguments needed in a request.
        Returns:
        MetaData; the specification of arguments needed in a request
      • getIdSource

        default TransceiverInterface getIdSource​(int addressLevel,
                                                 ReturnWrapper returnWrapper)
                                          throws Sim0MQException,
                                                 SerializationException
        Retrieve the TransceiverInterface that can be used to get detailed information about a single object.
        Parameters:
        addressLevel - int; index of the argument in the address fields
        returnWrapper - ReturnWrapper; to be used to report problems
        Returns:
        TransceiverInterface; to be used to get valid values for argument addressLevel, or null if valid values for the argument at index addressLevel can not be obtained through a TransceiverInterface object
        Throws:
        SerializationException - when the ReturnWrapper fails
        Sim0MQException - when the ReturnWrapper fails
      • hasIdSource

        default boolean hasIdSource()
        Report if this transceiver has an id source.
        Returns:
        boolean; true if this transceiver has an id source; false if this transceiver does not have an id source
      • getResultFields

        MetaData getResultFields()
        Report the specification of a result of the transceiver.
        Returns:
        MetaData; the specification of a result from the transceiver
      • get

        java.lang.Object[] get​(java.lang.Object[] address,
                               ReturnWrapper returnWrapper)
                        throws java.rmi.RemoteException,
                               Sim0MQException,
                               SerializationException
        Retrieve the data.
        Parameters:
        address - Object[]; the address of the data to retrieve
        returnWrapper - ReturnWrapper; to be used to report problems
        Returns:
        Object[]; the retrieved data, or null when no object with the address could be found
        Throws:
        java.rmi.RemoteException - when communication needed to retrieve the data failed
        SerializationException - when encoding an error message fails
        Sim0MQException - when encoding an error message fails