asdm::Tag Class Reference

#include <Tag.h>

List of all members.

---

Detailed Description

The Tag class is an implementation of a unique index identifying a row of an ASDM 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 Jan. 7, 2005

Author:

Allen Farris

Version:

2.00 Aug. 3, 2006

Author:

Michel Caillat

Public Member Functions
	Tag ()
	Tag (unsigned int i)
	Tag (unsigned int i, const TagType *t)
	Tag (const Tag &t)
	Tag (IDLTag &t)
string	toString () const
void	toBin (EndianOSStream &eoss)
virtual	~Tag ()
TagType *	getTagType ()
unsigned int	getTagValue ()
IDLTag	toIDLTag () const
string	getTag () const
Tag &	operator= (const Tag &)
bool	equals (const Tag &t) const
bool	operator== (const Tag &t) const
bool	operator!= (const Tag &t) const
bool	operator< (const Tag &t) const
bool	isNull () const
Static Public Member Functions
Tag	parseTag (string s)
void	toBin (const vector< Tag > &tag, EndianOSStream &eoss)
Tag	fromBin (EndianISStream &eiss)
vector< Tag >	from1DBin (EndianISStream &eiss)
Protected Attributes
string	tag
TagType *	type

---

Constructor & Destructor Documentation

asdm::Tag::Tag (   )

Create a default Tag that is null

asdm::Tag::Tag (  unsigned int  i  )

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

asdm::Tag::Tag (  unsigned int  i, const TagType *  t )

Create a Tag from an integer value 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.

asdm::Tag::Tag (  const Tag &  t  )

Create a Tag from a Tag (copy constructor).

asdm::Tag::Tag (  IDLTag &  t  )

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

virtual asdm::Tag::~Tag (   )  [virtual]

The Tag destructor.

---

Member Function Documentation

bool asdm::Tag::equals (  const Tag &  t  )  const

Returns: true if and only if this->value==t.value and this-> type==t.type

vector<Tag> asdm::Tag::from1DBin (  EndianISStream &  eiss  )  [static]

Read the binary representation of a of a vector of Tag from an EndianISStream and use the read value to set a vector of Tag. Parameters: eiis  the EndianISStream to be read Returns: a vector of Tag Exceptions: TagFormatException

Tag asdm::Tag::fromBin (  EndianISStream &  eiss  )  [static]

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

string asdm::Tag::getTag (   )  const

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

TagType* asdm::Tag::getTagType (   )

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

unsigned int asdm::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. Note: The returned integer value has a meaning if and only if the Taf is not null.

bool asdm::Tag::isNull (   )  const

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.

bool asdm::Tag::operator!= (  const Tag &  t  )  const

Returns: true if this->value != t.value or this->type != t.value

bool asdm::Tag::operator< (  const Tag &  t  )  const

Returns: true if this->value < t.value Note: Note that the types of the Tags being compared is not taken into account.

Tag& asdm::Tag::operator= (  const Tag &   )

Assignment operator.

bool asdm::Tag::operator== (  const Tag &  t  )  const

Returns: true if and only if this->value==t.value and this-> type==t.type Note: Behaves exactly like the equals method.

Tag asdm::Tag::parseTag (  string  s  )  [static]

Create a Tag whose initial value is the specified string. Exceptions: TagFormatException

void asdm::Tag::toBin (  const vector< Tag > &  tag, EndianOSStream &  eoss )  [static]

Write the binary representation of a 1D array of Tag to an EndianOSStream. Parameters: tag  the vector of Tag to be written eoss  the EndianOSStream to be written to

void asdm::Tag::toBin (  EndianOSStream &  eoss  )

Write the binary representation of this to a EndianOSStream.

IDLTag asdm::Tag::toIDLTag (   )  const

Returns a IDLTag object built from this Tag. Returns: an IDLTag.

string asdm::Tag::toString (   )  const

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.

---

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

• Tag.h

---