BxUnsignedByte8 Class Reference

Class implementing the BinX data type 8-bit unsigned byte. More...

#include <BxUnsignedByte8.h>

Inheritance diagram for BxUnsignedByte8:

List of all members.

Public Member Functions
	BxUnsignedByte8 ()
	BxUnsignedByte8 (const bx_ubyte8)
virtual bool	equals (const BxDataObject &) const
virtual char *	toString (bool xml)
virtual bool	parseValue (const char *)
BxUnsignedByte8 &	operator= (const bx_ubyte8)

---

Detailed Description

Instances of this class hold and perform operations on the BinX XML Schema type <unsignedByte-8>. The class provides manipulations such as:

• Serializing a byte value to a file stream
• Parsing and storing an individual byte value from a string

The BinX primitive data type 8-bit unsigned byte is treated as an 8-bit unsigned integer value, in accordance with the XSD definition of this data type. Hence, an instance of this class must have a value from 0 to 255.
Since: BinX version 1.0.

---

Constructor & Destructor Documentation

BxUnsignedByte8::BxUnsignedByte8 (   )

Default constructor. Constructs and initialises an instance of the class BxUnsignedByte8. Default attribute values are assigned as follows: sizeInBits_ = 8; sizeInBytes_ = 1; sizeInAll_ = 1;

BxUnsignedByte8::BxUnsignedByte8 (  const bx_ubyte8  b  )

Construct a BxUnsignedByte8 instance and assign it a specified unsigned byte value. Constructs and initialises an instance of the class BxUnsignedByte8. Parameters: b  A byte value to initialise the new BxUnsignedByte8 object.

---

Member Function Documentation

bool BxUnsignedByte8::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 8-bit bytes 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.

BxUnsignedByte8 & BxUnsignedByte8::operator= (  const bx_ubyte8  b  )

Overloaded operator = assigns one unsigned byte from a specified source to a BxUnsignedByte8 destination object. Parameters: b  A single unsigned byte value to be assigned to a BxUnsignedByte8 object. Returns: A reference to this BxUnsignedByte8 object after the assignment has been performed.

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

Extract an 8-bit unsigned byte 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 a unsigned 8-bit 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. 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 BxUnsignedByte8 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 the string to extract an unsigned byte value from. Returns: true If value extraction and conversion was successful, false If the input string is NULL. Reimplemented from BxDataObject.

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

Return a string containing the DataBinX XML element (or printable value only ) for the value of this BxUnsignedByte8 object. The DataBinx representation of a BxUnsignedByte8 object value consists of: The BinX XML tags, &ltunsignedByte-8> and </unsignedByte-8> The binary data value of this object, converted to a printable representation Example Return Result: <unsignedByte-8>176</unsignedByte-8> 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:

• BxUnsignedByte8.h
• BxUnsignedByte8.cpp

---