The Structure class.
More...
The Structure class.
A structure object represents a structure in a grammar.
- Author
- Andreas Pehnack
int appendElement |
( |
Element * |
element | ) |
|
Append element.
- Author
- Andreas Pehnack
- Date
- 2013-04-14
- Parameters
-
[in] | element | The element to be appended |
- Returns
- The index of the appended element
- See Also
- insertElementAtIndex
void deleteElementAtIndex |
( |
int |
index | ) |
|
Delete element at index.
- Author
- Andreas Pehnack
- Date
- 2013-04-14
- Parameters
-
[in] | index | The index where to delete |
- See Also
- appendElement
Get alignment. The structure is placed at a multiple of the alignment value.
- Author
- Andreas Pehnack
- Date
- 2009-10-22
- Returns
- The alignment value
- See Also
- setAlignent
Get default encoding. The default encoding will be used for all strings that don't specify the encoding explicitely.
- Author
- Andreas Pehnack
- Date
- 2009-11-07
- Returns
- The default encoding
- See Also
- getDefaultEncoding
Get structure description.
- Author
- Andreas Pehnack
- Date
- 2012-05-12
- Returns
- The description of the structure
- See Also
- setDescription()
Element getElementByIndex |
( |
int |
index | ) |
|
Get element by name.
- Author
- Andreas Pehnack
- Date
- 2012-02-05
- Returns
- The requested structure element
- See Also
- getElementByIndex
Get element count.
- Author
- Andreas Pehnack
- Date
- 2012-02-05
- Returns
- The number of elements in the structure
- See Also
- getElementByIndex
Get name. Get name of structure.
- Author
- Andreas Pehnack
- Date
- 2012-05-09
- Returns
- The name of the structure
- See Also
- setName
- Author
- Andreas Pehnack
- Date
- 2012-05-09
- Returns
- The name of the structure
- See Also
- setDisabled
void insertElementAtIndex |
( |
Element * |
element, |
|
|
int |
index |
|
) |
| |
Insert element at certain index.
- Author
- Andreas Pehnack
- Date
- 2013-04-14
- Parameters
-
[in] | element | The element to be inserted |
[in] | index | The index where to insert |
- See Also
- appendElement
setAlignment |
( |
int |
alignment | ) |
|
Set alignment. The structure is placed at a multiple of the alignment value.
- Author
- Andreas Pehnack
- Date
- 2009-10-22
- Parameters
-
[in] | alignment | The alignment value |
- See Also
- getAlignent
setDefaultEncoding |
( |
String |
defaultEncoding | ) |
|
Set default encoding. The default encoding will be used for all strings that don't specify the encoding explicitely.
- Author
- Andreas Pehnack
- Date
- 2009-11-07
- Parameters
-
[in] | defaultEncoding | The default encoding |
- See Also
- getDefaultEncoding
setDescription |
( |
String |
description | ) |
|
Set structure description.
Set description. The description is just for documentation purposes.
- Author
- Andreas Pehnack
- Date
- 2012-05-12
- Parameters
-
[in] | description | The description of the structure |
- See Also
- getDescription()
- Author
- Andreas Pehnack
- Date
- 2009-11-07
- Parameters
-
[in] | description | The default encoding |
- See Also
- getDefaultEncoding
setDisabled |
( |
BOOL |
disabled | ) |
|
Disable/Enable structure for parsing.
- Author
- Andreas Pehnack
- Date
- 2013-04-14
- Parameters
-
[in] | disabled | Disable/enable the structure |
- See Also
- getDisabled()
setElementOrder |
( |
ORDER_TYPE |
order | ) |
|
Set element order. Variable order selects one matching element. Fixed order maps all elements consecutively.
- Author
- Andreas Pehnack
- Date
- 2013-04-14
- Parameters
-
[in] | order | The element order in the structure |
- See Also
- getElementOrder
setLength |
( |
String |
length, |
|
|
LENGTH_UNIT |
lengthUnit |
|
) |
| |
Set length of structure.
- Author
- Andreas Pehnack
- Date
- 2013-04-14
- Parameters
-
[in] | length | The new length of the structure |
[in] | lengthUnit | The new length unit of the structure |
- See Also
- getLength
Set name. Set name of structure.
- Author
- Andreas Pehnack
- Date
- 2012-05-09
- Parameters
-
[in] | name | The new name of the structure |
- See Also
- getName
setRepeatMax |
( |
String |
repeatMax | ) |
|
Set maximum repeat count of structure.
- Author
- Andreas Pehnack
- Date
- 2013-04-14
- Parameters
-
[in] | repeatMax | The new max repeat count of the structure |
- See Also
- setRepeatMin
setRepeatMin |
( |
String |
repeatMin | ) |
|
Set minimum repeat count of structure.
- Author
- Andreas Pehnack
- Date
- 2013-04-14
- Parameters
-
[in] | repeatMin | The new min repeat count of the structure |
- See Also
- setRepeatMax
The documentation for this class was generated from the following file:
- Generated/synalysis_wrap_lua.c