aja Namespace Reference


Classes

class  AttributeData
 Class representing DATA-ATTRIBUTE items. More...
class  AttributeItem
 basic class for Attributes More...
class  AttributeNumber
 Class representing NUMBER-ATTRIBUTE items. More...
class  Document
 Class representing basic AJA-Document. More...
struct  transAttr_t
 attribute structure in translation table. More...
struct  transElm_t
 Element structure used in translation table. More...
class  DocumentHeader
 class representing DOCUMENT ITEM. More...
class  ElementData
 class representing DATA-ELEMENT items More...
class  ElementItem
 Basic class for elements. More...
class  ElementNumber
 class representing NUMBER-ELEMENT items More...
class  ElementParent
 class representing Element who contain other child elements. More...
class  ElementString
 class representing STRING-ELEMENT items. More...
class  Factory
 class contain only static functions who create a instances of Elements, Attributes etc. More...
class  Item
 This is basic class for all items classes. More...
class  basicHelper
 Basic help class for OutputBuffer. More...
class  memHelper
 Helper used when you need add into OutputBuffer memory array with know size. More...
class  typeHelper
 Helper used when you need add into OutputBuffer type and subtype of item(first byte of all items). More...
class  elmIdHelper
 Helper used when you need add into OutputBuffer Element ID(24 unsigned number). More...
class  OutputBuffer
 Output class used when is builded AJA document. Class allocate new memory blok, when is block full, then reallocate automaticly to This class have overriden operator << for better usage. More...

Typedefs

typedef unsigned char byte_t
 this type representing 8 bit unsigned number
typedef unsigned short dbyte_t
 this type representing 16 bit unsigned number
typedef unsigned int number_t
 this type representing 32 bit unsigned number
typedef byte_t * buffer_t
 this type representing pointer to array of bytes
typedef std::vector< transAttr_t > transAttr_v
typedef std::vector< transElm_t > transElm_v
typedef std::map< std::string,
std::string > 		documentValue_v
 This type specify values in document item. Values are combined from value-name and value.Values are representing like strings.
typedef std::map< byte_t,
AttributeItem * > 		attributeArray_t
 type for asoc. array of attributes
typedef std::multimap< number_t,
ElementItem * > 		elementArray_t
 associative array of elements.This type is used in ElementParent

Enumerations

enum  elementType_t {
  ELM_UNDEFINED = 0x00, ELM_DATA = 0x01, ELM_NUMBER = 0x02, ELM_STRING = 0x03,
  ELM_PARENT = 0x0F
}
 This enumeration type contain all element types. More...
enum  attributeType_t { ATTR_UNDEFINED = 0x00, ATTR_DATA = 0x01, ATTR_NUMBER = 0x02, ATTR_STRING = 0x03 }
 This enumeration type contain all atribute types. More...
enum  itemType_t { ITM_UNDEFINED = 0x00, ITM_ELEMENT = 0x01, ITM_ATTRIBUTE = 0x02, ITM_DOCUMENTHEADER = 0x0A }
 This enumeration type contain all basic items. More...

Functions

bool getByteFromData (byte_t &out, const buffer_t buffer, unsigned int size, unsigned int pos)
 Function convert chars to 8bit number.
bool getDbyteFromData (dbyte_t &out, const buffer_t buffer, unsigned int size, unsigned int pos)
 Function convert chars to 16 bit number.
bool get24NumberFromData (number_t &out, const buffer_t buffer, unsigned int size, unsigned int pos)
 Function convert chars to 24 bit number.
bool get32NumberFromData (number_t &out, const buffer_t buffer, unsigned int size, unsigned int pos)
 Function convert chars to 32 bit number.
bool getBitsFromData (byte_t &out, byte_t mask, byte_t move, buffer_t buffer, unsigned int size, unsigned int pos)
 Function take a bits of byte by mask.
OutputBuffer & operator<< (OutputBuffer &o, const basicHelper &data)
OutputBuffer & operator<< (OutputBuffer &o, const byte_t data)
OutputBuffer & operator<< (OutputBuffer &o, const char *data)
OutputBuffer & operator<< (OutputBuffer &o, const dbyte_t data)
OutputBuffer & operator<< (OutputBuffer &o, const number_t data)
OutputBuffer & operator<< (OutputBuffer &o, const std::string data)
OutputBuffer & operator<< (OutputBuffer &o, const OutputBuffer &i)

Typedef Documentation

typedef std::map<byte_t, AttributeItem*> aja::attributeArray_t
 

type for asoc. array of attributes

typedef byte_t* aja::buffer_t
 

this type representing pointer to array of bytes

typedef unsigned char aja::byte_t
 

this type representing 8 bit unsigned number

typedef unsigned short aja::dbyte_t
 

this type representing 16 bit unsigned number

typedef std::map<std::string, std::string> aja::documentValue_v
 

This type specify values in document item. Values are combined from value-name and value.Values are representing like strings.

typedef std::multimap<number_t,ElementItem*> aja::elementArray_t
 

associative array of elements.This type is used in ElementParent

typedef unsigned int aja::number_t
 

this type representing 32 bit unsigned number

