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

Enum FirmwareDescriptors

java.lang.Object

java.lang.Enum<FirmwareDescriptors>

uk.ac.manchester.spinnaker.messages.model.FirmwareDescriptors

All Implemented Interfaces:

Serializable, Comparable<FirmwareDescriptors>

public enum FirmwareDescriptors
extends Enum<FirmwareDescriptors>

Basic information about firmware.

Enum Constant Summary

Enum Constants

Enum Constant	Description
Backup	The backup firmware copy.
Boot	The firmware used for booting.
Primary	The main firmware copy.

Field Summary

Fields

Modifier and Type	Field	Description
MemoryLocation	address	The location of the firmware descriptor in BMP memory.
int	blockSize	The amount of data to read to understand the firmware.
int	timestampIndex	The index of the timestamp in the header block.
int	versionIndex	The index of the version in the header block.

Method Summary

Modifier and Type	Method	Description
static FirmwareDescriptors	valueOf(String name)	Returns the enum constant of this type with the specified name.
static FirmwareDescriptors[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

Primary

public static final FirmwareDescriptors Primary

The main firmware copy.

Backup

public static final FirmwareDescriptors Backup

The backup firmware copy.

Boot

public static final FirmwareDescriptors Boot

The firmware used for booting.

Field Details

address

public final MemoryLocation address

The location of the firmware descriptor in BMP memory.

blockSize

public final int blockSize

The amount of data to read to understand the firmware. The size of the firmware's header block.

versionIndex

public final int versionIndex

The index of the version in the header block.

timestampIndex

public final int timestampIndex

The index of the timestamp in the header block.

Method Details

values

public static FirmwareDescriptors[] values()

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

Returns:

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

valueOf

public static FirmwareDescriptors valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null