com.adventnet.tl1.message
Class TL1AutoID

java.lang.Object
  |
  +--com.adventnet.tl1.message.TL1AutoID

public class TL1AutoID

extends java.lang.Object

This object represents a TL1 Autonomous Message ID which forms a part of the TL1 Autonomous Message. This identifies the severity and nature of the Autonomous Message. It contains the alarm code for indicating the severity.

TL1 Autonomous Message block

Components of the TL1 AutoID

See Also:

TL1AutonomousMessage

Constructor Summary

TL1AutoID()
Default constructor that creates an instance of TL1AutoID.

TL1AutoID(java.lang.String alarmCode)
Constructor that creates an instance of TL1AutoID with the Alarm Code initialized to the specified value.

Method Summary

java.lang.String	getAlarmCode() Get the alarm code.
double	getATag() Get the autonomously generated Correlation Tag which is generated by the TL1 NE.
java.lang.String	getOutputCode() Get the Output Code set on this object.
void	setAlarmCode(java.lang.String alarmCode) Set the alarm code to the specified code.
void	setATag(double aTag) Set the autonomously generated Correlation Tag with the specified value.
void	setATag(int aTag) Set the autonomously generated Correlation Tag with the specified value.
void	setOutputCode(java.lang.String outputCode) Set the Output Code of the object with the given value.
java.lang.String	toString() Returns the String representation of this Object.

Methods inherited from class java.lang.Object

, clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TL1AutoID

public TL1AutoID()

Default constructor that creates an instance of TL1AutoID.

TL1AutoID

public TL1AutoID(java.lang.String alarmCode)

Constructor that creates an instance of TL1AutoID with the Alarm Code initialized to the specified value.

Parameters:

alarmCode - String representing alarm code.

Method Detail

getAlarmCode

public java.lang.String getAlarmCode()

Get the alarm code. It indicates the severity of the Autonomous Message.

Returns:

String specifying the alarm code.

See Also:

TL1AutonomousMessage.CRITICAL_ALARM, TL1AutonomousMessage.MAJOR_ALARM, TL1AutonomousMessage.MINOR_ALARM, TL1AutonomousMessage.NON_ALARM

setAlarmCode

public void setAlarmCode(java.lang.String alarmCode)

Set the alarm code to the specified code.

Parameters:

alarmCode - String representing alarm code.

See Also:

TL1AutonomousMessage.CRITICAL_ALARM, TL1AutonomousMessage.MAJOR_ALARM, TL1AutonomousMessage.MINOR_ALARM, TL1AutonomousMessage.NON_ALARM

getATag

public double getATag()

Get the autonomously generated Correlation Tag which is generated by the TL1 NE. This tag indicates the sequence of arrival of the Autonomous Messages.

Returns:

The Autonomous Tag value.

setATag

public void setATag(double aTag)

Set the autonomously generated Correlation Tag with the specified value. It indicates the order of arrival of the particular Autonomous Message.

Parameters:

aTag - The Autonomous Tag as a double.

setATag

public void setATag(int aTag)

Set the autonomously generated Correlation Tag with the specified value. It indicates the order of arrival of the particular Autonomous Message.

Parameters:

aTag - The Autonomous Tag as an int.

getOutputCode

public java.lang.String getOutputCode()

Get the Output Code set on this object.

Returns:

String representing the Output Code.

setOutputCode

public void setOutputCode(java.lang.String outputCode)

Set the Output Code of the object with the given value.

Parameters:

outputCode - String representing the Output Code.

toString

public java.lang.String toString()

Returns the String representation of this Object. The String contains the value of the Alarm Code, Autonomous Tag, and the Output Code.

Overrides:

toString in class java.lang.Object

Returns:

String representing the object.