Package uk.ac.manchester.spinnaker.messages.model

Enum Class TransferUnit

java.lang.Object

java.lang.Enum<TransferUnit>

uk.ac.manchester.spinnaker.messages.model.TransferUnit

All Implemented Interfaces:

Serializable, Comparable<TransferUnit>, Constable

public enum TransferUnit
extends Enum<TransferUnit>

What to move data in units of.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BYTE	A byte.
HALF_WORD	Two bytes.
WORD	Four bytes.

Field Summary

Fields

Modifier and Type	Field	Description
final int	value	The encoded transfer unit.

Method Summary

Modifier and Type	Method	Description
static TransferUnit	efficientTransferUnit(MemoryLocation address, int size)	What is an efficient transfer unit to use, given a starting address and a size of data to move.
static TransferUnit	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TransferUnit[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BYTE

public static final TransferUnit BYTE

A byte.

HALF_WORD

public static final TransferUnit HALF_WORD

Two bytes.

WORD

public static final TransferUnit WORD

Four bytes.

Field Details

value

public final int value

The encoded transfer unit.

Method Details

values

public static TransferUnit[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static TransferUnit valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

efficientTransferUnit

public static TransferUnit efficientTransferUnit(MemoryLocation address,
 int size)

What is an efficient transfer unit to use, given a starting address and a size of data to move.

Parameters:

address - The address.

size - The data size.

Returns:

The preferred transfer unit.