The StructureElement class. More...
Public Member Functions | |
Structure | getStructure () |
Get structure. Get structure of element. This is only valid for elements of type ELEMENT_STRUCTURE. | |
![]() | |
Element | Element (ELEMENT_TYPE type, String name, BOOL setDefaults) |
Constructor. Create object of type Element. | |
String | getName () |
Get name. Get name of element. | |
setName (String name) | |
Set name. Set name of element. | |
String | getDescription () |
Get description. Get description of element. | |
setDescription (String name) | |
Set description. Set description of element. | |
String | getEnclosingStructure () |
Get enclosing structure. Get the enclosing structure of the element. | |
String | getLength () |
Get length. Get length of element. For binary or string elements a length of zero means to fill the enclosing structure. Be aware that lengths can be fractions of bytes so call additionally getLengthUnit() | |
LENGTH_UNIT | getLengthUnit () |
Get length unit. Get length unit of element in bits. Valid values are. | |
setLength (String length, LENGTH_UNIT lengthUnit) | |
Set length. Set length of element. For binary or string elements a length of zero means to fill the enclosing structure. The length can contain variables and expressions. For number and binary elements you can specify a length unit . | |
ELEMENT_TYPE | getType () |
Get type. Get type of element. This can be one of. | |
BOOL | mustMatch () |
Get "must match" flag. Get if this element has to match while parsing a file. For this check the min/max values are checked and if one of the fixed values matches (if at least one is defined) | |
setMustMatch (BOOL mustMatch) | |
Set "must match" flag. Set if this element has to match while parsing a file. For this check the min/max values are checked and if one of the fixed values matches (if at least one is defined) | |
Value | getMinValue () |
Get minimum value. Get minimum value of element. This is only valid for numbers. This value will be checked if the "must match" flag is set. | |
Element | getParent () |
Get parent. Get parent of element. There is only a parent element if the enclosing structure is inherited from another structure. | |
The StructureElement class.
A structure element object represents one structure item inside another structure.
Structure getStructure | ( | ) |
Get structure. Get structure of element. This is only valid for elements of type ELEMENT_STRUCTURE.