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

Enum Class SARKStruct.API

java.lang.Object

java.lang.Enum<SARKStruct.API>

uk.ac.manchester.spinnaker.messages.model.SARKStruct.API

All Implemented Interfaces:

Serializable, Comparable<SARKStruct.API>, Constable

Enclosing class:

SARKStruct

public static enum SARKStruct.API
extends Enum<SARKStruct.API>

The supported APIs for mapped structures.

Author:

Donal Fellows

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
BMP	This identifies a structure defined by the BMP.
SARK	This identifies a structure defined by SARK.
SCAMP	This identifies a structure defined by SC&MP.
SPIN1API	This identifies a structure defined by spin1_api.

Method Summary

Modifier and Type	Method	Description
static SARKStruct.API	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SARKStruct.API[]	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

SARK

public static final SARKStruct.API SARK

This identifies a structure defined by SARK.

SCAMP

public static final SARKStruct.API SCAMP

This identifies a structure defined by SC&MP.

SPIN1API

public static final SARKStruct.API SPIN1API

This identifies a structure defined by spin1_api.

BMP

public static final SARKStruct.API BMP

This identifies a structure defined by the BMP.

Method Details

values

public static SARKStruct.API[] 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 SARKStruct.API 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