Synalyze It!  1.1
 All Classes Functions Pages
Public Member Functions | List of all members
Result Class Reference

The Result class. More...

Public Member Functions

Value getValue ()
 Get value. More...
 
Mask getMask ()
 Get mask. More...
 
ByteView getByteView ()
 byte view. More...
 
int getLevel ()
 Get level. More...
 
int getIteration ()
 Get iteration. More...
 
int getStartBytePos ()
 Get start (byte). More...
 
int getStartBitPos ()
 Get start (bit). More...
 
int getByteLength ()
 Get length (bytes). More...
 
int getBitLength ()
 Get length (bits). More...
 
String getName ()
 Get name. More...
 
Structure getStructure ()
 Get structure. More...
 
Element getElement ()
 Get structure element. More...
 

Detailed Description

The Result class.

Result objects are created during the structure mapping process. Depending on their type they refer to a structure or struct element and a value.

Author
Andreas Pehnack
Date
2009-09-08

Member Function Documentation

int getBitLength ( )

Get length (bits).

Returns the bit length of the result in the input file.

Author
Andreas Pehnack
Date
2012-04-22
Returns
The bit length of the result
int getByteLength ( )

Get length (bytes).

Returns the byte length of the result in the input file.

Author
Andreas Pehnack
Date
2012-04-22
Returns
The byte length of the result
ByteView getByteView ( )

byte view.

Returns the byte view object the result was created for. This is useful to access the raw data of large binary element results.

Author
Andreas Pehnack
Date
2014-01-26
Returns
The level of the result
Element getElement ( )

Get structure element.

Returns the structure elementof the result. This is only valid if the result ist of type structure.

Author
Andreas Pehnack
Date
2012-04-22
Returns
The structure element of the result
int getIteration ( )

Get iteration.

Returns the interation of a result in a sequence of repeated elements.

Author
Andreas Pehnack
Date
2012-04-22
Returns
The iteration of the result
int getLevel ( )

Get level.

Returns the level of a result in the results tree.

Author
Andreas Pehnack
Date
2012-04-22
Returns
The level of the result
Mask getMask ( )

Get mask.

Mask results refer to a mask object.

Author
Andreas Pehnack
Date
2012-03-22
Returns
The mask or NULL if there is none
String getName ( )

Get name.

Returns the name of the result.

Author
Andreas Pehnack
Date
2012-04-22
Returns
The name of the result
int getStartBitPos ( )

Get start (bit).

Returns the bit position of the result in the input file.

Author
Andreas Pehnack
Date
2012-04-22
Returns
The byte position of the result
int getStartBytePos ( )

Get start (byte).

Returns the byte position of the result in the input file.

Author
Andreas Pehnack
Date
2012-04-22
Returns
The byte position of the result
Structure getStructure ( )

Get structure.

Returns the structure of the result. This is only valid if the result ist of type structure.

Author
Andreas Pehnack
Date
2012-04-22
Returns
The structure of the result
Value getValue ( )

Get value.

Each result has a value.

Author
Andreas Pehnack
Date
2009-09-08
Returns
The value or NULL if there is none

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