ptolemy.domains.sequence.lib

Enum SequencedSharedMemoryActor.Scope

java.lang.Object

java.lang.Enum<SequencedSharedMemoryActor.Scope>

ptolemy.domains.sequence.lib.SequencedSharedMemoryActor.Scope

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SequencedSharedMemoryActor.Scope>

Enclosing class:

SequencedSharedMemoryActor

static enum SequencedSharedMemoryActor.Scope
extends java.lang.Enum<SequencedSharedMemoryActor.Scope>

An enumeration that represents the scope of the memory element. The are three options: Local, Imported, and Exported. This information can be read from the ASCET model. In Ptolemy, the scope is determined by the location in the hierarchy. In Ptolemy, Imported and Exported will both treated as global scope - parameter will be created at the top level. This enumeration also has a generic GLOBAL option, which can be used for actors created in Ptolemy where Imported/Exported have no meaning.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXPORTED Exported scope (treated as global).
GLOBAL Global scope.
IMPORTED Imported scope (treated as global).
LOCAL Local scope.

Method Summary

Modifier and Type	Method and Description
static SequencedSharedMemoryActor.Scope	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SequencedSharedMemoryActor.Scope[]	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 Detail

LOCAL

public static final SequencedSharedMemoryActor.Scope LOCAL

Local scope.

GLOBAL

public static final SequencedSharedMemoryActor.Scope GLOBAL

Global scope.

IMPORTED

public static final SequencedSharedMemoryActor.Scope IMPORTED

Imported scope (treated as global).

EXPORTED

public static final SequencedSharedMemoryActor.Scope EXPORTED

Exported scope (treated as global).

Method Detail

values

public static SequencedSharedMemoryActor.Scope[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SequencedSharedMemoryActor.Scope c : SequencedSharedMemoryActor.Scope.values())
    System.out.println(c);

Returns:

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

valueOf

public static SequencedSharedMemoryActor.Scope valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null