de.hfu.anybeam.networkCore

## Class TransmissionEvent

- java.lang.Object
- - de.hfu.anybeam.networkCore.TransmissionEvent

-     public class TransmissionEvent
      extends java.lang.Object

  Displays the current state of an `AbstractTransmission` object
  Since:
    1.0
  Version:
    1.0
  Author:
    chrwuer

- - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `double` | `getAverageSpeed()` Returns the calculated average speed of the transmission in Bytes/second.
    `java.lang.Exception` | `getException()` Returns a `Exception` that may have occured while transmitting data.
    `double` | `getPercentDone()` Returns the percentage already done in range from 0 to 1.
    `java.lang.String` | `getResourceName()` Returns the name of the resource transmitted.
    `long` | `getTotalLength()` Returns the transmission's total length in byte.
    `AbstractTransmission` | `getTransmissionHandler()` Returns the `AbstractTransmission` which handles the transmission.
    `long` | `getTransmissionId()` Returns the unique transmission id of the transmission displayed by this event.
    `long` | `getTransmittedLength()` Returns the already transmitted length in byte.
    `boolean` | `isIndeterminate()` Returns if the transmision has an end or is a endess stream.

    - ### Methods inherited from class java.lang.Object

      `equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Method Detail

    - #### getTransmissionId

          public long getTransmissionId()

      Returns the unique transmission id of the transmission displayed by this event.
      Returns:
        the unique transmission id of the transmission displayed by this event

    - #### getTotalLength

          public long getTotalLength()

      Returns the transmission's total length in byte.
      Returns:
        the transmission's total length in byte

    - #### getTransmittedLength

          public long getTransmittedLength()

      Returns the already transmitted length in byte.
      Returns:
        the already transmitted length in byte

    - #### getResourceName

          public java.lang.String getResourceName()

      Returns the name of the resource transmitted.
      Returns:
        the name of the resource transmitted

    - #### getTransmissionHandler

          public AbstractTransmission getTransmissionHandler()

      Returns the `AbstractTransmission` which handles the transmission.
      Returns:
        the `AbstractTransmission` which handles the transmission

    - #### getPercentDone

          public double getPercentDone()

      Returns the percentage already done in range from 0 to 1.
      Returns:
        the percentage already done in range from 0 to 1

    - #### getException

          public java.lang.Exception getException()

      Returns a `Exception` that may have occured while transmitting data.
      Returns:
        a `Exception` that may have occured while transmitting data

    - #### isIndeterminate

          public boolean isIndeterminate()

      Returns if the transmision has an end or is a endess stream.
      Returns:
        true if the transmision has an end or is a endess stream, false otherwise

    - #### getAverageSpeed

          public double getAverageSpeed()

      Returns the calculated average speed of the transmission in Bytes/second.
      Returns:
        the calculated average speed of the transmission in Bytes/second