com.dsi.ant.message

Class ExtendedAssignment

java.lang.Object

com.dsi.ant.message.ExtendedAssignment

public final class ExtendedAssignment
extends java.lang.Object

Used when assigning a channel to enable additional ANT features such as frequency agility and background scanning.

Since:

4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ExtendedAssignment.Flag The flags which indicate which features to enable in a raw extended assignment byte.

Field Summary

Fields

Modifier and Type	Field and Description
static int	SIZE_EXTENDED_ASSIGNMENT The number of bytes used for extended assignment

Constructor Summary

Constructors

Constructor and Description
ExtendedAssignment() Constructs an ExtendedAssignment object with all features defaulting to false.
ExtendedAssignment(int extendedAssignmentByte) Used internally by the ANT API to construct an ExtendedAssignment object from a byte.

Method Summary

Methods

Modifier and Type	Method and Description
void	enableBackgroundScanning() Sets the enable background scanning flag.
void	enableFrequencyAgility() Sets the enable frequency agility flag.
boolean	getEnableBackgroundScanning() Returns the background scanning flag.
boolean	getEnableFrequencyAgility() Returns the frequency agility flag.
byte	getFlagsByte() Returns the byte representing the extended assignment configuration.
boolean	isEnabled() Check if any features are set to enable.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

SIZE_EXTENDED_ASSIGNMENT

public static final int SIZE_EXTENDED_ASSIGNMENT

The number of bytes used for extended assignment

Since:

4.0

See Also:

Constant Field Values

Constructor Detail

ExtendedAssignment

public ExtendedAssignment()

Constructs an ExtendedAssignment object with all features defaulting to false.

Since:

4.0

ExtendedAssignment

public ExtendedAssignment(int extendedAssignmentByte)

Used internally by the ANT API to construct an ExtendedAssignment object from a byte.

Parameters:

extendedAssignmentByte - The byte representing the extended assignment configuration.

Since:

4.0

Method Detail

getFlagsByte

public byte getFlagsByte()

Returns the byte representing the extended assignment configuration.

Since:

4.0

isEnabled

public boolean isEnabled()

Check if any features are set to enable.

Returns:

True if any extended assignment features are set.

Since:

4.0

getEnableBackgroundScanning

public boolean getEnableBackgroundScanning()

Returns the background scanning flag.

Returns:

True if background scanning is enabled. False, otherwise.

Since:

4.0

enableBackgroundScanning

public void enableBackgroundScanning()

Sets the enable background scanning flag.

Since:

4.1

getEnableFrequencyAgility

public boolean getEnableFrequencyAgility()

Returns the frequency agility flag.

Returns:

True, if frequency agility is enabled. False, otherwise.

Since:

4.0

enableFrequencyAgility

public void enableFrequencyAgility()

Sets the enable frequency agility flag.

Since:

4.1

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object