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

The StringElement class. More...

Inheritance diagram for StringElement:
Element

Public Member Functions

String getEncoding ()
 Get encoding. More...
 
 setEncoding (String encoding)
 Set encoding. More...
 
int getBytesPerChar ()
 Get bytes per character. More...
 
STRING_LENGTH_TYPE getLengthType ()
 Get string length type. 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...
 
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 StringElement class.

A string element object represents one binary item in a structure.

Author
Andreas Pehnack

Member Function Documentation

int getBytesPerChar ( )

Get bytes per character.

Get the number of bytes a character needs. This information is derived from the selected string encoding

Author
Andreas Pehnack
Date
2012-05-11
Returns
The number of bytes per character
See also
getEncoding
String getEncoding ( )

Get encoding.

Get encoding of string element.

Author
Andreas Pehnack
Date
2012-05-11
Returns
The encoding of the string element
See also
setEncoding
STRING_LENGTH_TYPE getLengthType ( )

Get string length type.

Get length type of string element. Valid types are:

  • STRING_LENGTH_FIXED
  • STRING_LENGTH_ZERO_TERMINATED
  • STRING_LENGTH_PASCAL
  • STRING_LENGTH_DELIMITER_TERMINATED
Author
Andreas Pehnack
Date
2012-05-15
Returns
The length type of the string element
setEncoding ( String  encoding)

Set encoding.

Set string encoding of element.

Author
Andreas Pehnack
Date
2012-05-15
Parameters
[in]encodingThe new string encoding of the element
See also
getEncoding

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