com.interpss.core.algo.path

Enum NetPathWalkDirectionEnum

java.lang.Object

java.lang.Enum<NetPathWalkDirectionEnum>

com.interpss.core.algo.path.NetPathWalkDirectionEnum

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<NetPathWalkDirectionEnum>, org.eclipse.emf.common.util.Enumerator

public enum NetPathWalkDirectionEnum
extends java.lang.Enum<NetPathWalkDirectionEnum>
implements org.eclipse.emf.common.util.Enumerator

A representation of the literals of the enumeration 'Active Power Walk Direction', and utility methods for working with them. Walk could be along-path direction or opposite-path direction. Path direction itself is problem specific. It could be along active power flow or current flow direction.

See Also:

PathAlgorithmPackage.getNetPathWalkDirectionEnum()

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALONG_PATH The 'Along Path' literal object.
OPPOSITE_PATH The 'Opposite Path' literal object.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALONG_PATH_VALUE The 'Along Path' literal value.
static int	OPPOSITE_PATH_VALUE The 'Opposite Path' literal value.
static java.util.List<NetPathWalkDirectionEnum>	VALUES A public read-only list of all the 'Net Path Walk Direction Enum' enumerators.

Method Summary

Modifier and Type	Method and Description
static NetPathWalkDirectionEnum	get(int value) Returns the 'Net Path Walk Direction Enum' literal with the specified integer value.
static NetPathWalkDirectionEnum	get(java.lang.String literal) Returns the 'Net Path Walk Direction Enum' literal with the specified literal value.
static NetPathWalkDirectionEnum	getByName(java.lang.String name) Returns the 'Net Path Walk Direction Enum' literal with the specified name.
java.lang.String	getLiteral()
java.lang.String	getName()
int	getValue()
java.lang.String	toString() Returns the literal value of the enumerator, which is its string representation.
static NetPathWalkDirectionEnum	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static NetPathWalkDirectionEnum[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ALONG_PATH

public static final NetPathWalkDirectionEnum ALONG_PATH

The 'Along Path' literal object.

See Also:

ALONG_PATH_VALUE

OPPOSITE_PATH

public static final NetPathWalkDirectionEnum OPPOSITE_PATH

The 'Opposite Path' literal object.

See Also:

OPPOSITE_PATH_VALUE

Field Detail

ALONG_PATH_VALUE

public static final int ALONG_PATH_VALUE

The 'Along Path' literal value.

If the meaning of 'Along Path' literal object isn't clear, there really should be more of a description here...

See Also:

ALONG_PATH, Constant Field Values

OPPOSITE_PATH_VALUE

public static final int OPPOSITE_PATH_VALUE

The 'Opposite Path' literal value.

If the meaning of 'Opposite Path' literal object isn't clear, there really should be more of a description here...

See Also:

OPPOSITE_PATH, Constant Field Values

VALUES

public static final java.util.List<NetPathWalkDirectionEnum> VALUES

A public read-only list of all the 'Net Path Walk Direction Enum' enumerators.

Method Detail

values

public static NetPathWalkDirectionEnum[] 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 (NetPathWalkDirectionEnum c : NetPathWalkDirectionEnum.values())
    System.out.println(c);

Returns:

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

valueOf

public static NetPathWalkDirectionEnum 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

get

public static NetPathWalkDirectionEnum get(java.lang.String literal)

Returns the 'Net Path Walk Direction Enum' literal with the specified literal value.

Parameters:

literal - the literal.

Returns:

the matching enumerator or null.

getByName

public static NetPathWalkDirectionEnum getByName(java.lang.String name)

Returns the 'Net Path Walk Direction Enum' literal with the specified name.

Parameters:

name - the name.

Returns:

the matching enumerator or null.

get

public static NetPathWalkDirectionEnum get(int value)

Returns the 'Net Path Walk Direction Enum' literal with the specified integer value.

Parameters:

value - the integer value.

Returns:

the matching enumerator or null.

getValue

public int getValue()

Specified by:

getValue in interface org.eclipse.emf.common.util.Enumerator

getName

public java.lang.String getName()

Specified by:

getName in interface org.eclipse.emf.common.util.Enumerator

getLiteral

public java.lang.String getLiteral()

Specified by:

getLiteral in interface org.eclipse.emf.common.util.Enumerator

toString

public java.lang.String toString()

Returns the literal value of the enumerator, which is its string representation.

Overrides:

toString in class java.lang.Enum<NetPathWalkDirectionEnum>