ZBar.Symbol Class Reference

Representation of a decoded symbol. More...

List of all members.

Public Member Functions

override string ToString ()

Properties

int Count [get]
string Data [get]
int Quality [get]
SymbolType Type [get]

Private Member Functions

internal Symbol (IntPtr symbol)
 Initialize a symbol from pointer to a symbol.
static void zbar_symbol_ref (IntPtr symbol, int refs)
 symbol reference count manipulation.
static int zbar_symbol_get_type (IntPtr symbol)
 retrieve type of decoded symbol.
static IntPtr zbar_symbol_get_data (IntPtr symbol)
 retrieve data decoded from symbol.
static uint zbar_symbol_get_data_length (IntPtr symbol)
 retrieve length of binary data.
static int zbar_symbol_get_quality (IntPtr symbol)
 retrieve a symbol confidence metric.
static int zbar_symbol_get_count (IntPtr symbol)
 retrieve current cache count.
static uint zbar_symbol_get_loc_size (IntPtr symbol)
 retrieve the number of points in the location polygon. the location polygon defines the image area that the symbol was extracted from.
static int zbar_symbol_get_loc_x (IntPtr symbol, uint index)
 retrieve location polygon x-coordinates. points are specified by 0-based index.
static int zbar_symbol_get_loc_y (IntPtr symbol, uint index)
 retrieve location polygon y-coordinates. points are specified by 0-based index.
static internal IntPtr zbar_symbol_next (IntPtr symbol)
 iterate the result set.
static IntPtr zbar_symbol_xml (IntPtr symbol, out IntPtr buffer, out uint buflen)
 print XML symbol element representation to user result buffer.

Private Attributes

string data
int quality
int count
SymbolType type

Detailed Description

Representation of a decoded symbol.

This symbol does not hold any references to unmanaged resources.

Definition at line 33 of file Symbol.cs.


Constructor & Destructor Documentation

internal ZBar.Symbol.Symbol ( IntPtr  symbol  )  [private]

Initialize a symbol from pointer to a symbol.

Parameters:
symbol Pointer to a symbol

Definition at line 41 of file Symbol.cs.


Member Function Documentation

override string ZBar.Symbol.ToString (  ) 

Definition at line 61 of file Symbol.cs.

static int ZBar.Symbol.zbar_symbol_get_count ( IntPtr  symbol  )  [private]

retrieve current cache count.

when the cache is enabled for the image_scanner this provides inter-frame reliability and redundancy information for video streams.

Returns:
< 0 if symbol is still uncertain. 0 if symbol is newly verified. > 0 for duplicate symbols
static IntPtr ZBar.Symbol.zbar_symbol_get_data ( IntPtr  symbol  )  [private]

retrieve data decoded from symbol.

Returns:
the data string
static uint ZBar.Symbol.zbar_symbol_get_data_length ( IntPtr  symbol  )  [private]

retrieve length of binary data.

Returns:
the length of the decoded data
static uint ZBar.Symbol.zbar_symbol_get_loc_size ( IntPtr  symbol  )  [private]

retrieve the number of points in the location polygon. the location polygon defines the image area that the symbol was extracted from.

Returns:
the number of points in the location polygon

this is currently not a polygon, but the scan locations where the symbol was decoded

static int ZBar.Symbol.zbar_symbol_get_loc_x ( IntPtr  symbol,
uint  index 
) [private]

retrieve location polygon x-coordinates. points are specified by 0-based index.

Returns:
the x-coordinate for a point in the location polygon. -1 if index is out of range
static int ZBar.Symbol.zbar_symbol_get_loc_y ( IntPtr  symbol,
uint  index 
) [private]

retrieve location polygon y-coordinates. points are specified by 0-based index.

Returns:
the y-coordinate for a point in the location polygon. -1 if index is out of range
static int ZBar.Symbol.zbar_symbol_get_quality ( IntPtr  symbol  )  [private]

retrieve a symbol confidence metric.

Returns:
an unscaled, relative quantity: larger values are better than smaller values, where "large" and "small" are application dependent.

expect the exact definition of this quantity to change as the metric is refined. currently, only the ordered relationship between two values is defined and will remain stable in the future

static int ZBar.Symbol.zbar_symbol_get_type ( IntPtr  symbol  )  [private]

retrieve type of decoded symbol.

Returns:
the symbol type
static internal IntPtr ZBar.Symbol.zbar_symbol_next ( IntPtr  symbol  )  [private]

iterate the result set.

Returns:
the next result symbol, or NULL when no more results are available

Marked internal because it is used by the symbol iterators.

static void ZBar.Symbol.zbar_symbol_ref ( IntPtr  symbol,
int  refs 
) [private]

symbol reference count manipulation.

increment the reference count when you store a new reference to the symbol. decrement when the reference is no longer used. do not refer to the symbol once the count is decremented and the containing image has been recycled or destroyed. the containing image holds a reference to the symbol, so you only need to use this if you keep a symbol after the image has been destroyed or reused.

static IntPtr ZBar.Symbol.zbar_symbol_xml ( IntPtr  symbol,
out IntPtr  buffer,
out uint  buflen 
) [private]

print XML symbol element representation to user result buffer.

see http://zbar.sourceforge.net/2008/barcode.xsd for the schema.

Parameters:
symbol is the symbol to print
buffer is the inout result pointer, it will be reallocated with a larger size if necessary.
buflen is inout length of the result buffer.
Returns:
the buffer pointer

Member Data Documentation

int ZBar.Symbol.count [private]

Definition at line 58 of file Symbol.cs.

string ZBar.Symbol.data [private]

Definition at line 56 of file Symbol.cs.

int ZBar.Symbol.quality [private]

Definition at line 57 of file Symbol.cs.

Definition at line 59 of file Symbol.cs.


Property Documentation

int ZBar.Symbol.Count [get]

Retrieve current cache count.

When the cache is enabled for the image_scanner this provides inter-frame reliability and redundancy information for video streams. < 0 if symbol is still uncertain. 0 if symbol is newly verified. > 0 for duplicate symbols

Definition at line 76 of file Symbol.cs.

string ZBar.Symbol.Data [get]

Data decoded from symbol.

Definition at line 85 of file Symbol.cs.

int ZBar.Symbol.Quality [get]

Get a symbol confidence metric.

An unscaled, relative quantity: larger values are better than smaller values, where "large" and "small" are application dependent.

Definition at line 97 of file Symbol.cs.

SymbolType ZBar.Symbol.Type [get]

Type of decoded symbol

Definition at line 106 of file Symbol.cs.


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

Foodolini 1.0.0 Documentation, generated with DoxyGen.