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

The Structure class. More...

Public Member Functions

 setAlignment (int alignment)
 Set alignment. The structure is placed at a multiple of the alignment value. More...
 
int getAlignment ()
 Get alignment. The structure is placed at a multiple of the alignment value. More...
 
String getDescription ()
 Get structure description. More...
 
 setDescription (String description)
 Set structure description. More...
 
String getName ()
 Get name. Get name of structure. More...
 
 setName (String name)
 Set name. Set name of structure. More...
 
 setDisabled (BOOL disabled)
 Disable/Enable structure for parsing. More...
 
 setLength (String length, LENGTH_UNIT lengthUnit)
 Set length of structure. More...
 
 setRepeatMin (String repeatMin)
 Set minimum repeat count of structure. More...
 
 setRepeatMax (String repeatMax)
 Set maximum repeat count of structure. More...
 
int getElementCount ()
 Get element count. More...
 
Element getElementByIndex (int index)
 Get element by index. More...
 
Element getElementByName (String name)
 Get element by name. More...
 
 setDefaultEncoding (String defaultEncoding)
 Set default encoding. The default encoding will be used for all strings that don't specify the encoding explicitely. More...
 
String getDefaultEncoding ()
 Get default encoding. The default encoding will be used for all strings that don't specify the encoding explicitely. More...
 
 setElementOrder (ORDER_TYPE order)
 Set element order. Variable order selects one matching element. Fixed order maps all elements consecutively. More...
 
int appendElement (Element *element)
 Append element. More...
 
void insertElementAtIndex (Element *element, int index)
 Insert element at certain index. More...
 
void deleteElementAtIndex (int index)
 Delete element at index. More...
 

Detailed Description

The Structure class.

A structure object represents a structure in a grammar.

Author
Andreas Pehnack

Member Function Documentation

int appendElement ( Element element)

Append element.

Author
Andreas Pehnack
Date
2013-04-14
Parameters
[in]elementThe 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]indexThe index where to delete
See Also
appendElement
int getAlignment ( )

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
String getDefaultEncoding ( )

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
String getDescription ( )

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 index.

Author
Andreas Pehnack
Date
2012-02-05
Returns
The requested structure element
See Also
getElementCount
getElementByName
Element getElementByName ( String  name)

Get element by name.

Author
Andreas Pehnack
Date
2012-02-05
Returns
The requested structure element
See Also
getElementByIndex
int getElementCount ( )

Get element count.

Author
Andreas Pehnack
Date
2012-02-05
Returns
The number of elements in the structure
See Also
getElementByIndex
String getName ( )

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]elementThe element to be inserted
[in]indexThe 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]alignmentThe 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]defaultEncodingThe 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]descriptionThe description of the structure
See Also
getDescription()
Author
Andreas Pehnack
Date
2009-11-07
Parameters
[in]descriptionThe default encoding
See Also
getDefaultEncoding
setDisabled ( BOOL  disabled)

Disable/Enable structure for parsing.

Author
Andreas Pehnack
Date
2013-04-14
Parameters
[in]disabledDisable/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]orderThe 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]lengthThe new length of the structure
[in]lengthUnitThe new length unit of the structure
See Also
getLength
setName ( String  name)

Set name. Set name of structure.

Author
Andreas Pehnack
Date
2012-05-09
Parameters
[in]nameThe 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]repeatMaxThe 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]repeatMinThe new min repeat count of the structure
See Also
setRepeatMax

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