alma.hla.runtime.asdm.types.Tag Class Reference

List of all members.

---

Detailed Description

The Tag class is an implementation of a unique index identifying a row of an ALMA table.

Basically a Tag is defined by :

• a value which is an integer
• a type which is a pointer to a TagType.

Version:

1.00 Nov 22, 2004

Author:

Allen Farris

Version:

2.00 Aug. 3, 2006

Author:

caillat

Public Member Functions
	Tag ()
	Create a default Tag that is null.
	Tag (int i)
	Create a Tag from an integer value.
	Tag (int i, TagType t)
	Create a Tag from an int and a TagType.
	Tag (Tag t)
	Create a Tag from a Tag (copy constructor).
	Tag (IDLTag t)
	Create a Tag from an IDLTag object.
String	toString ()
	Return the Tag as a String.
void	toBin (DataOutputStream dos) throws IOException
	Write the binary representation of a Tag into a DataOutput stream Exceptions: IOException.
IDLTag	toIDLTag ()
	Return an IDLTag object.
String	getTag ()
	Return this Tag value as a string.
TagType	getTagType ()
	Returns the type of this Tag.
int	getTagValue ()
	Returns the value of this Tag.
boolean	equals (Object o)
boolean	eq (Tag t)
boolean	isNull ()
	Return true if and only if this Tag is null, i.e.
int	compareTo (Object o)
	A Comparator.
Static Public Member Functions
Tag	parseTag (String s) throws TagFormatException
	Create a Tag whose initial value is the specified string.
int[]	values (Tag[] items)
	Return an array of int containing the values of the array of Tag objects passed in argument.
void	toBin (Tag[] tag, DataOutputStream dos) throws IOException
	Write the binary representation of a 1D array of Tag into a DataOutputStream.
Tag	fromBin (DataInputStream dis) throws IOException, TagFormatException
	Read the binary representation of a Tag from a DataInputStream and use the read value to set a Tag.
Tag[]	from1DBin (DataInputStream dis) throws IOException, TagFormatException
	Read the binary representation of a 1D array of Tag from a DataInputStream and use the read value to set a 1D array of Tag.

---

Constructor & Destructor Documentation

alma.hla.runtime.asdm.types.Tag.Tag (   )

Create a default Tag that is null.

alma.hla.runtime.asdm.types.Tag.Tag (  int  i  )

Create a Tag from an integer value. Parameters: i  an int defining the tag value. Note: The created Tag has a TagType.NoType.

alma.hla.runtime.asdm.types.Tag.Tag (  int  i, TagType  t )

Create a Tag from an int and a TagType. Parameters: i  an integer value to define the Tag value t  a TagType to define the type of the Tag Note: called with t == null this method creates a null Tag.

alma.hla.runtime.asdm.types.Tag.Tag (  Tag  t  )

Create a Tag from a Tag (copy constructor). Parameters: t  the Tag to be copied.

alma.hla.runtime.asdm.types.Tag.Tag (  IDLTag  t  )

Create a Tag from an IDLTag object. Parameters: t  The IDLTag object.

---

Member Function Documentation

int alma.hla.runtime.asdm.types.Tag.compareTo (  Object  o  )

A Comparator. The comparison is performed by calling compareTo on the tag fields.

boolean alma.hla.runtime.asdm.types.Tag.eq (  Tag  t  )

Parameters: t  The Tag to which this is being compared Returns: true this and t have values and types respectively equal.

boolean alma.hla.runtime.asdm.types.Tag.equals (  Object  o  )

Parameters: o  The object to which this is being compared. Returns: true if and only if the specified object o is a Tag and if this and (Tag)o have values and types respectively equal.

Tag [] alma.hla.runtime.asdm.types.Tag.from1DBin (  DataInputStream  dis  )  throws IOException, TagFormatException [static]

Read the binary representation of a 1D array of Tag from a DataInputStream and use the read value to set a 1D array of Tag. Parameters: dis  the DataInputStream to be read Returns: a 1D array of Tag Exceptions: IOException  TagFormatException

Tag alma.hla.runtime.asdm.types.Tag.fromBin (  DataInputStream  dis  )  throws IOException, TagFormatException [static]

Read the binary representation of a Tag from a DataInputStream and use the read value to set a Tag. Parameters: dis  the DataInputStream to be read Returns: a Tag Exceptions: IOException  TagFormatException

String alma.hla.runtime.asdm.types.Tag.getTag (   )

Return this Tag value as a string. Returns: This Tag. Deprecated:

TagType alma.hla.runtime.asdm.types.Tag.getTagType (   )

Returns the type of this Tag. A null returned value indicates that the Tag is null (i.e. this.isNull() == true)/ Returns: the type of this Tag as a TagType.

int alma.hla.runtime.asdm.types.Tag.getTagValue (   )

Returns the value of this Tag. The returned value has no meaning if the Tag is null. Returns: the value of this Tag as an int.

boolean alma.hla.runtime.asdm.types.Tag.isNull (   )

Return true if and only if this Tag is null, i.e. if its TagType field is null. Returns: True if and only if this Tag is null.

Tag alma.hla.runtime.asdm.types.Tag.parseTag (  String  s  )  throws TagFormatException [static]

Create a Tag whose initial value is the specified string.

void alma.hla.runtime.asdm.types.Tag.toBin (  Tag[]  tag, DataOutputStream  dos )  throws IOException [static]

Write the binary representation of a 1D array of Tag into a DataOutputStream. Parameters: tag  dos  Exceptions: IOException

IDLTag alma.hla.runtime.asdm.types.Tag.toIDLTag (   )

Return an IDLTag object. Returns: An IDLTag object.

String alma.hla.runtime.asdm.types.Tag.toString (   )

Return the Tag as a String. The resulting string consists in the string representation of the type followed by an underscore followed by the String representation of the value. Examples : "Antenna_12", "SpectralWindow_0". Returns: The Tag as a String.

int [] alma.hla.runtime.asdm.types.Tag.values (  Tag[]  items  )  [static]

Return an array of int containing the values of the array of Tag objects passed in argument. It must be noted that the information related to the type of each Tag in the items array is lost ! This method is useful only for anyone interested in the (int) values of Tag objects stored in array.

---

The documentation for this class was generated from the following file:

• Tag.java

---