zbar::Symbol Class Reference

decoded barcode symbol result object. More...

List of all members.

Classes

class  Point
 image pixel location (x, y) coordinate tuple. More...
class  PointIterator
 iteration over Point objects in a symbol location polygon. More...

Public Member Functions

 Symbol (const zbar_symbol_t *sym=NULL)
 constructor.
 Symbol (const Symbol &sym)
 copy constructor.
 ~Symbol ()
 destructor.
void ref (int delta=1) const
 operator const zbar_symbol_t * () const
 cast to C symbol.
bool operator== (const Symbol &sym) const
 test if two Symbol objects refer to the same C symbol.
bool operator!= (const Symbol &sym) const
 test if two Symbol objects refer to the same C symbol.
zbar_symbol_type_t get_type () const
 retrieve type of decoded symbol.
const std::string get_type_name () const
 retrieve the string name of the symbol type.
const std::string get_addon_name () const
 retrieve the string name for any addon.
const std::string get_data () const
 retrieve data decoded from symbol.
unsigned get_data_length () const
 retrieve length of binary data
int get_count () const
 retrieve inter-frame coherency count.
SymbolSet get_components () const
PointIterator point_begin () const
 create a new PointIterator at the start of the location polygon.
const PointIterator point_end () const
 return a PointIterator suitable for ending iteration.
int get_location_size () const
 see zbar_symbol_get_loc_size().
int get_location_x (unsigned index) const
 see zbar_symbol_get_loc_x().
int get_location_y (unsigned index) const
 see zbar_symbol_get_loc_y().
const std::string xml () const
 see zbar_symbol_xml().

Protected Member Functions

void init (const zbar_symbol_t *sym=NULL)
 (re)initialize Symbol from C symbol object.

Related Functions

(Note that these are not member functions.)

static std::ostream & operator<< (std::ostream &out, const Symbol &sym)


Detailed Description

decoded barcode symbol result object.

stores type, data, and image location of decoded symbol


Member Function Documentation

int zbar::Symbol::get_count (  )  const [inline]

retrieve inter-frame coherency count.

see zbar_symbol_get_count()

Since:
1.5

PointIterator zbar::Symbol::point_begin (  )  const [inline]

create a new PointIterator at the start of the location polygon.


Friends And Related Function Documentation

static std::ostream & operator<< ( std::ostream &  out,
const Symbol sym 
) [related]

stream the string representation of a Symbol.


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

SourceForge.net Logo
spadix@users.sourceforge.net

Copyright 2008-2010 (c) Jeff Brown

This documentation is part of the ZBar Barcode Reader; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.