fi.helsinki.cs.ohtu.mpeg2.audio.mpa
Enum ScaleFactors.TxPattern

java.lang.Object
  java.lang.Enum<ScaleFactors.TxPattern>
      fi.helsinki.cs.ohtu.mpeg2.audio.mpa.ScaleFactors.TxPattern

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ScaleFactors.TxPattern>

Enclosing class:

ScaleFactors

private static enum ScaleFactors.TxPattern
extends java.lang.Enum<ScaleFactors.TxPattern>

Transmission pattern defines how the three scale factors of a single sub-band are coded into the output stream. These values are for internal use of this class. Only scfsi values are visible outside. Here TP_113, for instance, specifies that the first and the second sub-band part share a scale factor which is taken from the first part. The third part has a scale factor of its own.

Enum Constant Summary

TP_111

TP_113

TP_122

TP_123

TP_133

TP_222

TP_333

TP_444

Field Summary

private int

scfsi Scale factor select information

Method Summary

int	getScfsi() Returns scale factor select information for this transmission pattern.
static ScaleFactors.TxPattern	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ScaleFactors.TxPattern[]	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

TP_123

public static final ScaleFactors.TxPattern TP_123

TP_122

public static final ScaleFactors.TxPattern TP_122

TP_133

public static final ScaleFactors.TxPattern TP_133

TP_113

public static final ScaleFactors.TxPattern TP_113

TP_111

public static final ScaleFactors.TxPattern TP_111

TP_222

public static final ScaleFactors.TxPattern TP_222

TP_333

public static final ScaleFactors.TxPattern TP_333

TP_444

public static final ScaleFactors.TxPattern TP_444

Field Detail

scfsi

private final int scfsi

Scale factor select information

Method Detail

values

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

Returns:

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

valueOf

public static ScaleFactors.TxPattern 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

getScfsi

public int getScfsi()

Returns scale factor select information for this transmission pattern. Interpretation of the value: 0 - three scale factors transmitted, for parts 0,1,2 respectively 1 - two scale factors transmitted, first one for parts 0 and 1, second one for part 2 2 - one scale factor transmitted, valid for all three parts 3 - two scale factors transmitted, first one valid for part 0, the second one for parts 1 and 2