typedef std::vector<transAttr_t> aja::transAttr_v
 

typedef std::vector<transElm_t> aja::transElm_v
 

Enumeration Type Documentation

enum aja::attributeType_t
 

This enumeration type contain all atribute types.

Enumerator:
ATTR_UNDEFINED 
ATTR_DATA 
ATTR_NUMBER 
ATTR_STRING 

enum aja::elementType_t
 

This enumeration type contain all element types.

Enumerator:
ELM_UNDEFINED 
ELM_DATA 
ELM_NUMBER 
ELM_STRING 
ELM_PARENT 

enum aja::itemType_t
 

This enumeration type contain all basic items.

Enumerator:
ITM_UNDEFINED 
ITM_ELEMENT 
ITM_ATTRIBUTE 
ITM_DOCUMENTHEADER 

Function Documentation

bool aja::get24NumberFromData (  number_t &  out,
const buffer_t  buffer,
unsigned int  size,
unsigned int  pos = 0
) 
 

Function convert chars to 24 bit number.

Function take 3 chars and convert it into 24 bit unsigned number but result is stored in 32bit unisgned type number_t.

Parameters:
[out] out into this parameter function put converted 24 bit unsigned number.
buffer this buffer must contain 2 or more characters
size size of buffer
pos starting position for convert in buffer
Returns:
TRUE when is convert ok, FALSE when is error occured (probably bad buffer, low size of buffer etc..)

bool aja::get32NumberFromData (  number_t &  out,
const buffer_t  buffer,
unsigned int  size,
unsigned int  pos = 0
) 
 

Function convert chars to 32 bit number.

Function take 4 chars and convert it into32 bit unsigned number and result is stored in number_t reference out.

Parameters:
[out] out into this parameter function put converted 32 bit unsigned number.
buffer this buffer must contain 2 or more characters
size size of buffer
pos starting position for convert in buffer
Returns:
TRUE when is convert ok, FALSE when is error occured (probably bad buffer, low size of buffer etc..)

bool aja::getBitsFromData (  byte_t &  out,
byte_t  mask,
byte_t  move,
buffer_t  buffer,
unsigned int  size,
unsigned int  pos = 0
) 
 

Function take a bits of byte by mask.

Function take cuurent bits in byte.This function is ideal when you need split one byte to 2 values of 4 bits size.Function apply at byte mask and then realize buit movemed into right.

  1. example: take a first 4 bits of byte 
     getBitsFromData(out, 0xF0, 4, buf, buf_size);
  2. example: take a last 4 bits of byte 
     getBitsFromData(out, 0x0F, 0, buf, buf_size);

Parameters:
[out] out into this parameter is stored splited value.
mask mask who bits are in value.for example first 4 bits use mask 0xF0(11110000)
move bit left movemend.When value is taked by mask, next must be value moved into right to first position. For example when you have mask 11110000 we must moved bits about 4 places to right(11110000 >> 4 = 00001111)
buffer this buffer must contain 2 or more characters
size size of buffer
pos starting position for convert in buffer.Default is 0
Returns:
TRUE when is convert ok, FALSE when is error occured (probably bad buffer, low size of buffer etc..)

bool aja::getByteFromData (  byte_t &  out,
const buffer_t  buffer,
unsigned int  size,
unsigned int  pos = 0
) 
 

Function convert chars to 8bit number.

Function take a char from buffer and convert it to 8bit unsigned number byte_t.

Parameters:
[out] out into this parameter function put converted 8bit unsigned number.
buffer this buffer must contain 1 or more characters
size size of buffer
pos starting position for convert in buffer
Returns:
TRUE when is convert ok, FALSE when is error occured (probably bad buffer, low size of buffer etc..)

bool aja::getDbyteFromData (  dbyte_t &  out,
const buffer_t  buffer,
unsigned int  size,
unsigned int  pos = 0
) 
 

Function convert chars to 16 bit number.

Function take a 2 chars and convert it into 16 bit unsigned number dbyte_t.

Parameters:
[out] out into this parameter function put converted 16 bit unsigned number.
buffer this buffer must contain 2 or more characters
size size of buffer
pos starting position for convert in buffer
Returns:
TRUE when is convert ok, FALSE when is error occured (probably bad buffer, low size of buffer etc..)

OutputBuffer& aja::operator<< (  OutputBuffer &  o,
const OutputBuffer &  i
) 
 

OutputBuffer& aja::operator<< (  OutputBuffer &  o,
const std::string  data
) 
 

OutputBuffer& aja::operator<< (  OutputBuffer &  o,
const number_t  data
) 
 

OutputBuffer& aja::operator<< (  OutputBuffer &  o,
const dbyte_t  data
) 
 

OutputBuffer& aja::operator<< (  OutputBuffer &  o,
const char *  data
) 
 

OutputBuffer& aja::operator<< (  OutputBuffer &  o,
const byte_t  data
) 
 

OutputBuffer& aja::operator<< (  OutputBuffer &  o,
const basicHelper &  data
) 
 

Generated on Sun Mar 4 00:30:37 2007 for LIBAJA by  doxygen 1.4.6