Synalyze It!  1.10
Public Member Functions | List of all members
NumberElement Class Reference

The NumberElement class. More...

Inheritance diagram for NumberElement:
Element

Public Member Functions

NUMBER_DISPLAY_TYPE getNumberDisplayType ()
 Get number display. More...
 
 setNumberDisplayType (NUMBER_DISPLAY_TYPE numberDisplayType)
 Set number display. More...
 
 setNumberType (NUMBER_TYPE type)
 Set number type. More...
 
NUMBER_TYPE getNumberType ()
 Get number type. More...
 
 setEndianness (ENDIAN_TYPE endianness)
 Set endianness. More...
 
ENDIAN_TYPE getEndianness ()
 Get endianness. More...
 
 setSigned (bool signed)
 Set number element to signed/unsigned? More...
 
bool isSigned ()
 Is number element of type signed? More...
 
- Public Member Functions inherited from Element
Element Element (ELEMENT_TYPE type, String name, bool setDefaults)
 Constructor. More...
 
String getName ()
 Get name. More...
 
 setName (String name)
 Set name. More...
 
String getDescription ()
 Get description. More...
 
 setDescription (String name)
 Set description. More...
 
 setDisabled (BOOL disabled)
 Set disabled. More...
 
 addFixedValue (Value value)
 Add fixed value. More...
 
Structure getEnclosingStructure ()
 Get enclosing structure. More...
 
String getLength ()
 Get length. More...
 
LENGTH_UNIT getLengthUnit ()
 Get length unit. More...
 
 setColorRgb (float red, float green, float blue)
 Set fill color (RGB). More...
 
 setLength (String length, LENGTH_UNIT lengthUnit)
 Set length. More...
 
ELEMENT_TYPE getType ()
 Get type. More...
 
bool mustMatch ()
 Get "must match" flag. More...
 
 setMustMatch (BOOL mustMatch)
 Set "must match" flag. More...
 
Value getMinValue ()
 Get minimum value. More...
 
Value getMaxValue ()
 Get maximum value. More...
 
Element getParent ()
 Get parent. More...
 

Detailed Description

The NumberElement class.

A number element object represents one number item in a structure.

Author
Andreas Pehnack

Member Function Documentation

◆ getEndianness()

ENDIAN_TYPE getEndianness ( )

Get endianness.

Get endianness of number element.

Author
Andreas Pehnack
Date
2012-05-11
Returns
The endianness of the number

◆ getNumberDisplayType()

NUMBER_DISPLAY_TYPE getNumberDisplayType ( )

Get number display.

Get number display type. This determines how a number is displayed and can be one of

  • NUMBER_DISPLAY_DECIMAL
  • NUMBER_DISPLAY_EXPONENT
  • NUMBER_DISPLAY_HEX
  • NUMBER_DISPLAY_OCTAL
  • NUMBER_DISPLAY_BINARY
Author
Andreas Pehnack
Date
2012-05-11
Returns
Does the element parse a signed number?

◆ getNumberType()

NUMBER_TYPE getNumberType ( )

Get number type.

Get number type of number element. This can be one of

  • NUMBER_INTEGER
  • NUMBER_FLOAT
Author
Andreas Pehnack
Date
2012-05-11
Returns
The number type of the number element.
See also
setNumberType

◆ isSigned()

bool isSigned ( )

Is number element of type signed?

Query if the number element parses a signed or an unsigned value

Author
Andreas Pehnack
Date
2012-05-11
Returns
Does the element parse a signed number?
See also
setSigned

◆ setEndianness()

setEndianness ( ENDIAN_TYPE  endianness)

Set endianness.

Set endianness of number element.

@author Andreas Pehnack
@date 2015-09-01
@see getEndianness

◆ setNumberDisplayType()

setNumberDisplayType ( NUMBER_DISPLAY_TYPE  numberDisplayType)

Set number display.

Set number display type. This determines how a number is displayed and can be one of

  • NUMBER_DISPLAY_DECIMAL
  • NUMBER_DISPLAY_EXPONENT
  • NUMBER_DISPLAY_HEX
  • NUMBER_DISPLAY_OCTAL
  • NUMBER_DISPLAY_BINARY
Parameters
[in]numberDisplayTypeType for number display in parsing results
Author
Andreas Pehnack
Date
2014-09-30

◆ setNumberType()

setNumberType ( NUMBER_TYPE  type)

Set number type.

Set number type of number element. This can be one of

  • NUMBER_INTEGER
  • NUMBER_FLOAT
@author Andreas Pehnack
@date 2015-09-01
@see getNumberType

◆ setSigned()

setSigned ( bool  signed)

Set number element to signed/unsigned?

Set if the number element parses a signed or an unsigned value

Author
Andreas Pehnack
Date
2015-09-02
See also
isSigned

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