aja::AttributeNumber Class Reference

Class representing NUMBER-ATTRIBUTE items. More...

#include <AttributeNumber.h>

Inheritance diagram for aja::AttributeNumber:

aja::AttributeItem aja::Item List of all members.

Public Member Functions

 AttributeNumber (byte_t id)
 construct a number attribute
 ~AttributeNumber ()
number_t getNumber ()
 Function return number of attribute.
void setNumber (number_t num)
 Function set number of attribute.
bool buildAja (OutputBuffer &out)
 Function build AJA binary form of Number Attribute.
bool parseAttrData (buffer_t buffer, unsigned int size, unsigned int &pos)
 Function parse number for this attribute.
void getValueStr (std::string &out)
 Abstract function put into string parameter his value in string form.
number_t getItemSize ()
 Function return complete size of number attribute.

Protected Attributes

number_t mNumber

Detailed Description

Class representing NUMBER-ATTRIBUTE items.

Number Attribute can store, parse and build 32 unsigned int numbers.

See also:
aja::Item aja::AttributeItem


Constructor & Destructor Documentation

aja::AttributeNumber::AttributeNumber byte_t  id  ) 
 

construct a number attribute

Parameters:
id attribute's ID from range 1-255 </pr>

aja::AttributeNumber::~AttributeNumber  ) 
 


Member Function Documentation

bool aja::AttributeNumber::buildAja OutputBuffer out  )  [virtual]
 

Function build AJA binary form of Number Attribute.

Parameters:
out Into this class is written AJA binary result of building process.
Returns:
true id ok, false when error was occurred

Reimplemented from aja::AttributeItem.

number_t aja::AttributeNumber::getItemSize  )  [virtual]
 

Function return complete size of number attribute.

Returns:
size of number attr.

Reimplemented from aja::AttributeItem.

number_t aja::AttributeNumber::getNumber  ) 
 

Function return number of attribute.

Returns:
number like 32 bit unsigned integer

void aja::AttributeNumber::getValueStr std::string &  out  )  [virtual]
 

Abstract function put into string parameter his value in string form.

In this overriden function is code for every child attribute type who convert his value to string form.

Parameters:
[out] this is reference to string where function put string value.

Implements aja::AttributeItem.

bool aja::AttributeNumber::parseAttrData buffer_t  buffer,
unsigned int  size,
unsigned int &  pos
[virtual]
 

Function parse number for this attribute.

This is overriden function called when is needed parse data for number attribute

See also:
aja::AttributeItem::parseAttrData

Implements aja::AttributeItem.

void aja::AttributeNumber::setNumber number_t  num  ) 
 

Function set number of attribute.

Parameters:
num number to be set


Member Data Documentation

number_t aja::AttributeNumber::mNumber [protected]
 


The documentation for this class was generated from the following files:
Generated on Sun Mar 4 00:30:37 2007 for LIBAJA by  doxygen 1.4.6