Main Page | Class Hierarchy | Compound List | File List | Compound Members

BxUnsignedShort16 Class Reference

Class implementing the BinX data type 16-bit unsigned integer. More...

#include <BxUnsignedShort16.h>

Inheritance diagram for BxUnsignedShort16:

BxInteger BxDataObject BxObject List of all members.

Public Member Functions

 BxUnsignedShort16 ()
 BxUnsignedShort16 (const BxUnsignedShort16 &)
 BxUnsignedShort16 (const bx_ushort16)
virtual bool equals (const BxDataObject &) const
virtual char * toString (bool xml)
virtual bool parseValue (const char *)
BxUnsignedShort16 & operator= (const bx_ushort16)

Detailed Description

Instances of this class hold and perform operations on the BinX XML Schema type <unsignedShort-16>. The class provides manipulations such as:
The BinX primitive data type 16-bit insigned integer is treated in accordance with the XSD definition of this data type. Hence, an instance of this class must have a value from 0 to (2**16 - 1).
Since: BinX version 1.0.

Constructor & Destructor Documentation

BxUnsignedShort16::BxUnsignedShort16 (   ) 
 

Default constructor.

Constructs and initialises an instance of the class BxUnsignedShort16. Default attribute values are assigned as follows: 

       sizeInBits_ = 16;
       sizeInBytes_ = 2; 
       sizeInAll_ = 2;
       unsigned_ = true;

BxUnsignedShort16::BxUnsignedShort16 (  const BxUnsignedShort16 &  copy  ) 
 

Construct a BxUnsignedShort16 instance by copying a specified BxUnsignedShort16 instance.

Constructs and initialises an instance of the class BxUnsignedShort16.

Parameters:
copy A reference to the BxUnsignedShort16 instance to copy.

BxUnsignedShort16::BxUnsignedShort16 (  const bx_ushort16  us  ) 
 

Construct a BxUnsignedShort16 instance and assign it a specified 16-bit unsigned integer value.

Constructs and initialises an instance of the class BxUnsignedShort16.

Parameters:
us A 16-bit unsigned integer value to initialise the new BxUnsignedShort16 object.

Member Function Documentation

bool BxUnsignedShort16::equals (  const BxDataObject &  dataObj  )  const [virtual]
 

Compares the value of a specified data object with the value of this object.

In this method, two objects are considered to be equal if they are of the same BinX object type and if they store the same data value. Also, only primitive BinX data types implement this method.
Note: that byte order differences are not compensated for in this test. Hence, two unsigned 16-bit integers that are equal in value, but represented in different byte orders would be found to be unequal.

Parameters:
dataObj A reference to another data object to be compared with this object.
Returns:
true If the data type and value of the two objects are equal,
false If the objects differ in type or value.

Reimplemented from BxDataObject.

BxUnsignedShort16 & BxUnsignedShort16::operator= (  const bx_ushort16  us  ) 
 

Overloaded operator = assigns a 16-bit unsigned integer from a specified source to a BxUnsignedShort16 destination object.

Parameters:
us A 16-bit unsigned integer value to be assigned to a BxUnsignedShort16 object.
Returns:
A reference to this BxUnsignedShort16 object after the assignment has been performed.

bool BxUnsignedShort16::parseValue (  const char *  strVal  )  [virtual]
 

Extract a 16-bit unsigned integer value from a specified string and assign the value to this object.

The data contained in the input string is assumed to be in ASCII representation, and to contain an unsigned short integer represented in decimal or hexadecimal (i.e., base 10 or base 16). A hexademinal string must begin with the characters 0x. The input string must not contain commas, periods, or other symbols (such as the minus symbol). The input string must be null-terminated. All bytes of the input string are used in the conversion process. The input bytes are converted to integer representation, in conformance with the definiton of a BxUnsignedShort16 object value. The converted value is stored as the value of this object. Only primitive BinX data types implement this method.

Parameters:
strVal A pointer to an ASCII string containing a short unsigned integer value.
Returns:
true If value conversion was successful,
false If the input string is NULL.

Reimplemented from BxDataObject.

char * BxUnsignedShort16::toString (  bool  xml  )  [virtual]
 

Return a string containing the DataBinX XML element (or printable value only ) for the value of this BxUnsignedShort16 object.

The DataBinx representation of a BxUnsignedShort16 object value consists of:

  • The BinX XML tags, <unsignedShort-16> and </unsignedShort-16>
  • The binary data value of this object, converted to a printable representation

Example Return Result: 
       <unsignedShort-16>47</unsignedShort-16>

This method allocates memory to hold the returned string. The caller is responsible for releasing the memory when the string is no longer needed.
If the BinX XML tags are not required, then the input boolean flag can be used to request that only the converted binary data value be included in the result string.
Only BinX primitive data types implement this method.
Parameters:
xml A boolean indicating whether to include BinX XML tags or not.
Returns:
A string buffer containing the DataBinX representation of the value of this object, if the input flag is true,
A string buffer containing the printable representation of the value of this object, if the input flag is false.

Reimplemented from BxDataObject.

The documentation for this class was generated from the following files:
Generated on Fri May 6 13:36:20 2005 for edikt::BinX by doxygen 1.3.3