Sie sind auf Seite 1von 533

Traffic Light Controller

Generated by Doxygen 1.8.6


Wed Apr 20 2016 18:16:52

Contents

Todo List

Hierarchical Index

2.1

Class Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Class Index

3.1

Class List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

File Index

13

4.1

13

File List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Class Documentation

17

5.1

AbstractMutex Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

17

5.1.1

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

17

TraCIAPI::AreaScope Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

18

5.2.1

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

18

5.2

Detailed Description

Detailed Description

5.3

BiArc Class Reference

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

18

5.4

BiArcParams Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

19

5.5

BinaryFormatter Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

19

5.5.1

Detailed Description

21

5.5.2

Member Function Documentation

5.6

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

21

5.5.2.1

closeTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

21

5.5.2.2

openTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

21

5.5.2.3

openTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

21

5.5.2.4

writeAttr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

22

5.5.2.5

writeAttr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

22

5.5.2.6

writeHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

22

5.5.2.7

writePreformattedTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

22

5.5.2.8

writeXMLHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

22

BinaryInputDevice Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

24

5.6.1

Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

25

5.6.2

Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . .

25

5.6.2.1

25

BinaryInputDevice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

iv

CONTENTS

5.6.3

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

25

5.6.3.1

good . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

25

5.6.3.2

peek . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

25

5.6.3.3

putback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

26

5.6.3.4

read . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

26

Friends And Related Function Documentation . . . . . . . . . . . . . . . . . . . . . . . .

26

5.6.4.1

operator>> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

26

5.6.4.2

operator>> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

26

5.6.4.3

operator>> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

26

5.6.4.4

operator>> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

27

5.6.4.5

operator>> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

27

5.6.4.6

operator>> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

27

5.6.4.7

operator>> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

27

5.6.4.8

operator>> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

28

5.6.4.9

operator>> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

28

5.6.4.10 operator>> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

28

5.6.4.11 operator>> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

29

BoolFormatException Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

29

5.7.1

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

29

5.8

Network::Buffer_Empty Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

30

5.9

Command Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

30

5.9.1

Detailed Description

30

5.9.2

Member Function Documentation

5.6.4

5.7

Member Function Documentation

Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

31

execute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

31

5.10 Named::ComparatorIdLess Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

31

5.9.2.1

5.10.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

31

5.11 Component Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

31

5.11.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

32

5.11.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . .

33

5.11.2.1 Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

33

5.11.3 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

33

5.11.3.1 component_sync_operation . . . . . . . . . . . . . . . . . . . . . . . . . . . .

33

5.11.3.2 init_timer_operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

33

5.11.3.3 startUp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

33

5.11.4 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

33

5.11.4.1 comp_queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

33

5.11.4.2 comp_sync_pub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

33

5.11.4.3 comp_sync_sub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

34

5.11.4.4 config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

34

5.11.4.5 init_timer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

34

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

CONTENTS

5.11.4.6 logger

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

34

5.11.4.7 node_argc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

34

5.11.4.8 node_argv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

34

5.12 ComponentConfig Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

34

5.13 Connection Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

35

5.14 control_stream_ddos Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

35

5.14.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

36

5.14.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . .

36

5.14.2.1 control_stream_ddos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

36

5.14.3 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

36

5.14.3.1 component_sync_operation . . . . . . . . . . . . . . . . . . . . . . . . . . . .

36

5.14.3.2 init_timer_operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

37

5.14.3.3 startUp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

37

5.14.4 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

37

5.14.4.1 comp_queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

37

5.14.4.2 comp_sync_pub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

37

5.14.4.3 comp_sync_sub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

37

5.14.4.4 config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

37

5.14.4.5 init_timer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

37

5.14.4.6 logger

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

37

5.14.4.7 node_argc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

38

5.14.4.8 node_argv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

38

5.15 controller Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

38

5.15.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

39

5.15.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . .

39

5.15.2.1 controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

39

5.15.3 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

39

5.15.3.1 component_sync_operation . . . . . . . . . . . . . . . . . . . . . . . . . . . .

39

5.15.3.2 controller_timer_operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

39

5.15.3.3 init_timer_operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

39

5.15.3.4 ryg_state_sub_operation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . .

40

5.15.3.5 sensor_state_sub_operation . . . . . . . . . . . . . . . . . . . . . . . . . . . .

40

5.15.3.6 startUp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

40

5.15.4 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

40

5.15.4.1 comp_queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

40

5.15.4.2 comp_sync_pub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

40

5.15.4.3 comp_sync_sub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

40

5.15.4.4 config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

40

5.15.4.5 init_timer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

41

5.15.4.6 logger

41

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

vi

CONTENTS

5.15.4.7 node_argc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

41

5.15.4.8 node_argv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

41

5.16 CSVIterator Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

41

5.17 CSVRow Class Reference

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

41

5.18 e3_sensor Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

42

5.18.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

42

5.18.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . .

43

5.18.2.1 e3_sensor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

43

5.18.3 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

43

5.18.3.1 component_sync_operation . . . . . . . . . . . . . . . . . . . . . . . . . . . .

43

5.18.3.2 e3_update_timer_operation . . . . . . . . . . . . . . . . . . . . . . . . . . . .

43

5.18.3.3 init_timer_operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

43

5.18.3.4 startUp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

43

5.18.4 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

43

5.18.4.1 comp_queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

44

5.18.4.2 comp_sync_pub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

44

5.18.4.3 comp_sync_sub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

44

5.18.4.4 config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

44

5.18.4.5 init_timer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

44

5.18.4.6 logger

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

44

5.18.4.7 node_argc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

44

5.18.4.8 node_argv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

44

5.19 e3_sensor_stream_ddos Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

44

5.19.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

45

5.19.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . .

45

5.19.2.1 e3_sensor_stream_ddos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

45

5.19.3 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

45

5.19.3.1 component_sync_operation . . . . . . . . . . . . . . . . . . . . . . . . . . . .

45

5.19.3.2 init_timer_operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

46

5.19.3.3 startUp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

46

5.19.4 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

46

5.19.4.1 comp_queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

46

5.19.4.2 comp_sync_pub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

46

5.19.4.3 comp_sync_sub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

46

5.19.4.4 config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

46

5.19.4.5 init_timer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

46

5.19.4.6 logger

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

46

5.19.4.7 node_argc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

47

5.19.4.8 node_argv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

47

5.20 SAXWeightsHandler::EdgeFloatTimeLineRetriever Class Reference

. . . . . . . . . . . . . . . .

47

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

CONTENTS

vii

5.20.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5.20.2 Member Function Documentation

47

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

47

5.20.2.1 addEdgeWeight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

47

5.21 TraCIAPI::EdgeScope Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

48

5.21.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

48

5.22 EmptyData Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

49

5.22.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5.23 StringBijection< T >::Entry Struct Reference

49

. . . . . . . . . . . . . . . . . . . . . . . . . . . .

49

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

49

5.25 EulerSpiralLookupTable Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

50

5.26 EulerSpiralParams Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

50

5.27 Network::Exceeded_Production_profile Class Reference . . . . . . . . . . . . . . . . . . . . . . .

51

5.24 EulerSpiral Class Reference

5.27.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5.28 Network::Exceeded_Production_Profile Class Reference

51

. . . . . . . . . . . . . . . . . . . . . .

51

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

51

5.29 rapidxml::file< Ch > Class Template Reference . . . . . . . . . . . . . . . . . . . . . . . . . . .

51

5.28.1 Detailed Description

5.29.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

52

5.29.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . .

52

5.29.2.1 file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

52

5.29.2.2 file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

52

5.29.3 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

52

5.29.3.1 data

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

52

5.29.3.2 data

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

52

5.29.3.3 size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

53

5.30 FileHelpers Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

53

5.30.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5.30.2 Member Function Documentation

54

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

54

5.30.2.1 checkForRelativity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

54

5.30.2.2 getConfigurationRelative . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

54

5.30.2.3 getFilePath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

54

5.30.2.4 isAbsolute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

55

5.30.2.5 isReadable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

55

5.30.2.6 isSocket . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

55

5.30.2.7 readEdgeVector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

55

5.30.2.8 writeByte . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

56

5.30.2.9 writeEdgeVector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

57

5.30.2.10 writeFloat

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

57

5.30.2.11 writeInt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

57

5.30.2.12 writeString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

57

5.30.2.13 writeTime

58

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

viii

CONTENTS

5.30.2.14 writeUInt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

58

5.31 FormatException Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

58

5.31.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5.32 GenericSAXHandler Class Reference

59

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

59

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

60

5.32.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . .

61

5.32.2.1 GenericSAXHandler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

61

5.32.1 Detailed Description

5.32.3 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

61

5.32.3.1 buildErrorMessage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

61

5.32.3.2 characters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

61

5.32.3.3 endElement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

61

5.32.3.4 error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

62

5.32.3.5 fatalError . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

62

5.32.3.6 getFileName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

62

5.32.3.7 myCharacters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

62

5.32.3.8 myEndElement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

62

5.32.3.9 myStartElement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

63

5.32.3.10 setFileName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

63

5.32.3.11 startElement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

63

5.32.3.12 warning

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

63

5.33 TraCIAPI::GUIScope Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

64

5.33.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

64

5.34 IDSupplier Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

65

5.34.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

65

5.34.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . .

65

5.34.2.1 IDSupplier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

65

5.35 TraCIAPI::InductionLoopScope Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . .

65

5.35.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

66

5.36 invalid_return< X > Struct Template Reference . . . . . . . . . . . . . . . . . . . . . . . . . . .

66

5.37 InvalidArgument Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

66

5.37.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

67

5.38 IOError Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

67

5.39 IPV4_Connection Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

67

5.40 IPV6_Connection Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

68

5.41 TraCIAPI::JunctionScope Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

69

5.41.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

69

5.42 TraCIAPI::LaneScope Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

70

5.42.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

71

5.43 Logger Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

71

5.43.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

71

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

CONTENTS

ix

5.43.2 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

72

5.43.2.1 create_file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

72

5.43.2.2 log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

73

5.43.2.3 set_is_periodic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

73

5.43.2.4 set_logs_to_file

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

73

5.43.2.5 set_max_log_unit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

73

5.44 TraCIAPI::MeMeScope Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

73

5.44.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

74

5.45 rapidxml::memory_pool< Ch > Class Template Reference . . . . . . . . . . . . . . . . . . . . .

74

5.45.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

75

5.45.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . .

75

5.45.2.1 memory_pool

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5.45.3 Member Function Documentation

75

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

75

5.45.3.1 allocate_attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

76

5.45.3.2 allocate_node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

76

5.45.3.3 allocate_string . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

76

5.45.3.4 clear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

77

5.45.3.5 clone_node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

77

5.45.3.6 set_allocator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

77

5.46 Network::Message Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

77

5.47 Network::message_buffer< T > Class Template Reference . . . . . . . . . . . . . . . . . . . . .

78

5.48 MsgHandler Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

79

5.48.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

80

5.48.2 Member Enumeration Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . .

80

5.48.2.1 MsgType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

80

5.48.3 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

80

5.48.3.1 beginProcessMsg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

80

5.48.3.2 operator<< . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

80

5.49 MsgRetrievingFunction< T > Class Template Reference . . . . . . . . . . . . . . . . . . . . . .

81

5.49.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

82

5.49.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . .

82

5.49.2.1 MsgRetrievingFunction

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

82

5.49.3 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

83

5.49.3.1 closeTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

83

5.49.3.2 createDeviceByOption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

83

5.49.3.3 getDevice

83

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5.49.3.4 getDeviceByOption

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

84

5.49.3.5 getOStream . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

84

5.49.3.6 inform

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

84

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

85

5.49.3.7 isBinary

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

CONTENTS

5.49.3.8 ok

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

85

5.49.3.9 openTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

85

5.49.3.10 openTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

85

5.49.3.11 operator<< . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

85

5.49.3.12 realString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

86

5.49.3.13 setPrecision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

87

5.49.3.14 writeAttr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

87

5.49.3.15 writeAttr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

87

5.49.3.16 writeNonEmptyAttr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

87

5.49.3.17 writePreformattedTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

88

5.49.3.18 writeXMLHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

88

5.50 MTRand Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

88

5.51 Named Class Reference

90

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5.51.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

90

5.51.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . .

90

5.51.2.1 Named . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

90

5.51.3 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

90

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

90

5.51.3.2 getID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

91

5.51.3.3 setID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

91

5.52 Named::NamedLikeComparatorIdLess< NamedLike > Struct Template Reference . . . . . . . . .

91

5.51.3.1 addTo

5.52.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

91

5.53 NamedObjectCont< T > Class Template Reference . . . . . . . . . . . . . . . . . . . . . . . . .

91

5.53.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5.53.2 Member Function Documentation

92

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

92

5.53.2.1 add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

92

5.53.2.2 erase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

92

5.53.2.3 get . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

93

5.53.2.4 remove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

93

5.53.2.5 size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

93

5.54 NamedRTree Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

93

5.54.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5.54.2 Member Function Documentation

94

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

94

5.54.2.1 Insert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

94

5.54.2.2 Remove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

94

5.54.2.3 RemoveAll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

95

5.54.2.4 Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

95

5.55 NetworkBuffer Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

95

5.56 Network::NetworkProfile Class Reference

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

96

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

97

5.56.1 Detailed Description

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

CONTENTS

xi

5.56.2 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

97

5.56.2.1 Delay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

97

5.56.2.2 getCurrentInterval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

97

5.56.2.3 getDataAtTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

97

5.56.2.4 getNextInterval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

97

5.56.3 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

97

5.56.3.1 resources

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

97

5.57 NumberFormatException Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

98

5.57.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

98

5.58 Option Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

98

5.58.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

5.58.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 100


5.58.2.1 Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
5.58.3 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

5.58.3.1 getBool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100


5.58.3.2 getDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
5.58.3.3 getFloat

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

5.58.3.4 getInt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101


5.58.3.5 getIntVector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
5.58.3.6 getString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
5.58.3.7 getTypeName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
5.58.3.8 getValueString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
5.58.3.9 isBool

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

5.58.3.10 isDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102


5.58.3.11 isFileName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
5.58.3.12 isSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
5.58.3.13 isWriteable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
5.58.3.14 markSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
5.58.3.15 resetWritable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
5.58.3.16 set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
5.58.3.17 setDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
5.59 Option_Bool Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
5.59.1 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
5.59.1.1 Option_Bool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
5.59.1.2 Option_Bool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
5.59.2 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

5.59.2.1 getBool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106


5.59.2.2 getDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
5.59.2.3 getFloat

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

5.59.2.4 getInt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106


Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

xii

CONTENTS

5.59.2.5 getIntVector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107


5.59.2.6 getString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
5.59.2.7 getTypeName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
5.59.2.8 getValueString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
5.59.2.9 isBool

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

5.59.2.10 isDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108


5.59.2.11 isFileName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
5.59.2.12 isSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
5.59.2.13 isWriteable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
5.59.2.14 markSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
5.59.2.15 resetWritable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
5.59.2.16 setDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
5.60 Option_FileName Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
5.60.1 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
5.60.1.1 Option_FileName

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

5.60.2 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

5.60.2.1 getBool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112


5.60.2.2 getDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
5.60.2.3 getFloat

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

5.60.2.4 getInt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112


5.60.2.5 getIntVector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
5.60.2.6 getString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
5.60.2.7 getTypeName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
5.60.2.8 getValueString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
5.60.2.9 isBool

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

5.60.2.10 isDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114


5.60.2.11 isFileName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
5.60.2.12 isSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
5.60.2.13 isWriteable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
5.60.2.14 markSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
5.60.2.15 resetWritable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
5.60.2.16 set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
5.60.2.17 setDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
5.61 Option_Float Class Reference

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

5.61.1 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 117


5.61.1.1 Option_Float . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
5.61.1.2 Option_Float . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
5.61.2 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

5.61.2.1 getBool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117


5.61.2.2 getDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

CONTENTS

xiii

5.61.2.3 getFloat

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

5.61.2.4 getInt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118


5.61.2.5 getIntVector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
5.61.2.6 getString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
5.61.2.7 getTypeName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
5.61.2.8 getValueString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
5.61.2.9 isBool

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

5.61.2.10 isDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119


5.61.2.11 isFileName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
5.61.2.12 isSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
5.61.2.13 isWriteable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
5.61.2.14 markSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
5.61.2.15 resetWritable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
5.61.2.16 set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
5.61.2.17 setDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
5.62 Option_Integer Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
5.62.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

5.62.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 122


5.62.2.1 Option_Integer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
5.62.2.2 Option_Integer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
5.62.3 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

5.62.3.1 getBool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123


5.62.3.2 getDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
5.62.3.3 getFloat

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

5.62.3.4 getInt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123


5.62.3.5 getIntVector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
5.62.3.6 getString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
5.62.3.7 getTypeName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
5.62.3.8 getValueString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
5.62.3.9 isBool

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

5.62.3.10 isDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125


5.62.3.11 isFileName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
5.62.3.12 isSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
5.62.3.13 isWriteable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
5.62.3.14 markSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
5.62.3.15 resetWritable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
5.62.3.16 set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
5.62.3.17 setDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
5.63 Option_IntVector Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
5.63.1 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

xiv

CONTENTS

5.63.1.1 Option_IntVector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128


5.63.2 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

5.63.2.1 getBool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128


5.63.2.2 getDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
5.63.2.3 getFloat

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

5.63.2.4 getInt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129


5.63.2.5 getIntVector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
5.63.2.6 getString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
5.63.2.7 getTypeName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
5.63.2.8 getValueString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
5.63.2.9 isBool

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

5.63.2.10 isDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130


5.63.2.11 isFileName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
5.63.2.12 isSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
5.63.2.13 isWriteable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
5.63.2.14 markSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
5.63.2.15 resetWritable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
5.63.2.16 set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
5.63.2.17 setDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
5.64 Option_String Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
5.64.1 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
5.64.1.1 Option_String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
5.64.1.2 Option_String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
5.64.2 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

5.64.2.1 getBool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133


5.64.2.2 getDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
5.64.2.3 getFloat

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134

5.64.2.4 getInt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134


5.64.2.5 getIntVector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
5.64.2.6 getString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
5.64.2.7 getTypeName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
5.64.2.8 getValueString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
5.64.2.9 isBool

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135

5.64.2.10 isDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136


5.64.2.11 isFileName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
5.64.2.12 isSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
5.64.2.13 isWriteable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
5.64.2.14 markSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
5.64.2.15 resetWritable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
5.64.2.16 set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

CONTENTS

xv

5.64.2.17 setDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137


5.65 Options Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
5.66 OptionsCont Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
5.66.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

5.66.2 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

5.66.2.1 addCallExample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141


5.66.2.2 addCopyrightNotice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
5.66.2.3 addDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
5.66.2.4 addOptionSubTopic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
5.66.2.5 addSynonyme . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
5.66.2.6 checkDependingSuboptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
5.66.2.7 doRegister . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
5.66.2.8 doRegister . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
5.66.2.9 exists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
5.66.2.10 getBool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
5.66.2.11 getFloat

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

5.66.2.12 getInt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144


5.66.2.13 getIntVector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
5.66.2.14 getString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
5.66.2.15 getStringVector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
5.66.2.16 getSynonymes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
5.66.2.17 isBool

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

5.66.2.18 isDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146


5.66.2.19 isInStringVector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
5.66.2.20 isSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
5.66.2.21 isUsableFileList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
5.66.2.22 isWriteable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
5.66.2.23 printHelp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
5.66.2.24 processMetaOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
5.66.2.25 relocateFiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
5.66.2.26 resetWritable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
5.66.2.27 set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
5.66.2.28 setAdditionalHelpMessage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
5.66.2.29 setApplicationDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
5.66.2.30 setApplicationName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
5.66.2.31 unSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
5.66.2.32 writeConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
5.66.2.33 writeSchema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
5.66.2.34 writeXMLHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
5.66.3 Friends And Related Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . 151
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

xvi

CONTENTS

5.66.3.1 operator<< . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151


5.67 OptionsIO Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
5.67.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

5.67.2 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

5.67.2.1 getOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152


5.67.2.2 loadConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
5.68 OptionsLoader Class Reference
5.68.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

5.68.2 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

5.68.2.1 characters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153


5.68.2.2 endElement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
5.68.2.3 error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
5.68.2.4 fatalError . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
5.68.2.5 startElement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
5.68.2.6 warning

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

5.69 OptionsParser Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154


5.69.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

5.69.2 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

5.69.2.1 parse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154


5.70 OutOfBoundsException Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
5.70.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

5.71 OutputDevice Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155


5.71.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

5.71.2 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

5.71.2.1 closeTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157


5.71.2.2 createDeviceByOption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
5.71.2.3 getDevice

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

5.71.2.4 getDeviceByOption
5.71.2.5 inform
5.71.2.6 isBinary
5.71.2.7 ok

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

5.71.2.8 openTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159


5.71.2.9 openTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
5.71.2.10 operator<< . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
5.71.2.11 postWriteHook . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
5.71.2.12 realString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
5.71.2.13 setPrecision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
5.71.2.14 writeAttr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
5.71.2.15 writeAttr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
5.71.2.16 writeNonEmptyAttr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

CONTENTS

xvii

5.71.2.17 writePreformattedTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162


5.71.2.18 writeXMLHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
5.72 OutputDevice_CERR Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
5.72.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164

5.72.2 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164

5.72.2.1 closeTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164


5.72.2.2 createDeviceByOption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
5.72.2.3 getDevice

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164

5.72.2.4 getDevice

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

5.72.2.5 getDeviceByOption

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

5.72.2.6 getOStream . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165


5.72.2.7 inform

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

5.72.2.8 isBinary
5.72.2.9 ok

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

5.72.2.10 openTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166


5.72.2.11 openTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
5.72.2.12 operator<< . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
5.72.2.13 postWriteHook . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
5.72.2.14 realString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
5.72.2.15 setPrecision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
5.72.2.16 writeAttr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
5.72.2.17 writeAttr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
5.72.2.18 writeNonEmptyAttr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
5.72.2.19 writePreformattedTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
5.72.2.20 writeXMLHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
5.73 OutputDevice_COUT Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
5.73.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171

5.73.2 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171

5.73.2.1 closeTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171


5.73.2.2 createDeviceByOption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
5.73.2.3 getDevice

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171

5.73.2.4 getDevice

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172

5.73.2.5 getDeviceByOption

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172

5.73.2.6 getOStream . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172


5.73.2.7 inform
5.73.2.8 isBinary
5.73.2.9 ok

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173

5.73.2.10 openTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173


5.73.2.11 openTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
5.73.2.12 operator<< . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

xviii

CONTENTS

5.73.2.13 postWriteHook . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174


5.73.2.14 realString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
5.73.2.15 setPrecision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
5.73.2.16 writeAttr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
5.73.2.17 writeAttr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
5.73.2.18 writeNonEmptyAttr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
5.73.2.19 writePreformattedTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
5.73.2.20 writeXMLHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
5.74 OutputDevice_File Class Reference
5.74.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178

5.74.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 178


5.74.2.1 OutputDevice_File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
5.74.3 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178

5.74.3.1 closeTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178


5.74.3.2 createDeviceByOption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
5.74.3.3 getDevice

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

5.74.3.4 getDeviceByOption

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

5.74.3.5 getOStream . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180


5.74.3.6 inform

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180

5.74.3.7 isBinary
5.74.3.8 ok

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180

5.74.3.9 openTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180


5.74.3.10 openTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
5.74.3.11 operator<< . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
5.74.3.12 postWriteHook . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
5.74.3.13 realString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
5.74.3.14 setPrecision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
5.74.3.15 writeAttr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
5.74.3.16 writeAttr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
5.74.3.17 writeNonEmptyAttr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
5.74.3.18 writePreformattedTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
5.74.3.19 writeXMLHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
5.75 OutputDevice_Network Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
5.75.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185

5.75.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 185


5.75.2.1 OutputDevice_Network

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185

5.75.3 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185

5.75.3.1 closeTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185


5.75.3.2 createDeviceByOption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
5.75.3.3 getDevice

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

CONTENTS

xix

5.75.3.4 getDeviceByOption

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186

5.75.3.5 getOStream . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186


5.75.3.6 inform

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187

5.75.3.7 isBinary
5.75.3.8 ok

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187

5.75.3.9 openTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187


5.75.3.10 openTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
5.75.3.11 operator<< . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
5.75.3.12 postWriteHook . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
5.75.3.13 realString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
5.75.3.14 setPrecision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
5.75.3.15 writeAttr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
5.75.3.16 writeAttr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
5.75.3.17 writeNonEmptyAttr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
5.75.3.18 writePreformattedTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
5.75.3.19 writeXMLHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
5.76 OutputDevice_String Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
5.76.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

5.76.2 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

5.76.2.1 closeTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192


5.76.2.2 createDeviceByOption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
5.76.2.3 getDevice

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

5.76.2.4 getDeviceByOption

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193

5.76.2.5 getOStream . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193


5.76.2.6 getString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
5.76.2.7 inform
5.76.2.8 isBinary
5.76.2.9 ok

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194

5.76.2.10 openTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194


5.76.2.11 openTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
5.76.2.12 operator<< . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
5.76.2.13 postWriteHook . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
5.76.2.14 realString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
5.76.2.15 setPrecision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
5.76.2.16 writeAttr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
5.76.2.17 writeAttr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
5.76.2.18 writeNonEmptyAttr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
5.76.2.19 writePreformattedTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
5.76.2.20 writeXMLHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
5.77 OutputFormatter Class Reference

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

xx

CONTENTS

5.77.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198

5.77.2 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198

5.77.2.1 closeTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198


5.77.2.2 openTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
5.77.2.3 openTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
5.77.2.4 writeXMLHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
5.78 Parameterised Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
5.78.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200

5.78.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 200


5.78.2.1 Parameterised . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
5.78.3 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200

5.78.3.1 addParameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200


5.78.3.2 addParameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
5.78.3.3 addParameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
5.78.3.4 getMap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
5.78.3.5 getParameter

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201

5.78.3.6 knowsParameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201


5.79 rapidxml::parse_error Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
5.79.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202

5.79.2 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202

5.79.2.1 what . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202


5.79.2.2 where

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202

5.80 PlainXMLFormatter Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202


5.80.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

5.80.2 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

5.80.2.1 closeTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203


5.80.2.2 openTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
5.80.2.3 openTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
5.80.2.4 writeAttr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
5.80.2.5 writeAttr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
5.80.2.6 writeHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
5.80.2.7 writePreformattedTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
5.80.2.8 writeXMLHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
5.81 Point2D< coord_type > Class Template Reference . . . . . . . . . . . . . . . . . . . . . . . . . 205
5.82 TraCIAPI::POIScope Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
5.82.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207

5.83 TraCIAPI::PolygonScope Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207


5.83.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208

5.84 ProcessError Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208


5.84.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

CONTENTS

xxi

5.85 Network::profileMemBuf Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208


5.86 RandHelper Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
5.86.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210

5.87 RandomDistributor< T > Class Template Reference . . . . . . . . . . . . . . . . . . . . . . . . . 210


5.87.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210

5.87.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 210


5.87.2.1 RandomDistributor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
5.87.3 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211

5.87.3.1 add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211


5.87.3.2 get . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
5.87.3.3 getOverallProb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
5.87.3.4 getProbs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
5.87.3.5 getVals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
5.88 Network::receiver Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
5.88.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213

5.89 Network::ResourceEntry Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213


5.89.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213

5.90 RGBColor Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213


5.90.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215

5.90.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 215


5.90.2.1 RGBColor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
5.90.3 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215

5.90.3.1 alpha . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215


5.90.3.2 blue

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215

5.90.3.3 changedBrightness

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215

5.90.3.4 fromHSV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216


5.90.3.5 green . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
5.90.3.6 interpolate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
5.90.3.7 parseColor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
5.90.3.8 parseColorReporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
5.90.3.9 red . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
5.90.3.10 set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
5.90.4 Friends And Related Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . 218
5.90.4.1 operator<< . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
5.91 TraCIAPI::RouteScope Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
5.91.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219

5.92 SAXWeightsHandler Class Reference


5.92.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221

5.92.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 221


5.92.2.1 SAXWeightsHandler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

xxii

CONTENTS

5.92.2.2 SAXWeightsHandler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221


5.92.3 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221

5.92.3.1 buildErrorMessage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221


5.92.3.2 characters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
5.92.3.3 endElement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
5.92.3.4 error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
5.92.3.5 fatalError . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
5.92.3.6 getFileName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
5.92.3.7 myCharacters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
5.92.3.8 myEndElement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
5.92.3.9 myStartElement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
5.92.3.10 setFileName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
5.92.3.11 startElement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
5.92.3.12 warning

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224

5.93 AbstractMutex::ScopedLocker Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . 224


5.93.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225

5.93.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 225


5.93.2.1 ScopedLocker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
5.94 Network::sender Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
5.94.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226

5.95 TraCIAPI::SimulationScope Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226


5.95.1 Detailed Description
5.96 tcpip::Socket Class Reference

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227

5.97 tcpip::SocketException Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228


5.98 StaticCommand< T > Class Template Reference . . . . . . . . . . . . . . . . . . . . . . . . . . 228
5.98.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229

5.98.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 229


5.98.2.1 StaticCommand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
5.98.3 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229

5.98.3.1 deschedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229


5.98.3.2 execute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
5.99 tcpip::Storage Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
5.100Named::StoringVisitor Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
5.100.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231

5.101TraCIServerAPI_Lane::StoringVisitor Class Reference . . . . . . . . . . . . . . . . . . . . . . . . 231


5.101.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232

5.102StringBijection< T > Class Template Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . 232


5.102.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232

5.103StringTokenizer Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232


5.103.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

CONTENTS

xxiii

5.103.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 234


5.103.2.1 StringTokenizer

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234

5.103.2.2 StringTokenizer

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234

5.103.2.3 StringTokenizer

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234

5.103.3 Member Function Documentation


5.103.3.1 next

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234

5.104StringUtils Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234


5.104.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235

5.104.2 Member Function Documentation


5.104.2.1 escapeXML

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235

5.105SUMO_CLIENT Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235


5.105.1 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238

5.105.1.1 check_resultState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238


5.105.1.2 connect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
5.105.1.3 send_commandGetVariable . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
5.105.1.4 send_commandSetValue

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239

5.105.1.5 send_commandSubscribeObjectContext . . . . . . . . . . . . . . . . . . . . . 239


5.105.1.6 send_commandSubscribeObjectVariable . . . . . . . . . . . . . . . . . . . . . 240
5.106sumo_intf Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
5.106.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241

5.106.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 241


5.106.2.1 sumo_intf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
5.106.3 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241

5.106.3.1 component_sync_operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241


5.106.3.2 e3_get_vehicle_number_server_operation . . . . . . . . . . . . . . . . . . . . 242
5.106.3.3 init_timer_operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
5.106.3.4 startUp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
5.106.3.5 sumo_step_timer_operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
5.106.3.6 tlc_get_ryg_state_server_operation . . . . . . . . . . . . . . . . . . . . . . . . 242
5.106.3.7 tlc_set_ryg_state_server_operation . . . . . . . . . . . . . . . . . . . . . . . . 243
5.106.4 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
5.106.4.1 comp_queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
5.106.4.2 comp_sync_pub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
5.106.4.3 comp_sync_sub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
5.106.4.4 config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
5.106.4.5 init_timer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
5.106.4.6 logger

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243

5.106.4.7 node_argc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243


5.106.4.8 node_argv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
5.107SUMORouteHandler Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

xxiv

CONTENTS

5.107.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246

5.107.2 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246

5.107.2.1 buildErrorMessage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246


5.107.2.2 characters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
5.107.2.3 closeRoute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
5.107.2.4 endElement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
5.107.2.5 error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
5.107.2.6 fatalError . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
5.107.2.7 getFileName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
5.107.2.8 myCharacters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
5.107.2.9 myEndElement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
5.107.2.10myStartElement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
5.107.2.11setFileName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
5.107.2.12startElement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
5.107.2.13warning

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250

5.108SUMORouteLoader Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250


5.109SUMORouteLoaderControl Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
5.109.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251

5.110SUMOSAXAttributes Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252


5.110.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253

5.110.2 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253

5.110.2.1 get . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253


5.110.2.2 getBool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
5.110.2.3 getBoundary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
5.110.2.4 getColor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
5.110.2.5 getEdgeFunc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
5.110.2.6 getFloat

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255

5.110.2.7 getFloat

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255

5.110.2.8 getInt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256


5.110.2.9 getLong

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256

5.110.2.10getName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
5.110.2.11getNodeType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
5.110.2.12getOpt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
5.110.2.13getOptSUMOTimeReporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
5.110.2.14getShape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
5.110.2.15getString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
5.110.2.16getStringSecure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
5.110.2.17getStringSecure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
5.110.2.18getStringVector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
5.110.2.19getSUMOTimeReporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

CONTENTS

xxv

5.110.2.20hasAttribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
5.110.2.21hasAttribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
5.110.2.22parseStringSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
5.110.2.23parseStringVector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
5.110.2.24serialize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
5.111SUMOSAXAttributesImpl_Binary Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . 261
5.111.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263

5.111.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 263


5.111.2.1 SUMOSAXAttributesImpl_Binary . . . . . . . . . . . . . . . . . . . . . . . . . 263
5.111.3 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263

5.111.3.1 get . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263


5.111.3.2 getBool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
5.111.3.3 getBoundary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
5.111.3.4 getColor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
5.111.3.5 getEdgeFunc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
5.111.3.6 getFloat

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264

5.111.3.7 getFloat

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265

5.111.3.8 getInt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265


5.111.3.9 getLong

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266

5.111.3.10getName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
5.111.3.11getNodeType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
5.111.3.12getOpt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
5.111.3.13getOptSUMOTimeReporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
5.111.3.14getShape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
5.111.3.15getString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
5.111.3.16getStringSecure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
5.111.3.17getStringSecure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
5.111.3.18getStringVector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
5.111.3.19getSUMOTimeReporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
5.111.3.20hasAttribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
5.111.3.21parseStringSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
5.111.3.22parseStringVector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
5.111.3.23serialize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
5.112SUMOSAXAttributesImpl_Xerces Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . 270
5.112.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272

5.112.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 272


5.112.2.1 SUMOSAXAttributesImpl_Xerces . . . . . . . . . . . . . . . . . . . . . . . . . 272
5.112.3 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272

5.112.3.1 get . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272


5.112.3.2 getBool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

xxvi

CONTENTS

5.112.3.3 getBoundary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273


5.112.3.4 getColor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
5.112.3.5 getEdgeFunc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
5.112.3.6 getFloat

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274

5.112.3.7 getFloat

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274

5.112.3.8 getInt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274


5.112.3.9 getLong

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275

5.112.3.10getName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
5.112.3.11getNodeType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
5.112.3.12getOpt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
5.112.3.13getOptSUMOTimeReporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
5.112.3.14getShape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
5.112.3.15getString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
5.112.3.16getStringSecure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
5.112.3.17getStringSecure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
5.112.3.18getStringVector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
5.112.3.19getSUMOTimeReporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
5.112.3.20hasAttribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
5.112.3.21parseStringSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
5.112.3.22parseStringVector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
5.112.3.23serialize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
5.113SUMOSAXHandler Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
5.113.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280

5.113.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 280


5.113.2.1 SUMOSAXHandler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
5.113.3 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281

5.113.3.1 buildErrorMessage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281


5.113.3.2 characters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
5.113.3.3 endElement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
5.113.3.4 error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
5.113.3.5 fatalError . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
5.113.3.6 getFileName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
5.113.3.7 myCharacters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
5.113.3.8 myEndElement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
5.113.3.9 myStartElement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
5.113.3.10setFileName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
5.113.3.11startElement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
5.113.3.12warning

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283

5.114SUMOSAXReader Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283


5.114.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

CONTENTS

xxvii

5.114.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 284


5.114.2.1 SUMOSAXReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
5.114.3 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284

5.114.3.1 setHandler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284


5.115SUMOVehicleParserHelper Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
5.115.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285

5.115.2 Member Function Documentation


5.115.2.1 beginVTypeParsing

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285

5.115.2.2 closeVTypeParsing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286


5.115.2.3 parseEmissionClass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
5.115.2.4 parseFlowAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
5.115.2.5 parseGuiShape

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287

5.115.2.6 parseVehicleAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287


5.115.2.7 parseVehicleClass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
5.115.2.8 parseVTypeEmbedded . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
5.116SUMOXMLDefinitions Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
5.116.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289

5.117SystemFrame Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289


5.117.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290

5.117.2 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290

5.117.2.1 addConfigurationOptions

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290

5.117.2.2 addReportOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290


5.117.2.3 close . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
5.118SysUtils Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
5.118.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291

5.118.2 Member Function Documentation


5.118.2.1 getCurrentMillis

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291

5.119tl_actuator Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291


5.119.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292

5.119.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 292


5.119.2.1 tl_actuator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
5.119.3 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293

5.119.3.1 component_sync_operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293


5.119.3.2 init_timer_operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
5.119.3.3 ryg_control_sub_operation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . 294

5.119.3.4 startUp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294


5.119.4 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
5.119.4.1 comp_queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
5.119.4.2 comp_sync_pub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
5.119.4.3 comp_sync_sub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

xxviii

CONTENTS

5.119.4.4 config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294


5.119.4.5 init_timer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
5.119.4.6 logger

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295

5.119.4.7 node_argc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295


5.119.4.8 node_argv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
5.120tl_sensor Class Reference

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295

5.120.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296

5.120.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 296


5.120.2.1 tl_sensor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
5.120.3 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296

5.120.3.1 component_sync_operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296


5.120.3.2 init_timer_operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
5.120.3.3 startUp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
5.120.3.4 tl_update_timer_operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
5.120.4 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
5.120.4.1 comp_queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
5.120.4.2 comp_sync_pub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
5.120.4.3 comp_sync_sub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
5.120.4.4 config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
5.120.4.5 init_timer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
5.120.4.6 logger

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297

5.120.4.7 node_argc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297


5.120.4.8 node_argv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
5.121tl_sensor_stream_ddos Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
5.121.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298

5.121.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 299


5.121.2.1 tl_sensor_stream_ddos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
5.121.3 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300

5.121.3.1 component_sync_operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300


5.121.3.2 init_timer_operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
5.121.3.3 startUp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
5.121.4 Member Data Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
5.121.4.1 comp_queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
5.121.4.2 comp_sync_pub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
5.121.4.3 comp_sync_sub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
5.121.4.4 config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
5.121.4.5 init_timer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
5.121.4.6 logger

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301

5.121.4.7 node_argc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301


5.121.4.8 node_argv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

CONTENTS

xxix

5.122SAXWeightsHandler::ToRetrieveDefinition Class Reference . . . . . . . . . . . . . . . . . . . . . 301


5.122.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302

5.123TplConvert Class Reference

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302

5.123.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303

5.124TraCIAPI Class Reference

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303

5.124.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306

5.124.2 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306

5.124.2.1 check_resultState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306


5.124.2.2 connect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
5.124.2.3 send_commandGetVariable . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
5.124.2.4 send_commandSetValue

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307

5.124.2.5 send_commandSubscribeObjectContext . . . . . . . . . . . . . . . . . . . . . 307


5.124.2.6 send_commandSubscribeObjectVariable . . . . . . . . . . . . . . . . . . . . . 307
5.125TraCIAPI::TraCIBoundary Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
5.125.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308

5.126TraCIAPI::TraCIColor Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308


5.127TraCIException Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
5.128TraCIAPI::TraCILink Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
5.129TraCIAPI::TraCILogic Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
5.130TraCIAPI::TraCIPhase Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
5.131TraCIAPI::TraCIPosition Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
5.131.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310

5.132TraCIPositionVector Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310


5.132.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310

5.133TraCIAPI::TraCIScopeWrapper Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . 311


5.133.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311

5.133.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 312


5.133.2.1 TraCIScopeWrapper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
5.134TraCIServer Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
5.134.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313

5.134.2 Member Function Documentation


5.134.2.1 openSocket

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313

5.134.2.2 readTypeCheckingBoundary . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313


5.134.2.3 readTypeCheckingByte

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314

5.134.2.4 readTypeCheckingColor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314


5.134.2.5 readTypeCheckingDouble . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
5.134.2.6 readTypeCheckingInt

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314

5.134.2.7 readTypeCheckingPolygon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315


5.134.2.8 readTypeCheckingPosition2D . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
5.134.2.9 readTypeCheckingString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

xxx

CONTENTS

5.134.2.10readTypeCheckingStringList . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
5.134.2.11readTypeCheckingUnsignedByte . . . . . . . . . . . . . . . . . . . . . . . . . 316
5.134.2.12wasClosed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316
5.134.2.13writeErrorStatusCmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316
5.134.2.14writeStatusCmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316
5.134.2.15writeStatusCmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
5.135TraCIServerAPI_AreaDetector Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
5.135.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317

5.136TraCIServerAPI_ArealDetector Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . 317


5.136.1 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317

5.136.1.1 processGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317


5.137TraCIServerAPI_Edge Class Reference
5.137.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318

5.137.2 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318

5.137.2.1 getShape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318


5.137.2.2 processGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
5.137.2.3 processSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
5.138TraCIServerAPI_InductionLoop Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . 319
5.138.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319

5.138.2 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319

5.138.2.1 getPosition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319


5.138.2.2 getTree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319
5.138.2.3 processGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
5.139TraCIServerAPI_Junction Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321
5.139.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321

5.139.2 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321

5.139.2.1 getPosition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321


5.139.2.2 getTree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321
5.139.2.3 processGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
5.140TraCIServerAPI_Lane Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
5.140.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323

5.140.2 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323

5.140.2.1 getShape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323


5.140.2.2 processGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
5.140.2.3 processSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324
5.141TraCIServerAPI_MeMeDetector Class Reference
5.141.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . 324

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324

5.141.2 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324

5.141.2.1 processGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324


5.142TraCIServerAPI_Person Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

CONTENTS

xxxi

5.142.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325

5.142.2 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325

5.142.2.1 getPosition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325


5.142.2.2 processGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
5.142.2.3 processSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
5.143TraCIServerAPI_POI Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326
5.143.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326

5.143.2 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326

5.143.2.1 getPosition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326


5.143.2.2 getTree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326
5.143.2.3 processGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327
5.143.2.4 processSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328
5.144TraCIServerAPI_Polygon Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328
5.144.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328

5.144.2 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328

5.144.2.1 getShape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328


5.144.2.2 getTree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329
5.144.2.3 processGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329
5.144.2.4 processSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329
5.145TraCIServerAPI_Route Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329
5.145.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329

5.145.2 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330

5.145.2.1 processGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330


5.145.2.2 processSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330
5.146TraCIServerAPI_Simulation Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330
5.146.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331

5.146.2 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331

5.146.2.1 convertCartesianToRoadMap . . . . . . . . . . . . . . . . . . . . . . . . . . . 331


5.146.2.2 getLaneChecking

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331

5.146.2.3 processGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331


5.146.2.4 processSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331
5.147TraCIServerAPI_TLS Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
5.147.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332

5.147.2 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332

5.147.2.1 processGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332


5.147.2.2 processSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
5.148TraCIServerAPI_Vehicle Class Reference
5.148.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333

5.148.2 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333

5.148.2.1 getPosition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333


Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

xxxii

CONTENTS

5.148.2.2 processGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333


5.148.2.3 processSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333
5.149TraCIServerAPI_VehicleType Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334
5.149.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334

5.149.2 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334

5.149.2.1 getVariable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334


5.149.2.2 processGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334
5.149.2.3 processSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334
5.150TraCIAPI::TrafficLightScope Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335
5.150.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335

5.151UnknownElement Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336


5.151.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336

5.152ValueRetriever< T > Class Template Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . 336


5.153ValueSource< T > Class Template Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336
5.154ValueTimeLine< T > Class Template Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . 337
5.154.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337

5.154.2 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337

5.154.2.1 add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337


5.154.2.2 describesTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337
5.154.2.3 fillGaps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338
5.154.2.4 getSplitTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338
5.154.2.5 getValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338
5.155VectorHelper< T > Class Template Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
5.156TraCIAPI::VehicleTypeScope Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
5.156.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340

5.157WrappingCommand< T > Class Template Reference . . . . . . . . . . . . . . . . . . . . . . . . 340


5.157.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341

5.157.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 341


5.157.2.1 WrappingCommand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341
5.157.3 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341

5.157.3.1 deschedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341


5.157.3.2 execute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342
5.158rapidxml::xml_attribute< Ch > Class Template Reference . . . . . . . . . . . . . . . . . . . . . . 342
5.158.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343

5.158.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 343


5.158.2.1 xml_attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343
5.158.3 Member Function Documentation
5.158.3.1 document

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344

5.158.3.2 name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344


5.158.3.3 name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

CONTENTS

xxxiii

5.158.3.4 name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344


5.158.3.5 name_size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345
5.158.3.6 next_attribute

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345

5.158.3.7 parent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345


5.158.3.8 previous_attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345
5.158.3.9 value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346
5.158.3.10value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346
5.158.3.11value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346
5.158.3.12value_size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346
5.159rapidxml::xml_base< Ch > Class Template Reference
5.159.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . 347

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348

5.159.2 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348

5.159.2.1 name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348


5.159.2.2 name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348
5.159.2.3 name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348
5.159.2.4 name_size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348
5.159.2.5 parent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349
5.159.2.6 value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349
5.159.2.7 value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349
5.159.2.8 value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349
5.159.2.9 value_size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350
5.160rapidxml::xml_document< Ch > Class Template Reference . . . . . . . . . . . . . . . . . . . . . 350
5.160.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352

5.160.2 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352

5.160.2.1 allocate_attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352


5.160.2.2 allocate_node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353
5.160.2.3 allocate_string . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353
5.160.2.4 append_attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353
5.160.2.5 append_node

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354

5.160.2.6 clear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354


5.160.2.7 clone_node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354
5.160.2.8 document

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354

5.160.2.9 first_attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354


5.160.2.10first_node

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355

5.160.2.11insert_attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355
5.160.2.12insert_node

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355

5.160.2.13last_attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355
5.160.2.14last_node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
5.160.2.15name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
5.160.2.16name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

xxxiv

CONTENTS

5.160.2.17name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357
5.160.2.18name_size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357
5.160.2.19next_sibling

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357

5.160.2.20parent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357
5.160.2.21parse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358
5.160.2.22prepend_attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358
5.160.2.23prepend_node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358
5.160.2.24previous_sibling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358
5.160.2.25remove_attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359
5.160.2.26remove_first_attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360
5.160.2.27remove_first_node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360
5.160.2.28remove_last_attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360
5.160.2.29remove_last_node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360
5.160.2.30set_allocator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360
5.160.2.31type

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360

5.160.2.32type

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361

5.160.2.33value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361
5.160.2.34value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361
5.160.2.35value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361
5.160.2.36value_size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362
5.161rapidxml::xml_node< Ch > Class Template Reference
5.161.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . 362

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364

5.161.2 Constructor & Destructor Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . 364


5.161.2.1 xml_node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364
5.161.3 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364

5.161.3.1 append_attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364


5.161.3.2 append_node
5.161.3.3 document

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365

5.161.3.4 first_attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365


5.161.3.5 first_node

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365

5.161.3.6 insert_attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365


5.161.3.7 insert_node

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366

5.161.3.8 last_attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366


5.161.3.9 last_node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366
5.161.3.10name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366
5.161.3.11name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
5.161.3.12name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
5.161.3.13name_size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
5.161.3.14next_sibling

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367

5.161.3.15parent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

CONTENTS

xxxv

5.161.3.16prepend_attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
5.161.3.17prepend_node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
5.161.3.18previous_sibling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
5.161.3.19remove_attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369
5.161.3.20remove_first_attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369
5.161.3.21remove_first_node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369
5.161.3.22remove_last_attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369
5.161.3.23remove_last_node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369
5.161.3.24type

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369

5.161.3.25type

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369

5.161.3.26value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370
5.161.3.27value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370
5.161.3.28value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370
5.161.3.29value_size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370
5.162XMLParser Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
5.163XMLSubSys Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
5.163.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371

5.163.2 Member Function Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372

5.163.2.1 close . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372


5.163.2.2 getSAXReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372
5.163.2.3 init . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372
5.163.2.4 runParser

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372

5.163.2.5 setHandler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373


5.163.2.6 setValidation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373
6

File Documentation
6.1

src/node/include/node/Component.hpp File Reference . . . . . . . . . . . . . . . . . . . . . . . . 375


6.1.1

6.2

Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378

Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378

Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379

src/pnp2/include/pnp2/NetworkProfile.hpp File Reference . . . . . . . . . . . . . . . . . . . . . . 379


6.6.1

6.7

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377

src/node/src/node/node_main.cpp File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . 378


6.5.1

6.6

Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . 375

src/node/src/node/Component.cpp File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . 378


6.4.1

6.5

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375

src/node/include/node/rapidxml_utils.hpp File Reference . . . . . . . . . . . . . . . . . . . . . . . 377


6.3.1

6.4

Detailed Description

src/node/include/node/rapidxml.hpp File Reference


6.2.1

6.3

375

Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379

src/pnp2/include/pnp2/receiver.hpp File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . 379


6.7.1

Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

xxxvi

6.8

CONTENTS

src/pnp2/include/pnp2/sender.hpp File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . 380


6.8.1

6.9

Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380

src/sumo/include/traci-server/TraCIConstants.h File Reference


6.9.1

Detailed Description

. . . . . . . . . . . . . . . . . . . 380

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386

6.10 src/sumo/include/traci-server/TraCIException.h File Reference . . . . . . . . . . . . . . . . . . . . 386


6.10.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386

6.11 src/sumo/include/traci-server/TraCIServer.h File Reference . . . . . . . . . . . . . . . . . . . . . 387


6.11.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387

6.12 src/sumo/include/traci-server/TraCIServerAPI_Edge.h File Reference . . . . . . . . . . . . . . . . 388


6.12.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388

6.13 src/sumo/include/traci-server/TraCIServerAPI_InductionLoop.h File Reference . . . . . . . . . . . 388


6.13.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389

6.14 src/sumo/include/traci-server/TraCIServerAPI_Junction.h File Reference . . . . . . . . . . . . . . 389


6.14.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389

6.15 src/sumo/include/traci-server/TraCIServerAPI_Lane.h File Reference . . . . . . . . . . . . . . . . 389


6.15.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390

6.16 src/sumo/include/traci-server/TraCIServerAPI_MeMeDetector.h File Reference . . . . . . . . . . . 390


6.16.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390

6.17 src/sumo/include/traci-server/TraCIServerAPI_Person.h File Reference . . . . . . . . . . . . . . . 391


6.17.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391

6.18 src/sumo/include/traci-server/TraCIServerAPI_POI.h File Reference . . . . . . . . . . . . . . . . . 391


6.18.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392

6.19 src/sumo/include/traci-server/TraCIServerAPI_Polygon.h File Reference


6.19.1 Detailed Description

. . . . . . . . . . . . . . 392

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392

6.20 src/sumo/include/traci-server/TraCIServerAPI_Route.h File Reference . . . . . . . . . . . . . . . . 392


6.20.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393

6.21 src/sumo/include/traci-server/TraCIServerAPI_Simulation.h File Reference . . . . . . . . . . . . . 393


6.21.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393

6.22 src/sumo/include/traci-server/TraCIServerAPI_TLS.h File Reference . . . . . . . . . . . . . . . . . 394


6.22.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394

6.23 src/sumo/include/traci-server/TraCIServerAPI_Vehicle.h File Reference . . . . . . . . . . . . . . . 394


6.23.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394

6.24 src/sumo/include/traci-server/TraCIServerAPI_VehicleType.h File Reference . . . . . . . . . . . . 395


6.24.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395

6.25 src/sumo/include/utils/common/AbstractMutex.h File Reference . . . . . . . . . . . . . . . . . . . 395


6.25.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396

6.26 src/sumo/include/utils/common/Command.h File Reference . . . . . . . . . . . . . . . . . . . . . 396


6.26.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396

6.27 src/sumo/include/utils/common/FileHelpers.h File Reference . . . . . . . . . . . . . . . . . . . . . 397


6.27.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

CONTENTS

xxxvii

6.28 src/sumo/include/utils/common/IDSupplier.h File Reference . . . . . . . . . . . . . . . . . . . . . 397


6.28.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397

6.29 src/sumo/include/utils/common/MsgHandler.h File Reference . . . . . . . . . . . . . . . . . . . . 398


6.29.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398

6.30 src/sumo/include/utils/common/MsgRetrievingFunction.h File Reference . . . . . . . . . . . . . . 399


6.30.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399

6.31 src/sumo/include/utils/common/Named.h File Reference . . . . . . . . . . . . . . . . . . . . . . . 399


6.31.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400

6.32 src/sumo/include/utils/common/NamedObjectCont.h File Reference . . . . . . . . . . . . . . . . . 400


6.32.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400

6.33 src/sumo/include/utils/common/NamedRTree.h File Reference . . . . . . . . . . . . . . . . . . . . 401


6.33.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 401

6.34 src/sumo/include/utils/common/Parameterised.h File Reference . . . . . . . . . . . . . . . . . . . 401


6.34.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402

6.35 src/sumo/include/utils/common/RandHelper.h File Reference . . . . . . . . . . . . . . . . . . . . 402


6.35.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402

6.36 src/sumo/include/utils/common/RandomDistributor.h File Reference . . . . . . . . . . . . . . . . . 403


6.36.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403

6.37 src/sumo/include/utils/common/RGBColor.h File Reference . . . . . . . . . . . . . . . . . . . . . 403


6.37.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403

6.38 src/sumo/include/utils/common/StaticCommand.h File Reference . . . . . . . . . . . . . . . . . . 404


6.38.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404

6.39 src/sumo/include/utils/common/StdDefs.h File Reference . . . . . . . . . . . . . . . . . . . . . . 404


6.39.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405

6.40 src/sumo/include/utils/common/StringBijection.h File Reference . . . . . . . . . . . . . . . . . . . 406


6.40.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406

6.41 src/sumo/include/utils/common/StringTokenizer.h File Reference


6.41.1 Detailed Description

. . . . . . . . . . . . . . . . . . 406

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407

6.42 src/sumo/include/utils/common/StringUtils.h File Reference . . . . . . . . . . . . . . . . . . . . . 407


6.42.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407

6.43 src/sumo/include/utils/common/SUMOTime.h File Reference . . . . . . . . . . . . . . . . . . . . 407


6.43.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408

6.44 src/sumo/include/utils/common/SUMOVehicleClass.h File Reference . . . . . . . . . . . . . . . . 409


6.44.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410

6.44.2 Enumeration Type Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411


6.44.2.1 SUMOVehicleClass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411
6.44.2.2 SUMOVehicleShape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412
6.44.3 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412
6.44.3.1 getVehicleClassCompoundID . . . . . . . . . . . . . . . . . . . . . . . . . . . 412
6.44.3.2 getVehicleClassID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

xxxviii

CONTENTS

6.44.3.3 getVehicleClassNames

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413

6.44.3.4 getVehicleClassNamesList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413


6.44.3.5 getVehicleShapeID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413
6.44.3.6 getVehicleShapeName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414
6.44.3.7 isForbidden

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414

6.44.3.8 isRailway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414


6.44.3.9 isWaterway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414
6.44.3.10 parseVehicleClasses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414
6.44.3.11 parseVehicleClasses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415
6.44.3.12 parseVehicleClasses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415
6.45 src/sumo/include/utils/common/SystemFrame.h File Reference . . . . . . . . . . . . . . . . . . . 415
6.45.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415

6.46 src/sumo/include/utils/common/SysUtils.h File Reference . . . . . . . . . . . . . . . . . . . . . . 416


6.46.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416

6.47 src/sumo/include/utils/common/ToString.h File Reference . . . . . . . . . . . . . . . . . . . . . . 416


6.47.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417

6.48 src/sumo/include/utils/common/TplConvert.h File Reference . . . . . . . . . . . . . . . . . . . . . 418


6.48.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418

6.49 src/sumo/include/utils/common/UtilExceptions.h File Reference . . . . . . . . . . . . . . . . . . . 418


6.49.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419

6.50 src/sumo/include/utils/common/ValueRetriever.h File Reference . . . . . . . . . . . . . . . . . . . 419


6.50.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420

6.51 src/sumo/include/utils/common/ValueSource.h File Reference . . . . . . . . . . . . . . . . . . . . 420


6.51.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420

6.52 src/sumo/include/utils/common/ValueTimeLine.h File Reference . . . . . . . . . . . . . . . . . . . 420


6.52.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421

6.53 src/sumo/include/utils/common/VectorHelper.h File Reference . . . . . . . . . . . . . . . . . . . . 421


6.53.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421

6.54 src/sumo/include/utils/common/WrappingCommand.h File Reference . . . . . . . . . . . . . . . . 422


6.54.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422

6.55 src/sumo/include/utils/iodevices/BinaryFormatter.h File Reference . . . . . . . . . . . . . . . . . . 422


6.55.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423

6.56 src/sumo/include/utils/iodevices/BinaryInputDevice.h File Reference . . . . . . . . . . . . . . . . . 423


6.56.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423

6.57 src/sumo/include/utils/iodevices/OutputDevice.h File Reference . . . . . . . . . . . . . . . . . . . 424


6.57.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424

6.58 src/sumo/include/utils/iodevices/OutputDevice_CERR.h File Reference . . . . . . . . . . . . . . . 424


6.58.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424

6.59 src/sumo/include/utils/iodevices/OutputDevice_COUT.h File Reference . . . . . . . . . . . . . . . 425


6.59.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

CONTENTS

xxxix

6.60 src/sumo/include/utils/iodevices/OutputDevice_File.h File Reference


6.60.1 Detailed Description

. . . . . . . . . . . . . . . . 425

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426

6.61 src/sumo/include/utils/iodevices/OutputDevice_Network.h File Reference . . . . . . . . . . . . . . 426


6.61.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426

6.62 src/sumo/include/utils/iodevices/OutputDevice_String.h File Reference . . . . . . . . . . . . . . . 427


6.62.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427

6.63 src/sumo/include/utils/iodevices/OutputFormatter.h File Reference . . . . . . . . . . . . . . . . . . 427


6.63.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427

6.64 src/sumo/include/utils/iodevices/PlainXMLFormatter.h File Reference . . . . . . . . . . . . . . . . 428


6.64.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428

6.65 src/sumo/include/utils/options/Option.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . 428


6.65.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429

6.66 src/sumo/include/utils/options/OptionsCont.h File Reference . . . . . . . . . . . . . . . . . . . . . 429


6.66.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429

6.67 src/sumo/include/utils/options/OptionsIO.h File Reference . . . . . . . . . . . . . . . . . . . . . . 430


6.67.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430

6.68 src/sumo/include/utils/options/OptionsLoader.h File Reference . . . . . . . . . . . . . . . . . . . . 430


6.68.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431

6.69 src/sumo/include/utils/options/OptionsParser.h File Reference . . . . . . . . . . . . . . . . . . . . 431


6.69.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431

6.70 src/sumo/include/utils/traci/TraCIAPI.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . 431


6.70.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433

6.71 src/sumo/include/utils/xml/GenericSAXHandler.h File Reference . . . . . . . . . . . . . . . . . . . 433


6.71.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434

6.72 src/sumo/include/utils/xml/SAXWeightsHandler.h File Reference . . . . . . . . . . . . . . . . . . . 434


6.72.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434

6.73 src/sumo/include/utils/xml/SUMORouteHandler.h File Reference


6.73.1 Detailed Description

. . . . . . . . . . . . . . . . . . 435

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435

6.74 src/sumo/include/utils/xml/SUMORouteLoader.h File Reference . . . . . . . . . . . . . . . . . . . 435


6.74.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435

6.75 src/sumo/include/utils/xml/SUMORouteLoaderControl.h File Reference . . . . . . . . . . . . . . . 436


6.75.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436

6.76 src/sumo/include/utils/xml/SUMOSAXAttributes.h File Reference . . . . . . . . . . . . . . . . . . 436


6.76.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437

6.77 src/sumo/include/utils/xml/SUMOSAXAttributesImpl_Binary.h File Reference . . . . . . . . . . . . 437


6.77.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437

6.78 src/sumo/include/utils/xml/SUMOSAXAttributesImpl_Xerces.h File Reference . . . . . . . . . . . . 438


6.78.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438

6.79 src/sumo/include/utils/xml/SUMOSAXHandler.h File Reference . . . . . . . . . . . . . . . . . . . 438


6.79.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

xl

CONTENTS

6.80 src/sumo/include/utils/xml/SUMOSAXReader.h File Reference


6.80.1 Detailed Description

. . . . . . . . . . . . . . . . . . . 439

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439

6.81 src/sumo/include/utils/xml/SUMOVehicleParserHelper.h File Reference . . . . . . . . . . . . . . . 440


6.81.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440

6.82 src/sumo/include/utils/xml/SUMOXMLDefinitions.h File Reference . . . . . . . . . . . . . . . . . . 440


6.82.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444

6.82.2 Enumeration Type Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444


6.82.2.1 LinkDirection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444
6.82.2.2 LinkState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445
6.82.2.3 SumoXMLAttr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445
6.82.2.4 SumoXMLTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446
6.83 src/sumo/include/utils/xml/XMLSubSys.h File Reference . . . . . . . . . . . . . . . . . . . . . . . 447
6.83.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447

6.84 src/sumo/src/utils/common/FileHelpers.cpp File Reference


6.84.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . 448

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448

6.85 src/sumo/src/utils/common/IDSupplier.cpp File Reference . . . . . . . . . . . . . . . . . . . . . . 448


6.85.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448

6.86 src/sumo/src/utils/common/MsgHandler.cpp File Reference . . . . . . . . . . . . . . . . . . . . . 449


6.86.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449

6.87 src/sumo/src/utils/common/Parameterised.cpp File Reference . . . . . . . . . . . . . . . . . . . . 449


6.87.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449

6.88 src/sumo/src/utils/common/RandHelper.cpp File Reference . . . . . . . . . . . . . . . . . . . . . 450


6.88.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450

6.89 src/sumo/src/utils/common/RGBColor.cpp File Reference . . . . . . . . . . . . . . . . . . . . . . 450


6.89.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450

6.89.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451


6.89.2.1 operator<< . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451
6.90 src/sumo/src/utils/common/StdDefs.cpp File Reference . . . . . . . . . . . . . . . . . . . . . . . 451
6.90.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452

6.91 src/sumo/src/utils/common/StringTokenizer.cpp File Reference


6.91.1 Detailed Description

. . . . . . . . . . . . . . . . . . . 452

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452

6.92 src/sumo/src/utils/common/StringUtils.cpp File Reference . . . . . . . . . . . . . . . . . . . . . . 452


6.92.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453

6.93 src/sumo/src/utils/common/SUMOVehicleClass.cpp File Reference . . . . . . . . . . . . . . . . . 453


6.93.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454

6.93.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455


6.93.2.1 getVehicleClassCompoundID . . . . . . . . . . . . . . . . . . . . . . . . . . . 455
6.93.2.2 getVehicleClassID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456
6.93.2.3 getVehicleClassNames

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456

6.93.2.4 getVehicleClassNamesList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456


Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

CONTENTS

xli

6.93.2.5 getVehicleShapeID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456


6.93.2.6 getVehicleShapeName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457
6.93.2.7 isForbidden

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457

6.93.2.8 isRailway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457


6.93.2.9 isWaterway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457
6.93.2.10 parseVehicleClasses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457
6.93.2.11 parseVehicleClasses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458
6.93.2.12 parseVehicleClasses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458
6.94 src/sumo/src/utils/common/SystemFrame.cpp File Reference . . . . . . . . . . . . . . . . . . . . 458
6.94.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458

6.95 src/sumo/src/utils/common/SysUtils.cpp File Reference . . . . . . . . . . . . . . . . . . . . . . . 459


6.95.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459

6.96 src/tlc_package/include/tlc_package/control_stream_ddos.hpp File Reference . . . . . . . . . . . 459


6.96.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459

6.97 src/tlc_package/include/tlc_package/controller.hpp File Reference . . . . . . . . . . . . . . . . . . 460


6.97.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460

6.98 src/tlc_package/include/tlc_package/e3_sensor.hpp File Reference . . . . . . . . . . . . . . . . . 460


6.98.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460

6.99 src/tlc_package/include/tlc_package/e3_sensor_stream_ddos.hpp File Reference . . . . . . . . . 461


6.99.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461

6.100src/tlc_package/include/tlc_package/sumo_intf.hpp File Reference . . . . . . . . . . . . . . . . . 461


6.100.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461

6.101src/tlc_package/include/tlc_package/tl_actuator.hpp File Reference . . . . . . . . . . . . . . . . . 462


6.101.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462

6.102src/tlc_package/include/tlc_package/tl_sensor.hpp File Reference . . . . . . . . . . . . . . . . . . 462


6.102.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462

6.103src/tlc_package/include/tlc_package/tl_sensor_stream_ddos.hpp File Reference . . . . . . . . . . 463


6.103.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463

6.104src/tlc_package/src/tlc_package/control_stream_ddos.cpp File Reference . . . . . . . . . . . . . . 463


6.104.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463

6.105src/tlc_package/src/tlc_package/controller.cpp File Reference . . . . . . . . . . . . . . . . . . . . 463


6.105.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464

6.106src/tlc_package/src/tlc_package/e3_sensor.cpp File Reference . . . . . . . . . . . . . . . . . . . 464


6.106.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464

6.107src/tlc_package/src/tlc_package/e3_sensor_stream_ddos.cpp File Reference . . . . . . . . . . . . 464


6.107.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465

6.108src/tlc_package/src/tlc_package/sumo_intf.cpp File Reference . . . . . . . . . . . . . . . . . . . . 465


6.108.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465

6.109src/tlc_package/src/tlc_package/tl_actuator.cpp File Reference . . . . . . . . . . . . . . . . . . . 465


6.109.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

xlii

CONTENTS

6.110src/tlc_package/src/tlc_package/tl_sensor.cpp File Reference . . . . . . . . . . . . . . . . . . . . 466


6.110.1 Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466

6.111src/tlc_package/src/tlc_package/tl_sensor_stream_ddos.cpp File Reference . . . . . . . . . . . . 466


6.111.1 Detailed Description
Index

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467
468

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

Chapter 1

Todo List
Member BinaryFormatter::closeTag (std::ostream &into)
it is not verified that the topmost element was closed
Member BinaryFormatter::writeXMLHeader (std::ostream &into, const std::string &rootElement, const std::string &attrs="", const std::string &comment="")
Check which parameter is used herein
Describe what is saved
Class BinaryInputDevice
Recheck whether this class could be replaced by a "normal InputDevice"
Maybe some kind of a well-defined types should be used (so that they have a well-defined length)
Maybe the byte-order should be defined
Member BinaryInputDevice::operator>> (BinaryInputDevice &os, std::string &s)
Use either a buffer with a flexible size or report an error if the buffer is too small!
Member BinaryInputDevice::operator>> (BinaryInputDevice &os, std::vector< std::string > &v)
Use either a buffer with a flexible size or report an error if the buffer is too small!
Member BinaryInputDevice::operator>> (BinaryInputDevice &os, std::vector< unsigned int > &v)
Use either a buffer with a flexible size or report an error if the buffer is too small!
Member BinaryInputDevice::operator>> (BinaryInputDevice &os, std::vector< std::vector< unsigned int
> > &v)
Use either a buffer with a flexible size or report an error if the buffer is too small!
Member GenericSAXHandler::characters (const XMLCh const chars, const XERCES3_SIZE_t length)
recheck/describe what happens with characters when a new element is opened
describe characters processing in the class head
Member GenericSAXHandler::endElement (const XMLCh const uri, const XMLCh const localname, const
XMLCh const qname)
recheck/describe encoding of the string-representation
do not generate and report the string-representation
Member GenericSAXHandler::GenericSAXHandler (StringBijection< int >::Entry tags, int terminatorTag,
StringBijection< int >::Entry attrs, int terminatorAttr, const std::string &file)
Why are both lists non-const and given as pointers?
Member GenericSAXHandler::setFileName (const std::string &name)
Hmmm - this is as unsafe as having a direct access to the variable; recheck
Member GenericSAXHandler::startElement (const XMLCh const uri, const XMLCh const localname,
const XMLCh const qname, const XERCES_CPP_NAMESPACE::Attributes &attrs)
recheck/describe encoding of the string-representation
do not generate and report the string-representation

Todo List

Member getVehicleClassNamesList (SVCPermissions permissions)


cache values?
Member OptionsCont::getStringVector (const std::string &name) const
Is it possible to retrieve a const-reference of the string?
See Also
getString()
Member OptionsCont::isInStringVector (const std::string &optionName, const std::string &itemName)
Try to optimize - at each call, the vector is rebuilt
Member OptionsLoader::characters (const XMLCh const chars, const XERCES3_SIZE_t length)
Describe better
Member OutputDevice::closeTag ()
it is not verified that the topmost element was closed
Member OutputDevice::writeXMLHeader (const std::string &rootElement, const std::string &attrs="", const
std::string &comment="")
Check which parameter is used herein
Describe what is saved
Member OutputFormatter::closeTag (std::ostream &into)=0
it is not verified that the topmost element was closed
Member OutputFormatter::writeXMLHeader (std::ostream &into, const std::string &rootElement, const std::string &attrs="", const std::string &comment="")=0
Check which parameter is used herein
Describe what is saved
Member PlainXMLFormatter::closeTag (std::ostream &into)
it is not verified that the topmost element was closed
Member PlainXMLFormatter::writeXMLHeader (std::ostream &into, const std::string &rootElement, const
std::string &attrs="", const std::string &comment="")
Check which parameter is used herein
Describe what is saved
Member SUMOVehicleParserHelper::parseEmissionClass (const SUMOSAXAttributes &attrs, const std::string &id)
Recheck how errors are handled and what happens if they occure
Member SUMOVehicleParserHelper::parseGuiShape (const SUMOSAXAttributes &attrs, const std::string
&id)
Recheck how errors are handled and what happens if they occure
Member SUMOVehicleParserHelper::parseVehicleClass (const SUMOSAXAttributes &attrs, const std::string &id)
Recheck how errors are handled and what happens if they occure
Member SystemFrame::addConfigurationOptions (OptionsCont &oc)
let the container be retrieved
Member SystemFrame::addReportOptions (OptionsCont &oc)
let the container be retrieved
Class XMLSubSys
make schema checking optional

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

Chapter 2

Hierarchical Index
2.1

Class Hierarchy

This inheritance list is sorted roughly, but not completely, alphabetically:


AbstractMutex . . . . .
BiArc . . . . . . . . . .
BiArcParams . . . . . .
BinaryInputDevice . . .
Network::Buffer_Empty
Command . . . . . . .

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

17
18
19
24
30
30

StaticCommand< T > . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228


WrappingCommand< T > . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340
Named::ComparatorIdLess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
control_stream_ddos . .
controller . . . . . . . . .
e3_sensor . . . . . . . .
e3_sensor_stream_ddos
sumo_intf . . . . . . . .
tl_actuator . . . . . . . .
tl_sensor . . . . . . . . .
tl_sensor_stream_ddos .

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

31
31

.
.
.
.
.
.
.
.

. 35
. 38
. 42
. 44
. 240
. 291
. 295
. 298

ComponentConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

34
35

IPV4_Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
IPV6_Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
CSVIterator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
CSVRow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
DefaultHandler
GenericSAXHandler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
SUMOSAXHandler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
SAXWeightsHandler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
SUMORouteHandler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
SAXWeightsHandler::EdgeFloatTimeLineRetriever . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
StringBijection< T >::Entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
EulerSpiral . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
EulerSpiralLookupTable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
EulerSpiralParams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Network::Exceeded_Production_profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Network::Exceeded_Production_Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
exception

Hierarchical Index

rapidxml::parse_error . . .
tcpip::SocketException . .
rapidxml::file< Ch > . . . . . .
FileHelpers . . . . . . . . . .
HandlerBase
OptionsLoader . . . . . . .
IDSupplier . . . . . . . . . . .
invalid_return< X > . . . . . .
Logger . . . . . . . . . . . . .
rapidxml::memory_pool< Ch >

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

. . 201
. . 228
. 51
. 53

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

. . 152
. 65
. 66
. 71
. 74

rapidxml::xml_document< Ch > . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350


Network::Message . . . . . . . . . . . . . . . . . . . . . . . .
MsgHandler . . . . . . . . . . . . . . . . . . . . . . . . . . .
MTRand . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Named . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
NAMED_RTREE_QUAL
NamedRTree . . . . . . . . . . . . . . . . . . . . . . . .
Named::NamedLikeComparatorIdLess< NamedLike > . . . .
NamedObjectCont< T > . . . . . . . . . . . . . . . . . . . .
NetworkBuffer . . . . . . . . . . . . . . . . . . . . . . . . . .
Network::NetworkProfile . . . . . . . . . . . . . . . . . . . . .
noncopyable
Network::message_buffer< Network::Network::Message >
Network::message_buffer< T > . . . . . . . . . . . . . .
Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Option_Bool . . . . .
Option_Float . . . . .
Option_Integer . . . .
Option_IntVector . . .
Option_String . . . .
Option_FileName

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

77
79
88
90

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

. . 93
. 91
. 91
. 95
. 96

. . . . . . . . . . . . . . . . . . . . . . . 78
. . . . . . . . . . . . . . . . . . . . . . . 78
. . . . . . . . . . . . . . . . . . . . . . 98

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

. 104
. 115
. 121
. 126
. 132
. 109

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

137
138
151
154
155

MsgRetrievingFunction< T >
OutputDevice_CERR . . . .
OutputDevice_COUT . . . .
OutputDevice_File . . . . . .
OutputDevice_Network . . .
OutputDevice_String . . . .

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

. 81
. 162
. 169
. 176
. 183
. 190

Options . . .
OptionsCont .
OptionsIO . .
OptionsParser
OutputDevice

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

OutputFormatter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
BinaryFormatter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
PlainXMLFormatter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Parameterised . . . . . . . .
Point2D< coord_type > . . .
Point2D< double > . . . . .
RandHelper . . . . . . . . .
RandomDistributor< T > . .
Network::receiver . . . . . .
Network::ResourceEntry . .
RGBColor . . . . . . . . . .
runtime_error
EmptyData . . . . . . . .
FormatException . . . .
BoolFormatException

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

199
205
205
209
210
212
213
213

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

2.1 Class Hierarchy

NumberFormatException . . . .
OutOfBoundsException . . . . . . .
ProcessError . . . . . . . . . . . . .
InvalidArgument . . . . . . . . .
IOError . . . . . . . . . . . . . .
TraCIException . . . . . . . . . . .
UnknownElement . . . . . . . . . .
AbstractMutex::ScopedLocker . . . . . .
Network::sender . . . . . . . . . . . . .
tcpip::Socket . . . . . . . . . . . . . . .
tcpip::Storage . . . . . . . . . . . . . .
Named::StoringVisitor . . . . . . . . . .
TraCIServerAPI_Lane::StoringVisitor . .
streambuf
Network::profileMemBuf . . . . . . .
StringBijection< T > . . . . . . . . . .
StringBijection< int > . . . . . . . . . .
StringBijection< LaneChangeModel > .
StringBijection< LaneSpreadFunction >
StringBijection< LinkDirection > . . . .
StringBijection< LinkState > . . . . . .
StringBijection< SumoXMLEdgeFunc >
StringBijection< SumoXMLNodeType >
StringBijection< TrafficLightType > . . .
StringTokenizer . . . . . . . . . . . . .
StringUtils . . . . . . . . . . . . . . . .
SUMORouteLoader . . . . . . . . . . .
SUMORouteLoaderControl . . . . . . .
SUMOSAXAttributes . . . . . . . . . .

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.

. 98
. 155
. 208
. 66
. 67
. 309
. 336
224
225
227
230
231
231

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

. 208
232
232
232
232
232
232
232
232
232
232
234
250
251
252

SUMOSAXAttributesImpl_Binary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
SUMOSAXAttributesImpl_Xerces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
SUMOSAXReader . . . . . . . . . . . . .
SUMOVehicleParserHelper . . . . . . . .
SUMOXMLDefinitions . . . . . . . . . . .
SystemFrame . . . . . . . . . . . . . . .
SysUtils . . . . . . . . . . . . . . . . . .
SAXWeightsHandler::ToRetrieveDefinition
TplConvert . . . . . . . . . . . . . . . . .
TraCIAPI . . . . . . . . . . . . . . . . . .

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

283
284
289
289
291
301
302
303

SUMO_CLIENT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
TraCIAPI::TraCIBoundary . . .
TraCIAPI::TraCIColor . . . . .
TraCIAPI::TraCILink . . . . . .
TraCIAPI::TraCILogic . . . . .
TraCIAPI::TraCIPhase . . . . .
TraCIAPI::TraCIPosition . . . .
TraCIPositionVector . . . . . .
TraCIAPI::TraCIScopeWrapper

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.

308
308
309
309
310
310
310
311

TraCIAPI::AreaScope . . . . .
TraCIAPI::EdgeScope . . . . .
TraCIAPI::GUIScope . . . . . .
TraCIAPI::InductionLoopScope
TraCIAPI::JunctionScope . . .
TraCIAPI::LaneScope . . . . .
TraCIAPI::MeMeScope . . . .
TraCIAPI::POIScope . . . . . .
TraCIAPI::PolygonScope . . .

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

. 18
. 48
. 64
. 65
. 69
. 70
. 73
. 206
. 207

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

Hierarchical Index

TraCIAPI::RouteScope . . .
TraCIAPI::SimulationScope .
TraCIAPI::TrafficLightScope .
TraCIAPI::VehicleTypeScope
TraCIServerAPI_AreaDetector
TraCIServerAPI_ArealDetector
TraCIServerAPI_Edge . . . . .
TraCIServerAPI_InductionLoop
TraCIServerAPI_Junction . . .
TraCIServerAPI_Lane . . . . .
TraCIServerAPI_MeMeDetector
TraCIServerAPI_Person . . . .
TraCIServerAPI_POI . . . . .
TraCIServerAPI_Polygon . . .
TraCIServerAPI_Route . . . .
TraCIServerAPI_Simulation . .
TraCIServerAPI_TLS . . . . .
TraCIServerAPI_Vehicle . . . .
TraCIServerAPI_VehicleType .
ValueRetriever< T > . . . . .
ValueSource< T > . . . . . .
ValueTimeLine< T > . . . . .
VectorHelper< T > . . . . . .
VehicleStateListener
TraCIServer . . . . . . . .
rapidxml::xml_base< Ch > . .

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

.
.
.
.

. 219
. 226
. 335
. 339

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

317
317
318
319
321
323
324
325
326
328
329
330
332
332
334
336
336
337
339

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347

rapidxml::xml_attribute< Ch > . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342


rapidxml::xml_node< Ch > . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362
rapidxml::xml_document< Ch > . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350
XMLParser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
XMLSubSys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

Chapter 3

Class Index
3.1

Class List

Here are the classes, structs, unions and interfaces with brief descriptions:
AbstractMutex
An abstract class for encapsulating mutex implementations . . . . . . . .
TraCIAPI::AreaScope
Scope for interaction with areal detectors . . . . . . . . . . . . . . . . .
BiArc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BiArcParams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BinaryFormatter
Output formatter for plain XML output . . . . . . . . . . . . . . . . . . .
BinaryInputDevice
Encapsulates binary reading operations on a file . . . . . . . . . . . . .
BoolFormatException
BoolFormatException Thrown when the string that shall be converted into
match . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Network::Buffer_Empty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Command
Base (microsim) event class . . . . . . . . . . . . . . . . . . . . . . . .
Named::ComparatorIdLess
Function-object for stable sorting in containers . . . . . . . . . . . . . . .
Component
Component class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ComponentConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
control_stream_ddos
Component Message and Service Headers . . . . . . . . . . . . . . . .
controller
Component Message and Service Headers . . . . . . . . . . . . . . . .
CSVIterator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CSVRow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
e3_sensor
Component Message and Service Headers . . . . . . . . . . . . . . . .
e3_sensor_stream_ddos
Component Message and Service Headers . . . . . . . . . . . . . . . .
SAXWeightsHandler::EdgeFloatTimeLineRetriever
Interface for a class which obtains read weights for named edges . . . . .
TraCIAPI::EdgeScope
Scope for interaction with edges . . . . . . . . . . . . . . . . . . . . . .
EmptyData
EmptyData Thrown when data required by a method is missing . . . . . .

. . . . . . . . . . .

17

. . . . . . . . . . .
. . . . . . . . . . .
. . . . . . . . . . .

18
18
19

. . . . . . . . . . .

19

. . . . . . . . . . .

24

a boolean does not


. . . . . . . . . . .
. . . . . . . . . . .

29
30

. . . . . . . . . . .

30

. . . . . . . . . . .

31

. . . . . . . . . . .
. . . . . . . . . . .
. . . . . . . . . . .

31
34
35

. . . . . . . . . . .

35

. . . . . . . . . . .
. . . . . . . . . . .
. . . . . . . . . . .

38
41
41

. . . . . . . . . . .

42

. . . . . . . . . . .

44

. . . . . . . . . . .

47

. . . . . . . . . . .

48

. . . . . . . . . . .

49

Class Index

StringBijection< T >::Entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EulerSpiral . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EulerSpiralLookupTable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EulerSpiralParams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Network::Exceeded_Production_profile
Exception class thrown when application exceeds allowed data production . . . . . . . . . . .
Network::Exceeded_Production_Profile
Exception class thrown when application exceeds allowed data production . . . . . . . . . . .
rapidxml::file< Ch >
Represents data loaded from a file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
FileHelpers
Functions for an easier usage of files and paths . . . . . . . . . . . . . . . . . . . . . . . . .
FormatException
FormatException Thrown when a string that shall be converted into something else contained
the wrong characters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GenericSAXHandler
A handler which converts occuring elements and attributes into enums . . . . . . . . . . . . .
TraCIAPI::GUIScope
Scope for interaction with the gui . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
IDSupplier
This class builds string ids by adding an increasing numerical value to a previously given string
TraCIAPI::InductionLoopScope
Scope for interaction with inductive loops . . . . . . . . . . . . . . . . . . . . . . . . . . . .
invalid_return< X > . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
InvalidArgument
InvalidArgument Thrown when an argument was not proper in the current context A message
will be supplied . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
IOError . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
IPV4_Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
IPV6_Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TraCIAPI::JunctionScope
Scope for interaction with junctions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TraCIAPI::LaneScope
Scope for interaction with lanes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Logger
Logger.hpp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TraCIAPI::MeMeScope
Scope for interaction with multi entry/-exit detectors . . . . . . . . . . . . . . . . . . . . . . .
rapidxml::memory_pool< Ch >
This class is used by the parser to create new nodes and attributes, without overheads of dynamic memory allocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Network::Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Network::message_buffer< T > . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MsgHandler
MsgHandler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MsgRetrievingFunction< T >
Encapsulates an objects method for using it as a message retriever . . . . . . . . . . . . . .
MTRand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Named
Base class for objects which have an id . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Named::NamedLikeComparatorIdLess< NamedLike >
Function-object for stable sorting of objects acting like Named without being derived (SUMOVehicle) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
NamedObjectCont< T >
A map of named object pointers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
NamedRTree
A RT-tree for efficient storing of SUMOs Named objects . . . . . . . . . . . . . . . . . . . . .
NetworkBuffer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

49
49
50
50
51
51
51
53

58
59
64
65
65
66

66
67
67
68
69
70
71
73

74
77
78
79
81
88
90

91
91
93
95

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

3.1 Class List

Network::NetworkProfile
Defines how the bandwidth and latency of a given network link vary as functions of time over a
specified period . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
NumberFormatException
NumberFormatException Thrown when the string that shall be converted into a numerical representation has any other characters then digits and a dot . . . . . . . . . . . . . . . . . . . . . 98
Option
A class representing a single program option . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Option_Bool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Option_FileName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Option_Float . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Option_Integer
An integer-option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Option_IntVector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Option_String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
OptionsCont
A storage for options typed value containers) . . . . . . . . . . . . . . . . . . . . . . . . . . 138
OptionsIO
Helping methods for parsing of command line arguments and reading a configuration file . . . 151
OptionsLoader
A SAX-Handler for loading options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
OptionsParser
Parses command line arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
OutOfBoundsException
OutOfBoundsException Thrown when an array element out of the arrays bounderies is accessed 155
OutputDevice
Static storage of an output device and its base (abstract) implementation . . . . . . . . . . . . 155
OutputDevice_CERR
An output device that encapsulates cerr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
OutputDevice_COUT
An output device that encapsulates cout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
OutputDevice_File
An output device that encapsulates an ofstream . . . . . . . . . . . . . . . . . . . . . . . . . 176
OutputDevice_Network
An output device for TCP/IP network connections . . . . . . . . . . . . . . . . . . . . . . . . 183
OutputDevice_String
An output device that encapsulates an ofstream . . . . . . . . . . . . . . . . . . . . . . . . . 190
OutputFormatter
Abstract base class for output formatters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
Parameterised
An upper class for objects with additional parameters . . . . . . . . . . . . . . . . . . . . . . 199
rapidxml::parse_error
Parse error exception . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
PlainXMLFormatter
Output formatter for plain XML output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Point2D< coord_type > . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
TraCIAPI::POIScope
Scope for interaction with POIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
TraCIAPI::PolygonScope
Scope for interaction with polygons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
ProcessError
ProcessError A general exception type that may be thrown when the process is no longer able
to proceed due to any reason . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
Network::profileMemBuf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
RandHelper
Utility functions for using a global, resetable random number generator . . . . . . . . . . . . . 209
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

10

Class Index

RandomDistributor< T >
Represents a generic random distribution . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Network::receiver
Allows for the reception of data through a (possibly fixed-size) buffer at a configurable rate that
can vary as a function of time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Network::ResourceEntry
Holds the information about an interval of time starting at time, with constant bandwidth and
max_bandwidth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RGBColor
The definition of a color in the RGB-space with an alpha channel . . . . . . . . . . . . . . . .
TraCIAPI::RouteScope
Scope for interaction with routes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SAXWeightsHandler
An XML-handler for network weights . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AbstractMutex::ScopedLocker
A mutex encapsulator which locks/unlocks the given mutex on construction/destruction, respectively . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Network::sender
Allows for the sending of data (possibly through a buffer) at a configurable rate and with configurable push-back to inform if the rate has been exceeded . . . . . . . . . . . . . . . . . . . .
TraCIAPI::SimulationScope
Scope for interaction with the simulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
tcpip::Socket . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
tcpip::SocketException . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
StaticCommand< T >
A wrapper for a Command function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
tcpip::Storage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Named::StoringVisitor
Allows to store the object; used as context while traveling the rtree in TraCI . . . . . . . . . . .
TraCIServerAPI_Lane::StoringVisitor
Allows to store the object; used as context while traveling the rtree in TraCI . . . . . . . . . . .
StringBijection< T >
Template container for maintaining a bidirectional map between strings and something else It is
not always a bijection since it allows for duplicate entries on both sides if either checkDuplicates
is set to false in the constructor or the insert function or if the addAlias function is used . . . .
StringTokenizer
StringTokenizer A class similar to the StringTokenizer from Java . . . . . . . . . . . . . . . .
StringUtils
Some static methods for string processing . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SUMO_CLIENT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
sumo_intf
Component Message and Service Headers . . . . . . . . . . . . . . . . . . . . . . . . . . .
SUMORouteHandler
Parser for routes during their loading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SUMORouteLoader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SUMORouteLoaderControl
SUMORouteLoaderControl This controls is initialised with the list of route loaders and uses them
to load routes step wise . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SUMOSAXAttributes
Encapsulated SAX-Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SUMOSAXAttributesImpl_Binary
Encapsulated Xerces-SAX-attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SUMOSAXAttributesImpl_Xerces
Encapsulated Xerces-SAX-attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SUMOSAXHandler
SAX-handler base for SUMO-files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SUMOSAXReader
SAX-reader encapsulation containing binary reader . . . . . . . . . . . . . . . . . . . . . . .

210

212

213
213
219
220

224

225
226
227
228
228
230
231
231

232
232
234
235
240
244
250

251
252
261
270
279
283

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

3.1 Class List

SUMOVehicleParserHelper
Helper methods for parsing vehicle attributes . . . . . . . . . . . . . .
SUMOXMLDefinitions
Class for maintaining associations between enums and xml-strings . . .
SystemFrame
A set of actions common to all applications . . . . . . . . . . . . . . .
SysUtils
A few system-specific functions . . . . . . . . . . . . . . . . . . . . .
tl_actuator
Component Message and Service Headers . . . . . . . . . . . . . . .
tl_sensor
Component Message and Service Headers . . . . . . . . . . . . . . .
tl_sensor_stream_ddos
Component Message and Service Headers . . . . . . . . . . . . . . .
SAXWeightsHandler::ToRetrieveDefinition
Complete definition about what shall be retrieved and where to store it .
TplConvert
TplConvert Some methods that convert 0-terminated char-arrays of any
(numerical/boolean) or into std::strings . . . . . . . . . . . . . . . . . .
TraCIAPI
C++ TraCI client API implementation . . . . . . . . . . . . . . . . . . .
TraCIAPI::TraCIBoundary
A 3D-bounding box . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TraCIAPI::TraCIColor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TraCIException . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TraCIAPI::TraCILink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TraCIAPI::TraCILogic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TraCIAPI::TraCIPhase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TraCIAPI::TraCIPosition
A 3D-position . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TraCIPositionVector
A list of positions . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TraCIAPI::TraCIScopeWrapper
An abstract interface for accessing type-dependent values . . . . . . .
TraCIServer
TraCI server used to control sumo by a remote TraCI client . . . . . . .
TraCIServerAPI_AreaDetector
APIs for getting/setting multi-entry/multi-exit detector values via TraCI . .
TraCIServerAPI_ArealDetector . . . . . . . . . . . . . . . . . . . . . . . . . . .
TraCIServerAPI_Edge
APIs for getting/setting edge values via TraCI . . . . . . . . . . . . . .
TraCIServerAPI_InductionLoop
APIs for getting/setting induction loop values via TraCI . . . . . . . . . .
TraCIServerAPI_Junction
APIs for getting/setting junction values via TraCI . . . . . . . . . . . . .
TraCIServerAPI_Lane
APIs for getting/setting lane values via TraCI . . . . . . . . . . . . . . .
TraCIServerAPI_MeMeDetector
APIs for getting/setting multi-entry/multi-exit detector values via TraCI . .
TraCIServerAPI_Person
APIs for getting/setting person values via TraCI . . . . . . . . . . . . .
TraCIServerAPI_POI
APIs for getting/setting POI values via TraCI . . . . . . . . . . . . . . .
TraCIServerAPI_Polygon
APIs for getting/setting polygon values via TraCI . . . . . . . . . . . . .
TraCIServerAPI_Route
APIs for getting/setting route values via TraCI . . . . . . . . . . . . . .
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

11

. . . . . . . . . . . . 284
. . . . . . . . . . . . 289
. . . . . . . . . . . . 289
. . . . . . . . . . . . 291
. . . . . . . . . . . . 291
. . . . . . . . . . . . 295
. . . . . . . . . . . . 298
. . . . . . . . . . . . 301
type into other values
. . . . . . . . . . . . 302
. . . . . . . . . . . . 303
.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

.
.
.
.
.
.

308
308
309
309
309
310

. . . . . . . . . . . . 310
. . . . . . . . . . . . 310
. . . . . . . . . . . . 311
. . . . . . . . . . . . 312
. . . . . . . . . . . . 317
. . . . . . . . . . . . 317
. . . . . . . . . . . . 318
. . . . . . . . . . . . 319
. . . . . . . . . . . . 321
. . . . . . . . . . . . 323
. . . . . . . . . . . . 324
. . . . . . . . . . . . 325
. . . . . . . . . . . . 326
. . . . . . . . . . . . 328
. . . . . . . . . . . . 329

12

Class Index

TraCIServerAPI_Simulation
APIs for getting/setting simulation values via TraCI . . . . . . . . . . . . . . . . . . . . . . . .
TraCIServerAPI_TLS
APIs for getting/setting traffic light values via TraCI . . . . . . . . . . . . . . . . . . . . . . .
TraCIServerAPI_Vehicle
APIs for getting/setting vehicle values via TraCI . . . . . . . . . . . . . . . . . . . . . . . . .
TraCIServerAPI_VehicleType
APIs for getting/setting vehicle type values via TraCI . . . . . . . . . . . . . . . . . . . . . . .
TraCIAPI::TrafficLightScope
Scope for interaction with traffic lights . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UnknownElement
UnknownElement Thrown when a named element is tried to be accesed which is not known to
the container . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ValueRetriever< T > . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ValueSource< T > . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ValueTimeLine< T >
A time line being a sorted container of non-overlapping time-ranges with assigned values . . .
VectorHelper< T > . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TraCIAPI::VehicleTypeScope
Scope for interaction with vehicle types . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
WrappingCommand< T >
A wrapper for a Command function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
rapidxml::xml_attribute< Ch >
Class representing attribute node of XML document . . . . . . . . . . . . . . . . . . . . . . .
rapidxml::xml_base< Ch >
Base class for xml_node and xml_attribute implementing common functions: name(), name_size(), value(), value_size() and parent() . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
rapidxml::xml_document< Ch >
This class represents root of the DOM hierarchy . . . . . . . . . . . . . . . . . . . . . . . . .
rapidxml::xml_node< Ch >
Class representing a node of XML document . . . . . . . . . . . . . . . . . . . . . . . . . .
XMLParser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
XMLSubSys
Utility methods for initialising, closing and using the XML-subsystem . . . . . . . . . . . . . .

330
332
332
334
335

336
336
336
337
339
339
340
342

347
350
362
371
371

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

Chapter 4

File Index
4.1

File List

Here is a list of all documented files with brief descriptions:


src/node/include/node/Component.hpp
This file declares the Component class . . . . . . . . . . . . . . . . . . . . . . . . . .
src/node/include/node/Logger.hpp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
src/node/include/node/rapidxml.hpp
This file contains rapidxml parser and DOM implementation . . . . . . . . . . . . . . . .
src/node/include/node/rapidxml_utils.hpp
This file contains high-level rapidxml utilities that can be useful in certain simple scenarios
src/node/include/node/xmlParser.hpp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
src/node/src/node/Component.cpp
This file contains definitions for the base Component class . . . . . . . . . . . . . . . .
src/node/src/node/node_main.cpp
This file contains the main function for a ROSMOD actor/node . . . . . . . . . . . . . .
src/pnp2/include/pnp2/buffer.hpp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
src/pnp2/include/pnp2/Client.hpp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
src/pnp2/include/pnp2/ConnectionSubsys.hpp . . . . . . . . . . . . . . . . . . . . . . . . . . .
src/pnp2/include/pnp2/CSVIterator.hpp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
src/pnp2/include/pnp2/list_func.hpp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
src/pnp2/include/pnp2/log_macro.hpp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
src/pnp2/include/pnp2/Message.hpp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
src/pnp2/include/pnp2/NetworkBuffer.hpp . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
src/pnp2/include/pnp2/NetworkMiddleware.hpp . . . . . . . . . . . . . . . . . . . . . . . . . .
src/pnp2/include/pnp2/NetworkProfile.hpp
This file declares the Network::ResourceEntry and Network::NetworkProfile classes . . .
src/pnp2/include/pnp2/oob.hpp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
src/pnp2/include/pnp2/receiver.hpp
This file declares the Network::receiver class . . . . . . . . . . . . . . . . . . . . . . .
src/pnp2/include/pnp2/sender.hpp
This file declares the Network::sender class . . . . . . . . . . . . . . . . . . . . . . . .
src/pnp2/include/pnp2/Server.hpp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
src/pnp2/include/pnp2/tcWrapper.hpp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
src/sumo/include/config.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
src/sumo/include/foreign/eulerspiral/angles.h . . . . . . . . . . . . . . . . . . . . . . . . . . . .
src/sumo/include/foreign/eulerspiral/BiArc.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
src/sumo/include/foreign/eulerspiral/euler.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
src/sumo/include/foreign/eulerspiral/points.h . . . . . . . . . . . . . . . . . . . . . . . . . . . .
src/sumo/include/foreign/mersenne/MersenneTwister.h . . . . . . . . . . . . . . . . . . . . . .
src/sumo/include/foreign/tcpip/socket.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
src/sumo/include/foreign/tcpip/storage.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . 375
. . . ??
. . . 375
. . . 377
. . . ??
. . . 378
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.

. 378
. ??
. ??
. ??
. ??
. ??
. ??
. ??
. ??
. ??

. . . 379
. . . ??
. . . 379
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.

. 380
. ??
. ??
. ??
. ??
. ??
. ??
. ??
. ??
. ??
. ??

14

File Index

src/sumo/include/sumo/sumo_client.hpp . . . . . . . . . . .
src/sumo/include/traci-server/TraCIConstants.h . . . . . . . .
src/sumo/include/traci-server/TraCIException.h . . . . . . . .
src/sumo/include/traci-server/TraCIServer.h . . . . . . . . . .
src/sumo/include/traci-server/TraCIServerAPI_ArealDetector.h
src/sumo/include/traci-server/TraCIServerAPI_Edge.h . . . . .
src/sumo/include/traci-server/TraCIServerAPI_InductionLoop.h
src/sumo/include/traci-server/TraCIServerAPI_Junction.h . . .
src/sumo/include/traci-server/TraCIServerAPI_Lane.h . . . . .
src/sumo/include/traci-server/TraCIServerAPI_MeMeDetector.h
src/sumo/include/traci-server/TraCIServerAPI_Person.h . . . .
src/sumo/include/traci-server/TraCIServerAPI_POI.h . . . . .
src/sumo/include/traci-server/TraCIServerAPI_Polygon.h . . .
src/sumo/include/traci-server/TraCIServerAPI_Route.h . . . .
src/sumo/include/traci-server/TraCIServerAPI_Simulation.h . .
src/sumo/include/traci-server/TraCIServerAPI_TLS.h . . . . .
src/sumo/include/traci-server/TraCIServerAPI_Vehicle.h . . . .
src/sumo/include/traci-server/TraCIServerAPI_VehicleType.h .
src/sumo/include/utils/common/AbstractMutex.h . . . . . . . .
src/sumo/include/utils/common/Command.h . . . . . . . . . .
src/sumo/include/utils/common/FileHelpers.h . . . . . . . . .
src/sumo/include/utils/common/IDSupplier.h . . . . . . . . . .
src/sumo/include/utils/common/MsgHandler.h . . . . . . . . .
src/sumo/include/utils/common/MsgRetrievingFunction.h . . .
src/sumo/include/utils/common/Named.h . . . . . . . . . . . .
src/sumo/include/utils/common/NamedObjectCont.h . . . . . .
src/sumo/include/utils/common/NamedRTree.h . . . . . . . .
src/sumo/include/utils/common/Parameterised.h . . . . . . . .
src/sumo/include/utils/common/RandHelper.h . . . . . . . . .
src/sumo/include/utils/common/RandomDistributor.h . . . . .
src/sumo/include/utils/common/RGBColor.h . . . . . . . . . .
src/sumo/include/utils/common/StaticCommand.h . . . . . . .
src/sumo/include/utils/common/StdDefs.h . . . . . . . . . . .
src/sumo/include/utils/common/StringBijection.h . . . . . . . .
src/sumo/include/utils/common/StringTokenizer.h . . . . . . .
src/sumo/include/utils/common/StringUtils.h . . . . . . . . . .
src/sumo/include/utils/common/SUMOTime.h . . . . . . . . .
src/sumo/include/utils/common/SUMOVehicleClass.h . . . . .
src/sumo/include/utils/common/SystemFrame.h . . . . . . . .
src/sumo/include/utils/common/SysUtils.h . . . . . . . . . . .
src/sumo/include/utils/common/ToString.h . . . . . . . . . . .
src/sumo/include/utils/common/TplConvert.h . . . . . . . . . .
src/sumo/include/utils/common/UtilExceptions.h . . . . . . . .
src/sumo/include/utils/common/ValueRetriever.h . . . . . . . .
src/sumo/include/utils/common/ValueSource.h . . . . . . . . .
src/sumo/include/utils/common/ValueTimeLine.h . . . . . . . .
src/sumo/include/utils/common/VectorHelper.h . . . . . . . . .
src/sumo/include/utils/common/WrappingCommand.h . . . . .
src/sumo/include/utils/iodevices/BinaryFormatter.h . . . . . .
src/sumo/include/utils/iodevices/BinaryInputDevice.h . . . . .
src/sumo/include/utils/iodevices/OutputDevice.h . . . . . . . .
src/sumo/include/utils/iodevices/OutputDevice_CERR.h . . . .
src/sumo/include/utils/iodevices/OutputDevice_COUT.h . . . .
src/sumo/include/utils/iodevices/OutputDevice_File.h . . . . .
src/sumo/include/utils/iodevices/OutputDevice_Network.h . . .
src/sumo/include/utils/iodevices/OutputDevice_String.h . . . .
src/sumo/include/utils/iodevices/OutputFormatter.h . . . . . .
src/sumo/include/utils/iodevices/PlainXMLFormatter.h . . . . .

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

??
380
386
387
??
388
388
389
389
390
391
391
392
392
393
394
394
395
395
396
397
397
398
399
399
400
401
401
402
403
403
404
404
406
406
407
407
409
415
416
416
418
418
419
420
420
421
422
422
423
424
424
425
425
426
427
427
428

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

4.1 File List

src/sumo/include/utils/options/Option.h . . . . . . . . . . . . . . . . . . . .
src/sumo/include/utils/options/OptionsCont.h . . . . . . . . . . . . . . . .
src/sumo/include/utils/options/OptionsIO.h . . . . . . . . . . . . . . . . . .
src/sumo/include/utils/options/OptionsLoader.h . . . . . . . . . . . . . . .
src/sumo/include/utils/options/OptionsParser.h . . . . . . . . . . . . . . . .
src/sumo/include/utils/traci/TraCIAPI.h . . . . . . . . . . . . . . . . . . . .
src/sumo/include/utils/xml/GenericSAXHandler.h . . . . . . . . . . . . . .
src/sumo/include/utils/xml/SAXWeightsHandler.h . . . . . . . . . . . . . .
src/sumo/include/utils/xml/SUMORouteHandler.h . . . . . . . . . . . . . .
src/sumo/include/utils/xml/SUMORouteLoader.h . . . . . . . . . . . . . . .
src/sumo/include/utils/xml/SUMORouteLoaderControl.h . . . . . . . . . . .
src/sumo/include/utils/xml/SUMOSAXAttributes.h . . . . . . . . . . . . . .
src/sumo/include/utils/xml/SUMOSAXAttributesImpl_Binary.h . . . . . . . .
src/sumo/include/utils/xml/SUMOSAXAttributesImpl_Xerces.h . . . . . . .
src/sumo/include/utils/xml/SUMOSAXHandler.h . . . . . . . . . . . . . . .
src/sumo/include/utils/xml/SUMOSAXReader.h . . . . . . . . . . . . . . .
src/sumo/include/utils/xml/SUMOVehicleParserHelper.h . . . . . . . . . . .
src/sumo/include/utils/xml/SUMOXMLDefinitions.h . . . . . . . . . . . . . .
src/sumo/include/utils/xml/XMLSubSys.h . . . . . . . . . . . . . . . . . . .
src/sumo/src/utils/common/FileHelpers.cpp . . . . . . . . . . . . . . . . .
src/sumo/src/utils/common/IDSupplier.cpp . . . . . . . . . . . . . . . . . .
src/sumo/src/utils/common/MsgHandler.cpp . . . . . . . . . . . . . . . . .
src/sumo/src/utils/common/Parameterised.cpp . . . . . . . . . . . . . . . .
src/sumo/src/utils/common/RandHelper.cpp . . . . . . . . . . . . . . . . .
src/sumo/src/utils/common/RGBColor.cpp . . . . . . . . . . . . . . . . . .
src/sumo/src/utils/common/StdDefs.cpp . . . . . . . . . . . . . . . . . . .
src/sumo/src/utils/common/StringTokenizer.cpp . . . . . . . . . . . . . . .
src/sumo/src/utils/common/StringUtils.cpp . . . . . . . . . . . . . . . . . .
src/sumo/src/utils/common/SUMOVehicleClass.cpp . . . . . . . . . . . . .
src/sumo/src/utils/common/SystemFrame.cpp . . . . . . . . . . . . . . . .
src/sumo/src/utils/common/SysUtils.cpp . . . . . . . . . . . . . . . . . . .
src/tlc_package/include/tlc_package/control_stream_ddos.hpp
This file declares the control_stream_ddos class; . . . . . . . . .
src/tlc_package/include/tlc_package/controller.hpp
This file declares the controller class; . . . . . . . . . . . . . . .
src/tlc_package/include/tlc_package/e3_sensor.hpp
This file declares the e3_sensor class; . . . . . . . . . . . . . . .
src/tlc_package/include/tlc_package/e3_sensor_stream_ddos.hpp
This file declares the e3_sensor_stream_ddos class; . . . . . . .
src/tlc_package/include/tlc_package/sumo_intf.hpp
This file declares the sumo_intf class; . . . . . . . . . . . . . . .
src/tlc_package/include/tlc_package/tl_actuator.hpp
This file declares the tl_actuator class; . . . . . . . . . . . . . . .
src/tlc_package/include/tlc_package/tl_sensor.hpp
This file declares the tl_sensor class; . . . . . . . . . . . . . . . .
src/tlc_package/include/tlc_package/tl_sensor_stream_ddos.hpp
This file declares the tl_sensor_stream_ddos class; . . . . . . . .
src/tlc_package/src/tlc_package/control_stream_ddos.cpp
This file contains definitions for the control_stream_ddos class; . .
src/tlc_package/src/tlc_package/controller.cpp
This file contains definitions for the controller class; . . . . . . . .
src/tlc_package/src/tlc_package/e3_sensor.cpp
This file contains definitions for the e3_sensor class; . . . . . . .
src/tlc_package/src/tlc_package/e3_sensor_stream_ddos.cpp
This file contains definitions for the e3_sensor_stream_ddos class;
src/tlc_package/src/tlc_package/sumo_intf.cpp
This file contains definitions for the sumo_intf class; . . . . . . . .
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

15

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

428
429
430
430
431
431
433
434
435
435
436
436
437
438
438
439
440
440
447
448
448
449
449
450
450
451
452
452
453
458
459

. . . . . . . . . . . . . . . 459
. . . . . . . . . . . . . . . 460
. . . . . . . . . . . . . . . 460
. . . . . . . . . . . . . . . 461
. . . . . . . . . . . . . . . 461
. . . . . . . . . . . . . . . 462
. . . . . . . . . . . . . . . 462
. . . . . . . . . . . . . . . 463
. . . . . . . . . . . . . . . 463
. . . . . . . . . . . . . . . 463
. . . . . . . . . . . . . . . 464
. . . . . . . . . . . . . . . 464
. . . . . . . . . . . . . . . 465

16

File Index

src/tlc_package/src/tlc_package/tl_actuator.cpp
This file contains definitions for the tl_actuator class; . . . . . . . . . . . . . . . . . . . . . . 465
src/tlc_package/src/tlc_package/tl_sensor.cpp
This file contains definitions for the tl_sensor class; . . . . . . . . . . . . . . . . . . . . . . . 466
src/tlc_package/src/tlc_package/tl_sensor_stream_ddos.cpp
This file contains definitions for the tl_sensor_stream_ddos class; . . . . . . . . . . . . . . . . 466

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

Chapter 5

Class Documentation
5.1

AbstractMutex Class Reference

An abstract class for encapsulating mutex implementations.

#include <AbstractMutex.h>

Classes
class ScopedLocker
A mutex encapsulator which locks/unlocks the given mutex on construction/destruction, respectively.

Public Member Functions


AbstractMutex ()
Constructor.

virtual AbstractMutex ()
Destructor.

virtual void lock ()=0


Locks the mutex.

virtual void unlock ()=0


Unlocks the mutex.

5.1.1

Detailed Description

An abstract class for encapsulating mutex implementations.


This class defines access to a mutex. The implementation may differ.
Within gui-applications, FXMutexes may be used while this is improper for command-line applications. Normally,
they do not need mutexes unless a synchronized communication with an external application is established. In
these cases, a further class should be implemented.
The documentation for this class was generated from the following file:
src/sumo/include/utils/common/AbstractMutex.h

18

Class Documentation

5.2

TraCIAPI::AreaScope Class Reference

Scope for interaction with areal detectors.

#include <TraCIAPI.h>
Inheritance diagram for TraCIAPI::AreaScope:

TraCIAPI::TraCIScopeWrapper
TraCIAPI::AreaScope

Public Member Functions

AreaScope (TraCIAPI &parent)


std::vector< std::string > getIDList () const
int getJamLengthVehicle (const std::string &laneID) const
SUMOReal getJamLengthMeters (const std::string &laneID) const

Protected Attributes
TraCIAPI & myParent
The parent TraCI client which offers the connection.

5.2.1

Detailed Description

Scope for interaction with areal detectors.


The documentation for this class was generated from the following files:
src/sumo/include/utils/traci/TraCIAPI.h
src/sumo/src/utils/traci/TraCIAPI.cpp

5.3

BiArc Class Reference

Public Member Functions

BiArc (Point2D< double > start_pt, double start_angle, Point2D< double > end_pt, double end_angle)
void compute_biarc_params ()
void compute_other_stuff ()
double compute_join_theta (double k1, double k2)
double compute_arclength (double theta0, double theta2, double k)
void set_start_params (Point2D< double > start_pt, double start_angle)
void set_end_params (Point2D< double > end_pt, double end_angle)

Public Attributes
BiArcParams params
The documentation for this class was generated from the following file:
src/sumo/include/foreign/eulerspiral/BiArc.h
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.4 BiArcParams Class Reference

5.4

19

BiArcParams Class Reference

Public Member Functions

BiArcParams (const BiArcParams &rhs)


BiArcParams & operator= (const BiArcParams &rhs)
double L ()
void scale (double factor)

Public Attributes

int flag
Point2D< double > start_pt
Point2D< double > end_pt
double start_angle
double end_angle
double K1
double K2
double L1
double L2
double E
double R1
double R2
int dir1
int dir2
Point2D< double > mid_pt
Point2D< double > center1
Point2D< double > center2

The documentation for this class was generated from the following file:
src/sumo/include/foreign/eulerspiral/BiArc.h

5.5

BinaryFormatter Class Reference

Output formatter for plain XML output.

#include <BinaryFormatter.h>
Inheritance diagram for BinaryFormatter:

OutputFormatter
BinaryFormatter

Public Types
enum DataType {
BF_BYTE, BF_INTEGER, BF_FLOAT, BF_STRING,
BF_LIST, BF_XML_TAG_START, BF_XML_TAG_END, BF_XML_ATTRIBUTE,
BF_EDGE, BF_LANE, BF_POSITION_2D, BF_POSITION_3D,
BF_BOUNDARY, BF_COLOR, BF_NODE_TYPE, BF_EDGE_FUNCTION,
BF_ROUTE, BF_SCALED2INT, BF_SCALED2INT_POSITION_2D, BF_SCALED2INT_POSITION_3D }
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

20

Class Documentation

data types in binary output

Public Member Functions


BinaryFormatter ()
Constructor.

virtual BinaryFormatter ()
Destructor.

bool writeXMLHeader (std::ostream &into, const std::string &rootElement, const std::string &attrs="", const
std::string &comment="")
Writes an XML header with optional configuration.

template<typename E >
bool writeHeader (std::ostream &into, const SumoXMLTag &rootElement)
Writes a header with optional edge list and connections.

void openTag (std::ostream &into, const std::string &xmlElement)


Opens an XML tag.

void openTag (std::ostream &into, const SumoXMLTag &xmlElement)


Opens an XML tag.

bool closeTag (std::ostream &into)


Closes the most recently opened tag.

void writePreformattedTag (std::ostream &into, const std::string &val)


writes a preformatted tag to the device but ensures that any pending tags are closed

template<>
void writeAttr (std::ostream &into, const SumoXMLAttr attr, const bool &val)
template<>
void writeAttr (std::ostream &into, const SumoXMLAttr attr, const SUMOReal &val)
template<>
void writeAttr (std::ostream &into, const SumoXMLAttr attr, const int &val)
template<>
void writeAttr (std::ostream &into, const SumoXMLAttr attr, const unsigned int &val)
template<>
void writeAttr (std::ostream &into, const SumoXMLAttr attr, const SumoXMLNodeType &val)
template<>
void writeAttr (std::ostream &into, const SumoXMLAttr attr, const SumoXMLEdgeFunc &val)
template<>
void writeAttr (std::ostream &into, const SumoXMLAttr attr, const Position &val)
template<>
void writeAttr (std::ostream &into, const SumoXMLAttr attr, const PositionVector &val)
template<>
void writeAttr (std::ostream &into, const SumoXMLAttr attr, const Boundary &val)
template<>
void writeAttr (std::ostream &into, const SumoXMLAttr attr, const RGBColor &val)
template<>
void writeAttr (std::ostream &into, const SumoXMLAttr attr, const std::vector< int > &val)

Static Public Member Functions


template<typename dummy , typename T >
static void writeAttr (dummy &into, const SumoXMLAttr attr, const T &val)
writes an arbitrary attribute

template<typename dummy , typename T >


static void writeAttr (dummy &into, const std::string &attr, const T &val)
writes a named attribute
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.5 BinaryFormatter Class Reference

21

template<typename dummy >


static void writeAttr (dummy &into, const SumoXMLAttr attr, const std::vector< const ROEdge > &val)
template<typename dummy >
static void writeAttr (dummy &into, const SumoXMLAttr attr, const std::vector< const MSEdge > &val)

5.5.1

Detailed Description

Output formatter for plain XML output.


BinaryFormatter format XML like output into the output stream.

5.5.2

Member Function Documentation

5.5.2.1

bool BinaryFormatter::closeTag ( std::ostream & into ) [virtual]

Closes the most recently opened tag.


Parameters
into

in

The output stream to use

Returns
Whether a further element existed in the stack and could be closed
Todo it is not verified that the topmost element was closed
Implements OutputFormatter.

5.5.2.2

void BinaryFormatter::openTag ( std::ostream & into, const std::string & xmlElement ) [virtual]

Opens an XML tag.


An indentation, depending on the current xml-element-stack size, is written followed by the given xml element ("<"
+ xmlElement) The xml element is added to the stack, then.
Parameters

in
in

into
xmlElement

The output stream to use


Name of element to open

Returns
The OutputDevice for further processing
Implements OutputFormatter.

5.5.2.3

void BinaryFormatter::openTag ( std::ostream & into, const SumoXMLTag & xmlElement ) [virtual]

Opens an XML tag.


Helper method which finds the correct string before calling openTag.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

22

Class Documentation

Parameters
into
xmlElement

in
in

The output stream to use


Id of the element to open

Implements OutputFormatter.

5.5.2.4

template<typename dummy , typename T > void BinaryFormatter::writeAttr ( dummy & into, const SumoXMLAttr
attr, const T & val ) [static]

writes an arbitrary attribute


Parameters
into
attr
val

in
in
in

5.5.2.5

The output stream to use


The attribute (name)
The attribute value

template<typename dummy , typename T > void BinaryFormatter::writeAttr ( dummy & into, const std::string & attr,
const T & val ) [static]

writes a named attribute


Parameters
into
attr
val

in
in
in

5.5.2.6

The output stream to use


The attribute (name)
The attribute value

template<typename E > bool BinaryFormatter::writeHeader ( std::ostream & into, const SumoXMLTag &
rootElement )

Writes a header with optional edge list and connections.


If something has been written (myXMLStack is not empty), nothing is written and false returned. This header is only
used by the binary formatter.
Parameters

in
in

5.5.2.7

into
rootElement

The output stream to use


The root element to use

void BinaryFormatter::writePreformattedTag ( std::ostream & into, const std::string & val ) [inline],

[virtual]
writes a preformatted tag to the device but ensures that any pending tags are closed
Parameters

in
in

into
val

The output stream to use


The preformatted data

Implements OutputFormatter.

5.5.2.8

bool BinaryFormatter::writeXMLHeader ( std::ostream & into, const std::string & rootElement, const std::string & attrs
= "", const std::string & comment = "" ) [virtual]

Writes an XML header with optional configuration.


Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.5 BinaryFormatter Class Reference

If something has been written (myXMLStack is not empty), nothing is written and false returned.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

23

24

Class Documentation

Parameters
into
rootElement
attrs
comment

in
in
in
in

The output stream to use


The root element to use
Additional attributes to save within the rootElement
Additional comment (saved in front the rootElement)

Todo Check which parameter is used herein


Describe what is saved
Implements OutputFormatter.
The documentation for this class was generated from the following file:
src/sumo/include/utils/iodevices/BinaryFormatter.h

5.6

BinaryInputDevice Class Reference

Encapsulates binary reading operations on a file.

#include <BinaryInputDevice.h>

Public Member Functions


BinaryInputDevice (const std::string &name, const bool isTyped=false, const bool doValidate=false)
Constructor.

BinaryInputDevice ()
Destructor.

bool good () const


Returns whether the file can be used (is good())

int peek ()
Returns the next character to be read by an actual parse.

std::string read (int numBytes)


Returns the next character to be read by an actual parse.

void putback (char c)


Returns the next character to be read by an actual parse.

Friends
BinaryInputDevice & operator>> (BinaryInputDevice &os, char &c)
Reads a char from the file (input operator)

BinaryInputDevice & operator>> (BinaryInputDevice &os, unsigned char &c)


Reads an unsigned char from the file (input operator)

BinaryInputDevice & operator>> (BinaryInputDevice &os, int &i)


Reads an int from the file (input operator)

BinaryInputDevice & operator>> (BinaryInputDevice &os, unsigned int &i)


Reads an unsigned int from the file (input operator)

BinaryInputDevice & operator>> (BinaryInputDevice &os, SUMOReal &f)


Reads a SUMOReal from the file (input operator)

BinaryInputDevice & operator>> (BinaryInputDevice &os, bool &b)


Reads a bool from the file (input operator)

BinaryInputDevice & operator>> (BinaryInputDevice &os, std::string &s)


Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.6 BinaryInputDevice Class Reference

25

Reads a string from the file (input operator)

BinaryInputDevice & operator>> (BinaryInputDevice &os, std::vector< std::string > &v)


Reads a string vector from the file (input operator)

BinaryInputDevice & operator>> (BinaryInputDevice &os, std::vector< unsigned int > &v)
Reads a string vector from the file (input operator)

BinaryInputDevice & operator>> (BinaryInputDevice &os, std::vector< std::vector< unsigned int > > &v)
Reads a string vector from the file (input operator)

BinaryInputDevice & operator>> (BinaryInputDevice &os, Position &p)


Reads a Position from the file (input operator)

5.6.1

Detailed Description

Encapsulates binary reading operations on a file.


This class opens a binary file stream for reading and offers read access functions on it.
Please note that the byte order is undefined. Also the length of each type is not defined on a global scale and may
differ across compilers or platforms.
Todo Recheck whether this class could be replaced by a "normal InputDevice"
Maybe some kind of a well-defined types should be used (so that they have a well-defined length)
Maybe the byte-order should be defined

5.6.2

Constructor & Destructor Documentation

5.6.2.1

BinaryInputDevice::BinaryInputDevice ( const std::string & name, const bool isTyped = false, const bool doValidate
= false )

Constructor.
Parameters

in

name

The name of the file to open for reading

5.6.3

Member Function Documentation

5.6.3.1

bool BinaryInputDevice::good ( ) const

Returns whether the file can be used (is good())


Returns
Whether the file is good

5.6.3.2

int BinaryInputDevice::peek ( )

Returns the next character to be read by an actual parse.


Returns
the next character which will be returned

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

26

Class Documentation

5.6.3.3

void BinaryInputDevice::putback ( char c )

Returns the next character to be read by an actual parse.


Returns
the next character which will be returned

5.6.3.4

std::string BinaryInputDevice::read ( int numBytes )

Returns the next character to be read by an actual parse.


Returns
the next character which will be returned

5.6.4

Friends And Related Function Documentation

5.6.4.1 BinaryInputDevice& operator>> ( BinaryInputDevice & os, char & c ) [friend]


Reads a char from the file (input operator)
Parameters

in,out
in

os
c

The BinaryInputDevice to read the char from


The char to store the read value into

Returns
The used BinaryInputDevice for further processing

5.6.4.2 BinaryInputDevice& operator>> ( BinaryInputDevice & os, unsigned char & c ) [friend]
Reads an unsigned char from the file (input operator)
Parameters

in,out
in

os
c

The BinaryInputDevice to read the char from


The char to store the read value into

Returns
The used BinaryInputDevice for further processing

5.6.4.3 BinaryInputDevice& operator>> ( BinaryInputDevice & os, int & i ) [friend]


Reads an int from the file (input operator)
Parameters

in,out

os

The BinaryInputDevice to read the int from

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.6 BinaryInputDevice Class Reference

in

27

The int to store the read value into

Returns
The used BinaryInputDevice for further processing

5.6.4.4 BinaryInputDevice& operator>> ( BinaryInputDevice & os, unsigned int & i ) [friend]
Reads an unsigned int from the file (input operator)
Parameters

in,out
in

os
i

The BinaryInputDevice to read the unsigned int from


The unsigned int to store the read value into

Returns
The used BinaryInputDevice for further processing

5.6.4.5 BinaryInputDevice& operator>> ( BinaryInputDevice & os, SUMOReal & f ) [friend]


Reads a SUMOReal from the file (input operator)
Parameters

in,out
in

os
i

The BinaryInputDevice to read the SUMOReal from


The SUMOReal to store the read value into

Returns
The used BinaryInputDevice for further processing

5.6.4.6 BinaryInputDevice& operator>> ( BinaryInputDevice & os, bool & b ) [friend]


Reads a bool from the file (input operator)
Parameters

in,out
in

os
i

The BinaryInputDevice to read the bool from


The bool to store the read value into

Returns
The used BinaryInputDevice for further processing

5.6.4.7 BinaryInputDevice& operator>> ( BinaryInputDevice & os, std::string & s ) [friend]


Reads a string from the file (input operator)
Reads the length of the string as an unsigned int, first. Reads then the specified number of chars into "myBuffer".
Please note that the buffer has a fixed size - longer strings will cause an error.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

28

Class Documentation

Parameters

in,out
in

os
s

The BinaryInputDevice to read the string from


The string to store the read value into

Returns
The used BinaryInputDevice for further processing
Todo Use either a buffer with a flexible size or report an error if the buffer is too small!

5.6.4.8 BinaryInputDevice& operator>> ( BinaryInputDevice & os, std::vector< std::string > & v ) [friend]
Reads a string vector from the file (input operator)
Reads the length of the vector as an unsigned int, first. Reads then the specified number of strings using the string
input operator. Please note that the buffer has a fixed size - longer strings will cause an error.
Parameters

in,out
in

os
v

The BinaryInputDevice to read the string from


The string vector to store the read value into

Returns
The used BinaryInputDevice for further processing
Todo Use either a buffer with a flexible size or report an error if the buffer is too small!

5.6.4.9 BinaryInputDevice& operator>> ( BinaryInputDevice & os, std::vector< unsigned int > & v ) [friend]
Reads a string vector from the file (input operator)
Reads the length of the vector as an unsigned int, first. Reads then the specified number of strings using the string
input operator. Please note that the buffer has a fixed size - longer strings will cause an error.
Parameters

in,out
in

os
v

The BinaryInputDevice to read the string from


The string vector to store the read value into

Returns
The used BinaryInputDevice for further processing
Todo Use either a buffer with a flexible size or report an error if the buffer is too small!

5.6.4.10 BinaryInputDevice& operator>> ( BinaryInputDevice & os, std::vector< std::vector< unsigned int > > & v
) [friend]
Reads a string vector from the file (input operator)
Reads the length of the vector as an unsigned int, first. Reads then the specified number of strings using the string
input operator. Please note that the buffer has a fixed size - longer strings will cause an error.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.7 BoolFormatException Class Reference

29

Parameters

in,out
in

os
v

The BinaryInputDevice to read the string from


The string vector to store the read value into

Returns
The used BinaryInputDevice for further processing
Todo Use either a buffer with a flexible size or report an error if the buffer is too small!

5.6.4.11 BinaryInputDevice& operator>> ( BinaryInputDevice & os, Position & p ) [friend]


Reads a Position from the file (input operator)
Parameters

in,out
in

os
p

The BinaryInputDevice to read the Position from


The Position to store the read value into

Returns
The used BinaryInputDevice for further processing
The documentation for this class was generated from the following file:
src/sumo/include/utils/iodevices/BinaryInputDevice.h

5.7

BoolFormatException Class Reference

BoolFormatException Thrown when the string that shall be converted into a boolean does not match.

#include <UtilExceptions.h>
Inheritance diagram for BoolFormatException:

runtime_error
FormatException
BoolFormatException

Public Member Functions


BoolFormatException ()
constructor

5.7.1

Detailed Description

BoolFormatException Thrown when the string that shall be converted into a boolean does not match.
The documentation for this class was generated from the following file:
src/sumo/include/utils/common/UtilExceptions.h
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

30

Class Documentation

5.8

Network::Buffer_Empty Class Reference

The documentation for this class was generated from the following file:
src/pnp2/include/pnp2/buffer.hpp

5.9

Command Class Reference

Base (microsim) event class.

#include <Command.h>
Inheritance diagram for Command:

Command
StaticCommand< T >

WrappingCommand< T >

Public Member Functions


Command ()
Constructor.

virtual Command ()
Destructor.

virtual SUMOTime execute (SUMOTime currentTime)=0


Executes the command.

5.9.1

Detailed Description

Base (microsim) event class.


Classes derived from Command may be added to MSEventControl instances in order to be executed at a certain
time step.
As soon as the simulation reaches the desired time step, the command (event) is executed by calling "execute" with
the current time step. The method must return either 0, if the event shall not be executed again or a positive value
(in simulation seconds) that described when it shall be executed again. The method must not return a value below
zero, the behaviour is undefined in this case.
Warning
The EventControl the Command is added to gets responsible for this commands deletion.

See Also
Design Patterns, Gamma et al.
WrappingCommand
MSEventControl
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.10 Named::ComparatorIdLess Struct Reference

5.9.2

Member Function Documentation

5.9.2.1

virtual SUMOTime Command::execute ( SUMOTime currentTime ) [pure virtual]

31

Executes the command.


The implementations should return 0 if the command shall not be repeated, or a value larger than 0 that describe
the time after which the command shall be executed again. Values below 0 must not be returned.
Parameters
currentTime

in

The current simulation time

Returns
The time after which the command shall be executed again, 0 if this command shall be descheduled.

Exceptions
ProcessError

Derived actions may throw this exception

Implemented in WrappingCommand< T >, and StaticCommand< T >.


The documentation for this class was generated from the following file:
src/sumo/include/utils/common/Command.h

5.10

Named::ComparatorIdLess Struct Reference

Function-object for stable sorting in containers.

#include <Named.h>

Public Member Functions


bool operator() (Named const a, Named const b) const

5.10.1

Detailed Description

Function-object for stable sorting in containers.


The documentation for this struct was generated from the following file:
src/sumo/include/utils/common/Named.h

5.11

Component Class Reference

Component class.

#include <Component.hpp>
Inheritance diagram for Component:
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

32

Class Documentation

Component
control_stream_ddos
controller
e3_sensor
e3_sensor_stream_ddos
sumo_intf
tl_actuator
tl_sensor
tl_sensor_stream_ddos

Public Member Functions


Component (ComponentConfig &_config, int argc, char argv)
Component Constructor.

virtual void startUp ()=0


Component startup function.

virtual void init_timer_operation (const NAMESPACE::TimerEvent &event)


Component Initializer This operation is executed immediately after startup.

virtual void component_sync_operation (const std_msgs::Bool::ConstPtr &received_data)


Component Synchronization This operation establishing a sync point with other components.

void process_queue ()
Component Message Queue handler.

Component ()
Component Destructor.

Protected Attributes
ComponentConfig config
int node_argc
char node_argv
NAMESPACE::Publisher comp_sync_pub
NAMESPACE::Subscriber comp_sync_sub
NAMESPACE::Timer init_timer
NAMESPACE::CallbackQueue comp_queue
std::unique_ptr< Logger > logger

5.11.1

Detailed Description

Component class.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.11 Component Class Reference

33

5.11.2

Constructor & Destructor Documentation

5.11.2.1

Component::Component ( ComponentConfig & _config, int argc, char argv )

Component Constructor.
Parameters
_config
argc
argv

in
in

Component configuration parsed from deployment XML


command-line argument count
command-line arguments of the actor process

5.11.3

Member Function Documentation

5.11.3.1

void Component::component_sync_operation ( const std_msgs::Bool::ConstPtr & received_data ) [virtual]

Component Synchronization This operation establishing a sync point with other components.
Parameters
received_data

in

5.11.3.2

Notification message from other components

void Component::init_timer_operation ( const NAMESPACE::TimerEvent & event ) [virtual]

Component Initializer This operation is executed immediately after startup.


Parameters
event

in

a oneshot timer event

See Also
startUp()
Reimplemented in controller, sumo_intf, e3_sensor, tl_actuator, tl_sensor, control_stream_ddos, e3_sensor_stream_ddos, and tl_sensor_stream_ddos.

5.11.3.3

virtual void Component::startUp ( ) [pure virtual]

Component startup function.


This function configures all the component ports and timers
Implemented in sumo_intf, controller, e3_sensor, tl_actuator, tl_sensor, control_stream_ddos, e3_sensor_stream_ddos, and tl_sensor_stream_ddos.

5.11.4

Member Data Documentation

5.11.4.1

NAMESPACE::CallbackQueue Component::comp_queue [protected]

Component Message Queue

5.11.4.2

NAMESPACE::Publisher Component::comp_sync_pub [protected]

Synchronization publisher
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

34

Class Documentation

5.11.4.3

NAMESPACE::Subscriber Component::comp_sync_sub [protected]

Synchronization subscriber

5.11.4.4 ComponentConfig Component::config [protected]


Component Configuration

5.11.4.5

NAMESPACE::Timer Component::init_timer [protected]

Initialization timer

5.11.4.6

std::unique_ptr<Logger> Component::logger [protected]

Component logger object

5.11.4.7

int Component::node_argc [protected]

argc received by the actor process

5.11.4.8

char Component::node_argv [protected]

argv received by the actor process


The documentation for this class was generated from the following files:
src/node/include/node/Component.hpp
src/node/src/node/Component.cpp

5.12

ComponentConfig Class Reference

Public Attributes

std::string libraryLocation
std::string schedulingScheme
std::string hostName
std::string nodeName
std::string compName
std::map< std::string,
std::string > portGroupMap
uint64_t num_comps_to_sync
double comp_sync_timeout
std::map< std::string, uint64_t > uuidMap
std::map< std::string,
std::string > profileMap
std::map< std::string,
std::map< uint64_t,
std::string > > portSenderMap
bool is_periodic_logging
int periodic_log_unit

The documentation for this class was generated from the following file:
src/node/include/node/xmlParser.hpp
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.13 Connection Class Reference

5.13

35

Connection Class Reference

Inheritance diagram for Connection:

Connection

IPV4_Connection

IPV6_Connection

Public Member Functions


Connection (const Connection &s)
Connection & operator= (const Connection &s)
virtual void swap (Connection &s)
virtual Connection clone () const
int Initialize (bool server)
virtual void Close ()
virtual long Send (const char buffer, long len)
virtual long Receive (char buffer, long len)
virtual int InitializeServer ()
virtual int InitializeClient ()

Public Attributes
bool isServer
std::string serverIP
int bufferSize
int serverPort
int receiveTimeout
The documentation for this class was generated from the following file:
src/pnp2/include/pnp2/ConnectionSubsys.hpp

5.14

control_stream_ddos Class Reference

Component Message and Service Headers.

#include <control_stream_ddos.hpp>
Inheritance diagram for control_stream_ddos:

Component
control_stream_ddos

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

36

Class Documentation

Public Member Functions


control_stream_ddos (ComponentConfig &_config, int argc, char argv)
control_stream_ddos Constructor.

void init_timer_operation (const NAMESPACE::TimerEvent &event)


control_stream_ddos Initializer This operation is executed immediately after startup.

void startUp ()
Component startup function.

control_stream_ddos ()
control_stream_ddos Destructor

virtual void component_sync_operation (const std_msgs::Bool::ConstPtr &received_data)


Component Synchronization This operation establishing a sync point with other components.

void process_queue ()
Component Message Queue handler.

Protected Attributes

ComponentConfig config
int node_argc
char node_argv
NAMESPACE::Publisher comp_sync_pub
NAMESPACE::Subscriber comp_sync_sub
NAMESPACE::Timer init_timer
NAMESPACE::CallbackQueue comp_queue
std::unique_ptr< Logger > logger

5.14.1

Detailed Description

Component Message and Service Headers.


Forward declarations control_stream_ddos class

5.14.2
5.14.2.1

Constructor & Destructor Documentation


control_stream_ddos::control_stream_ddos ( ComponentConfig & _config, int argc, char argv )

[inline]
control_stream_ddos Constructor.
Parameters
_config
argc
argv

in
in

5.14.3
5.14.3.1

Component configuration parsed from deployment XML


command-line argument count
command-line arguments of the actor process

Member Function Documentation


void Component::component_sync_operation ( const std_msgs::Bool::ConstPtr & received_data ) [virtual],

[inherited]
Component Synchronization This operation establishing a sync point with other components.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.14 control_stream_ddos Class Reference


Parameters
received_data

in

5.14.3.2

Notification message from other components

void control_stream_ddos::init_timer_operation ( const NAMESPACE::TimerEvent & event ) [virtual]

control_stream_ddos Initializer This operation is executed immediately after startup.


Parameters
event

in

a oneshot timer event

See Also
startUp()
Reimplemented from Component.

5.14.3.3

void control_stream_ddos::startUp ( ) [virtual]

Component startup function.


This function configures all the component ports and timers
Implements Component.

5.14.4

Member Data Documentation

5.14.4.1

NAMESPACE::CallbackQueue Component::comp_queue [protected], [inherited]

Component Message Queue

5.14.4.2

NAMESPACE::Publisher Component::comp_sync_pub [protected], [inherited]

Synchronization publisher

5.14.4.3

NAMESPACE::Subscriber Component::comp_sync_sub [protected], [inherited]

Synchronization subscriber

5.14.4.4 ComponentConfig Component::config [protected], [inherited]


Component Configuration

5.14.4.5

NAMESPACE::Timer Component::init_timer [protected], [inherited]

Initialization timer

5.14.4.6

std::unique_ptr<Logger> Component::logger [protected], [inherited]

Component logger object


Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

37

38

Class Documentation

5.14.4.7

int Component::node_argc [protected], [inherited]

argc received by the actor process

5.14.4.8

char Component::node_argv [protected], [inherited]

argv received by the actor process


The documentation for this class was generated from the following files:
src/tlc_package/include/tlc_package/control_stream_ddos.hpp
src/tlc_package/src/tlc_package/control_stream_ddos.cpp

5.15

controller Class Reference

Component Message and Service Headers.

#include <controller.hpp>
Inheritance diagram for controller:

Component
controller

Public Member Functions


controller (ComponentConfig &_config, int argc, char argv)
controller Constructor.

void init_timer_operation (const NAMESPACE::TimerEvent &event)


controller Initializer This operation is executed immediately after startup.

void controller_timer_operation (const NAMESPACE::TimerEvent &event)


controller_timer_operation;

void sensor_state_sub_operation (const tlc_package::sensor_state::ConstPtr &received_data)


sensor_state_sub_operation;

void ryg_state_sub_operation (const tlc_package::ryg_state::ConstPtr &received_data)


ryg_state_sub_operation;

void startUp ()
Component startup function.

controller ()
controller Destructor

virtual void component_sync_operation (const std_msgs::Bool::ConstPtr &received_data)


Component Synchronization This operation establishing a sync point with other components.

void process_queue ()
Component Message Queue handler.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.15 controller Class Reference

39

Protected Attributes

ComponentConfig config
int node_argc
char node_argv
NAMESPACE::Publisher comp_sync_pub
NAMESPACE::Subscriber comp_sync_sub
NAMESPACE::Timer init_timer
NAMESPACE::CallbackQueue comp_queue
std::unique_ptr< Logger > logger

5.15.1

Detailed Description

Component Message and Service Headers.


Forward declarations controller class

5.15.2

Constructor & Destructor Documentation

5.15.2.1

controller::controller ( ComponentConfig & _config, int argc, char argv ) [inline]

controller Constructor.
Parameters
_config
argc
argv

in
in

5.15.3
5.15.3.1

Component configuration parsed from deployment XML


command-line argument count
command-line arguments of the actor process

Member Function Documentation


void Component::component_sync_operation ( const std_msgs::Bool::ConstPtr & received_data ) [virtual],

[inherited]
Component Synchronization This operation establishing a sync point with other components.
Parameters
received_data

in

5.15.3.2

Notification message from other components

void controller::controller_timer_operation ( const NAMESPACE::TimerEvent & event )

controller_timer_operation;
This operation is executed every time the controller_timer operation request is serviced
Parameters

in

5.15.3.3

event

a timer event

void controller::init_timer_operation ( const NAMESPACE::TimerEvent & event ) [virtual]

controller Initializer This operation is executed immediately after startup.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

40

Class Documentation

Parameters
event

in

a oneshot timer event

See Also
startUp()
Reimplemented from Component.

5.15.3.4

void controller::ryg_state_sub_operation ( const tlc_package::ryg_state::ConstPtr & received_data )

ryg_state_sub_operation;
This operation is executed every time the ryg_state_sub operation request is serviced
Parameters
received_data

in

5.15.3.5

message received by the component subscriber

void controller::sensor_state_sub_operation ( const tlc_package::sensor_state::ConstPtr & received_data )

sensor_state_sub_operation;
This operation is executed every time the sensor_state_sub operation request is serviced
Parameters

in

5.15.3.6

received_data

message received by the component subscriber

void controller::startUp ( ) [virtual]

Component startup function.


This function configures all the component ports and timers
Implements Component.

5.15.4

Member Data Documentation

5.15.4.1

NAMESPACE::CallbackQueue Component::comp_queue [protected], [inherited]

Component Message Queue

5.15.4.2

NAMESPACE::Publisher Component::comp_sync_pub [protected], [inherited]

Synchronization publisher

5.15.4.3

NAMESPACE::Subscriber Component::comp_sync_sub [protected], [inherited]

Synchronization subscriber

5.15.4.4 ComponentConfig Component::config [protected], [inherited]


Component Configuration
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.16 CSVIterator Class Reference

5.15.4.5

NAMESPACE::Timer Component::init_timer [protected], [inherited]

Initialization timer

5.15.4.6

std::unique_ptr<Logger> Component::logger [protected], [inherited]

Component logger object

5.15.4.7

int Component::node_argc [protected], [inherited]

argc received by the actor process

5.15.4.8

char Component::node_argv [protected], [inherited]

argv received by the actor process


The documentation for this class was generated from the following files:
src/tlc_package/include/tlc_package/controller.hpp
src/tlc_package/src/tlc_package/controller.cpp

5.16

CSVIterator Class Reference

Public Types

typedef std::input_iterator_tag iterator_category


typedef CSVRow value_type
typedef std::size_t difference_type
typedef CSVRow pointer
typedef CSVRow & reference

Public Member Functions

CSVIterator (std::istream &str)


CSVIterator & operator++ ()
CSVIterator operator++ (int)
CSVRow const & operator () const
CSVRow const operator-> () const
bool operator== (CSVIterator const &rhs)
bool operator!= (CSVIterator const &rhs)

The documentation for this class was generated from the following file:
src/pnp2/include/pnp2/CSVIterator.hpp

5.17

CSVRow Class Reference

Public Member Functions


std::string const & operator[ ] (std::size_t index) const
std::size_t size () const
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

41

42

Class Documentation

void readNextRow (std::istream &str)


The documentation for this class was generated from the following file:
src/pnp2/include/pnp2/CSVIterator.hpp

5.18

e3_sensor Class Reference

Component Message and Service Headers.

#include <e3_sensor.hpp>
Inheritance diagram for e3_sensor:

Component
e3_sensor

Public Member Functions


e3_sensor (ComponentConfig &_config, int argc, char argv)
e3_sensor Constructor.

void init_timer_operation (const NAMESPACE::TimerEvent &event)


e3_sensor Initializer This operation is executed immediately after startup.

void e3_update_timer_operation (const NAMESPACE::TimerEvent &event)


e3_update_timer_operation;

void startUp ()
Component startup function.

e3_sensor ()
e3_sensor Destructor

virtual void component_sync_operation (const std_msgs::Bool::ConstPtr &received_data)


Component Synchronization This operation establishing a sync point with other components.

void process_queue ()
Component Message Queue handler.

Protected Attributes

5.18.1

ComponentConfig config
int node_argc
char node_argv
NAMESPACE::Publisher comp_sync_pub
NAMESPACE::Subscriber comp_sync_sub
NAMESPACE::Timer init_timer
NAMESPACE::CallbackQueue comp_queue
std::unique_ptr< Logger > logger

Detailed Description

Component Message and Service Headers.


Forward declarations e3_sensor class
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.18 e3_sensor Class Reference

43

5.18.2

Constructor & Destructor Documentation

5.18.2.1

e3_sensor::e3_sensor ( ComponentConfig & _config, int argc, char argv ) [inline]

e3_sensor Constructor.
Parameters
_config
argc
argv

in
in

5.18.3
5.18.3.1

Component configuration parsed from deployment XML


command-line argument count
command-line arguments of the actor process

Member Function Documentation


void Component::component_sync_operation ( const std_msgs::Bool::ConstPtr & received_data ) [virtual],

[inherited]
Component Synchronization This operation establishing a sync point with other components.
Parameters
received_data

in

5.18.3.2

Notification message from other components

void e3_sensor::e3_update_timer_operation ( const NAMESPACE::TimerEvent & event )

e3_update_timer_operation;
This operation is executed every time the e3_update_timer operation request is serviced
Parameters
event

in

5.18.3.3

a timer event

void e3_sensor::init_timer_operation ( const NAMESPACE::TimerEvent & event ) [virtual]

e3_sensor Initializer This operation is executed immediately after startup.


Parameters
event

in

a oneshot timer event

See Also
startUp()
Reimplemented from Component.

5.18.3.4

void e3_sensor::startUp ( ) [virtual]

Component startup function.


This function configures all the component ports and timers
Implements Component.

5.18.4

Member Data Documentation

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

44

Class Documentation

5.18.4.1

NAMESPACE::CallbackQueue Component::comp_queue [protected], [inherited]

Component Message Queue

5.18.4.2

NAMESPACE::Publisher Component::comp_sync_pub [protected], [inherited]

Synchronization publisher

5.18.4.3

NAMESPACE::Subscriber Component::comp_sync_sub [protected], [inherited]

Synchronization subscriber

5.18.4.4 ComponentConfig Component::config [protected], [inherited]


Component Configuration

5.18.4.5

NAMESPACE::Timer Component::init_timer [protected], [inherited]

Initialization timer

5.18.4.6

std::unique_ptr<Logger> Component::logger [protected], [inherited]

Component logger object

5.18.4.7

int Component::node_argc [protected], [inherited]

argc received by the actor process

5.18.4.8

char Component::node_argv [protected], [inherited]

argv received by the actor process


The documentation for this class was generated from the following files:
src/tlc_package/include/tlc_package/e3_sensor.hpp
src/tlc_package/src/tlc_package/e3_sensor.cpp

5.19

e3_sensor_stream_ddos Class Reference

Component Message and Service Headers.

#include <e3_sensor_stream_ddos.hpp>
Inheritance diagram for e3_sensor_stream_ddos:

Component
e3_sensor_stream_ddos

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.19 e3_sensor_stream_ddos Class Reference

45

Public Member Functions


e3_sensor_stream_ddos (ComponentConfig &_config, int argc, char argv)
e3_sensor_stream_ddos Constructor.

void init_timer_operation (const NAMESPACE::TimerEvent &event)


e3_sensor_stream_ddos Initializer This operation is executed immediately after startup.

void startUp ()
Component startup function.

e3_sensor_stream_ddos ()
e3_sensor_stream_ddos Destructor

virtual void component_sync_operation (const std_msgs::Bool::ConstPtr &received_data)


Component Synchronization This operation establishing a sync point with other components.

void process_queue ()
Component Message Queue handler.

Protected Attributes

ComponentConfig config
int node_argc
char node_argv
NAMESPACE::Publisher comp_sync_pub
NAMESPACE::Subscriber comp_sync_sub
NAMESPACE::Timer init_timer
NAMESPACE::CallbackQueue comp_queue
std::unique_ptr< Logger > logger

5.19.1

Detailed Description

Component Message and Service Headers.


Forward declarations e3_sensor_stream_ddos class

5.19.2
5.19.2.1

Constructor & Destructor Documentation


e3_sensor_stream_ddos::e3_sensor_stream_ddos ( ComponentConfig & _config, int argc, char argv )

[inline]
e3_sensor_stream_ddos Constructor.
Parameters
_config
argc
argv

in
in

5.19.3
5.19.3.1

Component configuration parsed from deployment XML


command-line argument count
command-line arguments of the actor process

Member Function Documentation


void Component::component_sync_operation ( const std_msgs::Bool::ConstPtr & received_data ) [virtual],

[inherited]
Component Synchronization This operation establishing a sync point with other components.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

46

Class Documentation

Parameters
received_data

in

5.19.3.2

Notification message from other components

void e3_sensor_stream_ddos::init_timer_operation ( const NAMESPACE::TimerEvent & event ) [virtual]

e3_sensor_stream_ddos Initializer This operation is executed immediately after startup.


Parameters
event

in

a oneshot timer event

See Also
startUp()
Reimplemented from Component.

5.19.3.3

void e3_sensor_stream_ddos::startUp ( ) [virtual]

Component startup function.


This function configures all the component ports and timers
Implements Component.

5.19.4

Member Data Documentation

5.19.4.1

NAMESPACE::CallbackQueue Component::comp_queue [protected], [inherited]

Component Message Queue

5.19.4.2

NAMESPACE::Publisher Component::comp_sync_pub [protected], [inherited]

Synchronization publisher

5.19.4.3

NAMESPACE::Subscriber Component::comp_sync_sub [protected], [inherited]

Synchronization subscriber

5.19.4.4 ComponentConfig Component::config [protected], [inherited]


Component Configuration

5.19.4.5

NAMESPACE::Timer Component::init_timer [protected], [inherited]

Initialization timer

5.19.4.6

std::unique_ptr<Logger> Component::logger [protected], [inherited]

Component logger object


Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.20 SAXWeightsHandler::EdgeFloatTimeLineRetriever Class Reference

5.19.4.7

47

int Component::node_argc [protected], [inherited]

argc received by the actor process

char Component::node_argv [protected], [inherited]

5.19.4.8

argv received by the actor process


The documentation for this class was generated from the following files:
src/tlc_package/include/tlc_package/e3_sensor_stream_ddos.hpp
src/tlc_package/src/tlc_package/e3_sensor_stream_ddos.cpp

5.20

SAXWeightsHandler::EdgeFloatTimeLineRetriever Class Reference

Interface for a class which obtains read weights for named edges.

#include <SAXWeightsHandler.h>

Public Member Functions


EdgeFloatTimeLineRetriever ()
Constructor.

virtual EdgeFloatTimeLineRetriever ()
Destructor.

virtual void addEdgeWeight (const std::string &id, SUMOReal val, SUMOReal beg, SUMOReal end) const =0
Adds a weight for a given edge and time period.

5.20.1

Detailed Description

Interface for a class which obtains read weights for named edges.

5.20.2

Member Function Documentation

5.20.2.1

virtual void SAXWeightsHandler::EdgeFloatTimeLineRetriever::addEdgeWeight ( const std::string & id, SUMOReal val,


SUMOReal beg, SUMOReal end ) const [pure virtual]

Adds a weight for a given edge and time period.


Parameters

in
in
in
in

id
val
beg
end

The id of the object to add a weight for


The weight
The begin of the interval the weight is valid for
The end of the interval the weight is valid for

The documentation for this class was generated from the following file:
src/sumo/include/utils/xml/SAXWeightsHandler.h
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

48

Class Documentation

5.21

TraCIAPI::EdgeScope Class Reference

Scope for interaction with edges.

#include <TraCIAPI.h>
Inheritance diagram for TraCIAPI::EdgeScope:

TraCIAPI::TraCIScopeWrapper
TraCIAPI::EdgeScope

Public Member Functions


EdgeScope (TraCIAPI &parent)
std::vector< std::string > getIDList () const
unsigned int getIDCount () const
SUMOReal getAdaptedTraveltime (const std::string &edgeID, SUMOTime time) const
SUMOReal getEffort (const std::string &edgeID, SUMOTime time) const
SUMOReal getCO2Emission (const std::string &edgeID) const
SUMOReal getCOEmission (const std::string &edgeID) const
SUMOReal getHCEmission (const std::string &edgeID) const
SUMOReal getPMxEmission (const std::string &edgeID) const
SUMOReal getNOxEmission (const std::string &edgeID) const
SUMOReal getFuelConsumption (const std::string &edgeID) const
SUMOReal getNoiseEmission (const std::string &edgeID) const
SUMOReal getLastStepMeanSpeed (const std::string &edgeID) const
SUMOReal getLastStepOccupancy (const std::string &edgeID) const
SUMOReal getLastStepLength (const std::string &edgeID) const
SUMOReal getTraveltime (const std::string &edgeID) const
unsigned int getLastStepVehicleNumber (const std::string &edgeID) const
SUMOReal getLastStepHaltingNumber (const std::string &edgeID) const
std::vector< std::string > getLastStepVehicleIDs (const std::string &edgeID) const
void adaptTraveltime (const std::string &edgeID, SUMOReal time) const
void setEffort (const std::string &edgeID, SUMOReal effort) const
void setMaxSpeed (const std::string &edgeID, SUMOReal speed) const

Protected Attributes
TraCIAPI & myParent
The parent TraCI client which offers the connection.

5.21.1

Detailed Description

Scope for interaction with edges.


The documentation for this class was generated from the following files:
src/sumo/include/utils/traci/TraCIAPI.h
src/sumo/src/utils/traci/TraCIAPI.cpp
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.22 EmptyData Class Reference

5.22

49

EmptyData Class Reference

EmptyData Thrown when data required by a method is missing.

#include <UtilExceptions.h>
Inheritance diagram for EmptyData:

runtime_error
EmptyData

Public Member Functions


EmptyData ()
constructor

5.22.1

Detailed Description

EmptyData Thrown when data required by a method is missing.


The documentation for this class was generated from the following file:
src/sumo/include/utils/common/UtilExceptions.h

5.23

StringBijection< T >::Entry Struct Reference

Public Attributes
const char str
const T key
The documentation for this struct was generated from the following file:
src/sumo/include/utils/common/StringBijection.h

5.24

EulerSpiral Class Reference

Public Member Functions


EulerSpiral (Point2D< double > start_pt, double start_angle, Point2D< double > end_pt, double end_angle)
EulerSpiral (Point2D< double > start_pt, double start_angle, double k0, double gamma, double L)
void set_start_params (Point2D< double > start_pt, double start_angle)
void set_end_params (Point2D< double > end_pt, double end_angle)
void set_params (Point2D< double > start_pt, double start_angle, Point2D< double > end_pt, double end_angle)
void compute_es_params ()
void computeSpiral (std::vector< Point2D< double > > &spiral, double ds=0, int NPts=0)
Point2D< double > get_fresnel_integral (double value)
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

50

Class Documentation

Point2D< double > compute_end_pt (double arclength, bool bNormalized=false)


Point2D< double > compute_end_pt (double k0, double gamma, double L, bool bNormalized=false)
Point2D< double > compute_es_point (EulerSpiralParams &es_params, double arclength, bool bNormalized=false)
double compute_error (double k0, double L)

Public Attributes
EulerSpiralParams params
std::vector< Point2D< double > > pts
The documentation for this class was generated from the following file:
src/sumo/include/foreign/eulerspiral/euler.h

5.25

EulerSpiralLookupTable Class Reference

Public Member Functions

double k0 (double start_angle, double end_angle)


double k1 (double start_angle, double end_angle)
double gamma (double start_angle, double end_angle)
double L (double start_angle, double end_angle)
double dt ()
double theta (int N)

Static Public Member Functions


static EulerSpiralLookupTable get_globalEulerSpiralLookupTable ()
The documentation for this class was generated from the following file:
src/sumo/include/foreign/eulerspiral/euler.h

5.26

EulerSpiralParams Class Reference

Public Member Functions


EulerSpiralParams (const EulerSpiralParams &rhs)
EulerSpiralParams & operator= (const EulerSpiralParams &rhs)

Public Attributes

Point2D< double > start_pt


Point2D< double > end_pt
double start_angle
double end_angle
double K0
double K2
double gamma
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.27 Network::Exceeded_Production_profile Class Reference

double L
double turningAngle
double error
double psi

The documentation for this class was generated from the following file:
src/sumo/include/foreign/eulerspiral/euler.h

5.27

Network::Exceeded_Production_profile Class Reference

Exception class thrown when application exceeds allowed data production.

#include <sender.hpp>

5.27.1

Detailed Description

Exception class thrown when application exceeds allowed data production.


The documentation for this class was generated from the following file:
src/pnp2/include/pnp2/sender.hpp

5.28

Network::Exceeded_Production_Profile Class Reference

Exception class thrown when application exceeds allowed data production.

#include <NetworkProfile.hpp>

5.28.1

Detailed Description

Exception class thrown when application exceeds allowed data production.


The documentation for this class was generated from the following file:
src/pnp2/include/pnp2/NetworkProfile.hpp

5.29

rapidxml::file< Ch > Class Template Reference

Represents data loaded from a file.

#include <rapidxml_utils.hpp>

Public Member Functions


file (const char filename)
Loads file into the memory.

file (std::basic_istream< Ch > &stream)


Loads file into the memory.

Ch data ()
Gets file data.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

51

52

Class Documentation
const Ch data () const
Gets file data.

std::size_t size () const


Gets file data size.

5.29.1

Detailed Description

template<class Ch = char>class rapidxml::file< Ch >


Represents data loaded from a file.

5.29.2

Constructor & Destructor Documentation

5.29.2.1

template<class Ch = char> rapidxml::file< Ch >::file ( const char filename ) [inline]

Loads file into the memory.


Data will be automatically destroyed by the destructor.
Parameters
filename

5.29.2.2

Filename to load.

template<class Ch = char> rapidxml::file< Ch >::file ( std::basic_istream< Ch > & stream ) [inline]

Loads file into the memory.


Data will be automatically destroyed by the destructor
Parameters
stream

Stream to load from

5.29.3

Member Function Documentation

5.29.3.1

template<class Ch = char> Ch rapidxml::file< Ch >::data ( ) [inline]

Gets file data.


Returns
Pointer to data of file.

5.29.3.2

template<class Ch = char> const Ch rapidxml::file< Ch >::data ( ) const [inline]

Gets file data.


Returns
Pointer to data of file.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.30 FileHelpers Class Reference

5.29.3.3

template<class Ch = char> std::size_t rapidxml::file< Ch >::size ( ) const [inline]

Gets file data size.


Returns
Size of file data, in characters.
The documentation for this class was generated from the following file:
src/node/include/node/rapidxml_utils.hpp

5.30

FileHelpers Class Reference

Functions for an easier usage of files and paths.

#include <FileHelpers.h>

Static Public Member Functions


file access functions
static bool isReadable (std::string path)
Checks whether the given file is readable.

file path evaluating functions


static std::string getFilePath (const std::string &path)
Removes the file information from the given path.

static std::string getConfigurationRelative (const std::string &configPath, const std::string &path)


Returns the second path as a relative path to the first file.

static bool isSocket (const std::string &name)


Returns the information whether the given name represents a socket.

static bool isAbsolute (const std::string &path)


Returns the information whether the given path is absolute.

static std::string checkForRelativity (const std::string &filename, const std::string &basePath)


Returns the path from a configuration so that it is accessable from the current working directory.

static std::string prependToLastPathComponent (const std::string &prefix, const std::string &path)


prepend the given prefix to the last path component of the given file path

binary writing functions


static std::ostream & writeInt (std::ostream &strm, int value)
Writes an integer binary.

static std::ostream & writeUInt (std::ostream &strm, unsigned int value)


Writes an unsigned integer binary.

static std::ostream & writeFloat (std::ostream &strm, SUMOReal value)


Writes a float binary.

static std::ostream & writeByte (std::ostream &strm, unsigned char value)


Writes a byte binary.

static std::ostream & writeString (std::ostream &strm, const std::string &value)


Writes a string binary.

static std::ostream & writeTime (std::ostream &strm, SUMOTime value)


Writes a time description binary.

template<typename E >
static std::ostream & writeEdgeVector (std::ostream &os, const std::vector< E > &edges)
Writes an edge vector binary.

template<typename E >
static void readEdgeVector (std::istream &in, std::vector< const E > &edges, const std::string &rid)
Reads an edge vector binary.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

53

54

Class Documentation

5.30.1

Detailed Description

Functions for an easier usage of files and paths.

5.30.2
5.30.2.1

Member Function Documentation


std::string FileHelpers::checkForRelativity ( const std::string & filename, const std::string & basePath )

[static]
Returns the path from a configuration so that it is accessable from the current working directory.
If the path is absolute, it is returned. Otherwise, the files position is computed regarding the configuration path (see
getConfigurationRelative).
See Also
isAbsolute
getConfigurationRelative
Parameters
filename
basePath

in
in

The path to the file to be examined


The path the configuration file (including the configs file name)

Returns
The files position

5.30.2.2

std::string FileHelpers::getConfigurationRelative ( const std::string & configPath, const std::string & path )

[static]
Returns the second path as a relative path to the first file.
Given the position of the configuration file, and the information where a second file is relative to the configuration
files position, we want to known where this second file can be found. This method gets the path to the configuration
file (including the configuration file name) and the path to get the relative position of and returns this relative position.
Parameters
configPath
path

in
in

The path the configuration file (including the configs file name)
The path to the references file (relativ to configuration path)

Returns
The files position (relative to curent working directory)

5.30.2.3

std::string FileHelpers::getFilePath ( const std::string & path ) [static]

Removes the file information from the given path.


Parameters

in

path

The path to the file to return the folder it is located in

Returns
The directory of the named file

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.30 FileHelpers Class Reference

5.30.2.4

55

bool FileHelpers::isAbsolute ( const std::string & path ) [static]

Returns the information whether the given path is absolute.


A path is meant to be absolute, if
it is a socket
it starts with a "/" (Linux)
it has a : at the second position (Windows)
Parameters
path

in

The path to examine

Returns
Whether the path is absolute

5.30.2.5

bool FileHelpers::isReadable ( std::string path ) [static]

Checks whether the given file is readable.


Parameters
path

in

The path to the file that shall be examined

Returns
Whether the named file is readable

5.30.2.6

bool FileHelpers::isSocket ( const std::string & name ) [static]

Returns the information whether the given name represents a socket.


A file name is meant to describe a socket address if a colon is found at a position larger than one.
Parameters
name

in

The name of a file

Returns
Whether the name names a socket

5.30.2.7

template<typename E > void FileHelpers::readEdgeVector ( std::istream & in, std::vector< const E > & edges,
const std::string & rid ) [static]

Reads an edge vector binary.


Parameters

in

is

The stream to read from

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

56

Class Documentation

edges

out

The edge vector to write into

Returns
Reference to the stream

5.30.2.8

std::ostream & FileHelpers::writeByte ( std::ostream & strm, unsigned char value ) [static]

Writes a byte binary.


Parameters

in,out
in

strm
value

The stream to write into


The byte to write

Returns
Reference to the stream

5.30.2.9

template<typename E > std::ostream & FileHelpers::writeEdgeVector ( std::ostream & os, const std::vector< E > &
edges ) [static]

Writes an edge vector binary.


Parameters

in,out
in

os
edges

The stream to write into


The edges to write

Returns
Reference to the stream

5.30.2.10

std::ostream & FileHelpers::writeFloat ( std::ostream & strm, SUMOReal value ) [static]

Writes a float binary.


This method behaves differently depending on the definition of SUMOReal at compile time.
Parameters

in,out
in

strm
value

The stream to write into


The float to write

Returns
Reference to the stream

5.30.2.11

std::ostream & FileHelpers::writeInt ( std::ostream & strm, int value ) [static]

Writes an integer binary.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.30 FileHelpers Class Reference

57

Parameters

in,out
in

strm
value

The stream to write into


The integer to write

Returns
Reference to the stream

5.30.2.12

std::ostream & FileHelpers::writeString ( std::ostream & strm, const std::string & value ) [static]

Writes a string binary.


Writes the length of the string, first, using writeInt. Writes then the strings characters.
See Also
writeInt
Parameters

in,out
in

strm
value

The stream to write into


The string to write

Returns
Reference to the stream

5.30.2.13

std::ostream & FileHelpers::writeTime ( std::ostream & strm, SUMOTime value ) [static]

Writes a time description binary.


This method behaves differently depending on the definition of SUMOTime at compile time, which in turn depends
on the enabling of subsecond timesteps.
Parameters

in,out
in

strm
value

The stream to write into


The time to write

Returns
Reference to the stream

5.30.2.14

std::ostream & FileHelpers::writeUInt ( std::ostream & strm, unsigned int value ) [static]

Writes an unsigned integer binary.


Parameters

in,out
in

strm
value

The stream to write into


The unsigned integer to write

Returns
Reference to the stream
The documentation for this class was generated from the following files:
src/sumo/include/utils/common/FileHelpers.h
src/sumo/src/utils/common/FileHelpers.cpp
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

58

Class Documentation

5.31

FormatException Class Reference

FormatException Thrown when a string that shall be converted into something else contained the wrong characters.

#include <UtilExceptions.h>
Inheritance diagram for FormatException:

runtime_error
FormatException
BoolFormatException

NumberFormatException

Public Member Functions


FormatException (const std::string &msg)
constructor

5.31.1

Detailed Description

FormatException Thrown when a string that shall be converted into something else contained the wrong characters.
The documentation for this class was generated from the following file:
src/sumo/include/utils/common/UtilExceptions.h

5.32

GenericSAXHandler Class Reference

A handler which converts occuring elements and attributes into enums.

#include <GenericSAXHandler.h>
Inheritance diagram for GenericSAXHandler:

DefaultHandler
GenericSAXHandler
SUMOSAXHandler
SAXWeightsHandler

SUMORouteHandler

Public Member Functions


GenericSAXHandler (StringBijection< int >::Entry tags, int terminatorTag, StringBijection< int >::Entry
attrs, int terminatorAttr, const std::string &file)
Constructor.

virtual GenericSAXHandler ()
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.32 GenericSAXHandler Class Reference

59

Destructor.

void startElement (const XMLCh const uri, const XMLCh const localname, const XMLCh const qname,
const XERCES_CPP_NAMESPACE::Attributes &attrs)
The inherited method called when a new tag opens.

void characters (const XMLCh const chars, const XERCES3_SIZE_t length)


The inherited method called when characters occured.

void endElement (const XMLCh const uri, const XMLCh const localname, const XMLCh const qname)
The inherited method called when a tag is being closed.

void registerParent (const int tag, GenericSAXHandler handler)


Assigning a parent handler which is enabled when the specified tag is closed.

void setFileName (const std::string &name)


Sets the current file name.

const std::string & getFileName () const


returns the current file name

SAX ErrorHandler callbacks


void warning (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
Handler for XML-warnings.

void error (const XERCES_CPP_NAMESPACE::SAXParseException &exception)


Handler for XML-errors.

void fatalError (const XERCES_CPP_NAMESPACE::SAXParseException &exception)


Handler for XML-errors.

Protected Member Functions


std::string buildErrorMessage (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
Builds an error message.

virtual void myStartElement (int element, const SUMOSAXAttributes &attrs)


Callback method for an opening tag to implement by derived classes.

virtual void myCharacters (int element, const std::string &chars)


Callback method for characters to implement by derived classes.

virtual void myEndElement (int element)


Callback method for a closing tag to implement by derived classes.

Friends
class SUMOSAXReader

5.32.1

Detailed Description

A handler which converts occuring elements and attributes into enums.


Normally, when using a standard SAX-handler, we would have to compare the incoming XMLCh-element names
with the ones we can parse. The same applies to parsing the attributes. This was assumed to be very time
consuming, thats why we derive our handlers from this class.
The idea behind this second handler layer was avoid repeated conversion from strings/whatever to XMLCh and
back again. The usage is quite straight forward, the only overhead is the need to define the enums - both elements
and attributes within "SUMOXMLDefinitions". Still, it maybe helps to avoid typos.
This class implements the SAX-callback and offers a new set of callbacks which must be implemented by derived
classes. Instead of XMLCh-values, element names are supplied to the derived classes as enums (int).
Also, this class allows to retrieve attributes using enums (int) within the implemented "myStartElement" method.
Basically, GenericSAXHandler is not derived within SUMO directly, but via SUMOSAXHandler which knows all
tags/attributes used by SUMO. It is still kept separate for an easier maintainability and later extensions.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

60

Class Documentation

5.32.2

Constructor & Destructor Documentation

5.32.2.1

GenericSAXHandler::GenericSAXHandler ( StringBijection< int >::Entry tags, int terminatorTag,


StringBijection< int >::Entry attrs, int terminatorAttr, const std::string & file )

Constructor.
This constructor gets the lists of known tag and attribute names with their enums (sumotags and sumoattrs in most
cases). The end of the list is signaled by terminatorTag/terminatorAttr respectively.
The attribute names are converted into XMLCh and stored within an internal container. This container is cleared
within the destructor.
Parameters
tags
terminatorTag
attrs
terminatorAttr
file

in
in
in
in
in

The list of known tags


The tag which signales the end of tags (usually the last entry)
The list of known attributes
The attr which signales the end of attrs (usually the last entry)
The name of the processed file

Todo Why are both lists non-const and given as pointers?

5.32.3

Member Function Documentation

5.32.3.1

std::string GenericSAXHandler::buildErrorMessage ( const XERCES_CPP_NAMESPACE::SAXParseException &


exception ) [protected]

Builds an error message.


The error message includes the file name and the line/column information as supported by the given SAXParseException
Parameters
exception

in

The name of the currently processed file

Returns
A string describing the given exception

5.32.3.2

void GenericSAXHandler::characters ( const XMLCh const chars, const XERCES3_SIZE_t length )

The inherited method called when characters occured.


The retrieved characters are converted into a string and appended into a private buffer. They are reported as soon
as the element ends.
Todo recheck/describe what happens with characters when a new element is opened
describe characters processing in the class head

5.32.3.3

void GenericSAXHandler::endElement ( const XMLCh const uri, const XMLCh const localname, const XMLCh

const qname )
The inherited method called when a tag is being closed.
This method calls the user-implemented methods myCharacters with the previously collected and converted characters.
Then, myEndElement is called, supplying it the qname converted to its enum- and string-representations.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.32 GenericSAXHandler Class Reference

61

Todo recheck/describe encoding of the string-representation


do not generate and report the string-representation

5.32.3.4

void GenericSAXHandler::error ( const XERCES_CPP_NAMESPACE::SAXParseException & exception )

Handler for XML-errors.


The message is built using buildErrorMessage and thrown within a ProcessError.
Parameters
exception

in

The occured exception to process

Exceptions
ProcessError

5.32.3.5

On any call

void GenericSAXHandler::fatalError ( const XERCES_CPP_NAMESPACE::SAXParseException & exception )

Handler for XML-errors.


The message is built using buildErrorMessage and thrown within a ProcessError.
Exceptions
ProcessError

On any call

Parameters
exception

in

5.32.3.6

The occured exception to process

const std::string& GenericSAXHandler::getFileName ( ) const

returns the current file name


Returns
The name of the currently processed file

5.32.3.7

virtual void GenericSAXHandler::myCharacters ( int element, const std::string & chars ) [protected],

[virtual]
Callback method for characters to implement by derived classes.
Called by "endElement" (see there).
Parameters

in
in

5.32.3.8

element
chars

The opened element, given as a int


The complete embedded character string ProcessError These method may
throw a ProcessError if something fails

virtual void GenericSAXHandler::myEndElement ( int element ) [protected], [virtual]

Callback method for a closing tag to implement by derived classes.


Called by "endElement" (see there).
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

62

Class Documentation

Parameters
element

in

The closed element, given as a int ProcessError These method may throw a
ProcessError if something fails

Reimplemented in SAXWeightsHandler, and SUMORouteHandler.

5.32.3.9

virtual void GenericSAXHandler::myStartElement ( int element, const SUMOSAXAttributes & attrs )

[protected], [virtual]
Callback method for an opening tag to implement by derived classes.
Called by "startElement" (see there).
Parameters
element
attrs

in
in

The element that contains the characters, given as a int


The SAX-attributes, wrapped as SUMOSAXAttributes ProcessError These
method may throw a ProcessError if something fails

Reimplemented in SAXWeightsHandler, and SUMORouteHandler.

5.32.3.10

void GenericSAXHandler::setFileName ( const std::string & name )

Sets the current file name.


Parameters
name

in

The name of the currently processed file

Todo Hmmm - this is as unsafe as having a direct access to the variable; recheck

5.32.3.11

void GenericSAXHandler::startElement ( const XMLCh const uri, const XMLCh const localname, const XMLCh
const qname, const XERCES_CPP_NAMESPACE::Attributes & attrs )

The inherited method called when a new tag opens.


The method parses the supplied XMLCh-qname using the internal name/enum-map to obtain the enum representation of the attribute name.
Then, "myStartElement" is called supplying the enumeration value, the string-representation of the name and the
attributes.
Todo recheck/describe encoding of the string-representation
do not generate and report the string-representation

5.32.3.12

void GenericSAXHandler::warning ( const XERCES_CPP_NAMESPACE::SAXParseException & exception )

Handler for XML-warnings.


The message is built using buildErrorMessage and reported to the warning-instance of the MsgHandler.
Parameters

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.33 TraCIAPI::GUIScope Class Reference

exception

in

63

The occured exception to process

The documentation for this class was generated from the following file:
src/sumo/include/utils/xml/GenericSAXHandler.h

5.33

TraCIAPI::GUIScope Class Reference

Scope for interaction with the gui.

#include <TraCIAPI.h>
Inheritance diagram for TraCIAPI::GUIScope:

TraCIAPI::TraCIScopeWrapper
TraCIAPI::GUIScope

Public Member Functions


GUIScope (TraCIAPI &parent)
std::vector< std::string > getIDList () const
SUMOReal getZoom (const std::string &viewID=DEFAULT_VIEW) const
TraCIPosition getOffset (const std::string &viewID=DEFAULT_VIEW) const
std::string getSchema (const std::string &viewID=DEFAULT_VIEW) const
TraCIBoundary getBoundary (const std::string &viewID=DEFAULT_VIEW) const
void setZoom (const std::string &viewID, SUMOReal zoom) const
void setOffset (const std::string &viewID, SUMOReal x, SUMOReal y) const
void setSchema (const std::string &viewID, const std::string &schemeName) const
void setBoundary (const std::string &viewID, SUMOReal xmin, SUMOReal ymin, SUMOReal xmax, SUMOReal ymax) const
void screenshot (const std::string &viewID, const std::string &filename) const
void trackVehicle (const std::string &viewID, const std::string &vehID) const

Protected Attributes
TraCIAPI & myParent
The parent TraCI client which offers the connection.

5.33.1

Detailed Description

Scope for interaction with the gui.


The documentation for this class was generated from the following files:
src/sumo/include/utils/traci/TraCIAPI.h
src/sumo/src/utils/traci/TraCIAPI.cpp
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

64

Class Documentation

5.34

IDSupplier Class Reference

This class builds string ids by adding an increasing numerical value to a previously given string.

#include <IDSupplier.h>

Public Member Functions


IDSupplier (const std::string &prefix="", long begin=0)
Constructor.

IDSupplier (const std::string &prefix, const std::vector< std::string > &knownIDs)


Constructor.

IDSupplier ()
Destructor.

std::string getNext ()
Returns the next id.

void avoid (const std::string &id)


make sure that the given id is never supplied

5.34.1

Detailed Description

This class builds string ids by adding an increasing numerical value to a previously given string.

5.34.2

Constructor & Destructor Documentation

5.34.2.1

IDSupplier::IDSupplier ( const std::string & prefix, const std::vector< std::string > & knownIDs )

Constructor.
Parameters

in
in

prefix
knownIDs

The string to use as ID prefix


List of IDs that should never be returned by this IDSupplier

The documentation for this class was generated from the following files:
src/sumo/include/utils/common/IDSupplier.h
src/sumo/src/utils/common/IDSupplier.cpp

5.35

TraCIAPI::InductionLoopScope Class Reference

Scope for interaction with inductive loops.

#include <TraCIAPI.h>
Inheritance diagram for TraCIAPI::InductionLoopScope:

TraCIAPI::TraCIScopeWrapper
TraCIAPI::InductionLoopScope

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.36 invalid_return< X > Struct Template Reference

Public Member Functions

InductionLoopScope (TraCIAPI &parent)


std::vector< std::string > getIDList () const
SUMOReal getPosition (const std::string &loopID) const
std::string getLaneID (const std::string &loopID) const
unsigned int getLastStepVehicleNumber (const std::string &loopID) const
SUMOReal getLastStepMeanSpeed (const std::string &loopID) const
std::vector< std::string > getLastStepVehicleIDs (const std::string &loopID) const
SUMOReal getLastStepOccupancy (const std::string &loopID) const
SUMOReal getLastStepMeanLength (const std::string &loopID) const
SUMOReal getTimeSinceDetection (const std::string &loopID) const
unsigned int getVehicleData (const std::string &loopID) const

Protected Attributes
TraCIAPI & myParent
The parent TraCI client which offers the connection.

5.35.1

Detailed Description

Scope for interaction with inductive loops.


The documentation for this class was generated from the following files:
src/sumo/include/utils/traci/TraCIAPI.h
src/sumo/src/utils/traci/TraCIAPI.cpp

5.36

invalid_return< X > Struct Template Reference

Static Public Attributes


static const X value
static const std::string type
The documentation for this struct was generated from the following file:
src/sumo/include/utils/xml/SUMOSAXAttributes.h

5.37

InvalidArgument Class Reference

InvalidArgument Thrown when an argument was not proper in the current context A message will be supplied.

#include <UtilExceptions.h>
Inheritance diagram for InvalidArgument:

runtime_error
ProcessError
InvalidArgument

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

65

66

Class Documentation

Public Member Functions


InvalidArgument (const std::string &message)
constructor

5.37.1

Detailed Description

InvalidArgument Thrown when an argument was not proper in the current context A message will be supplied.
The documentation for this class was generated from the following file:
src/sumo/include/utils/common/UtilExceptions.h

5.38

IOError Class Reference

Inheritance diagram for IOError:

runtime_error

ProcessError

IOError

Public Member Functions


IOError (const std::string &message)
constructor

The documentation for this class was generated from the following file:
src/sumo/include/utils/common/UtilExceptions.h

5.39

IPV4_Connection Class Reference

Inheritance diagram for IPV4_Connection:

Connection

IPV4_Connection

Public Member Functions

IPV4_Connection (const IPV4_Connection &s)


IPV4_Connection & operator= (const IPV4_Connection &s)
virtual IPV4_Connection clone () const
virtual void swap (IPV4_Connection &s)
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.40 IPV6_Connection Class Reference

67

virtual void Close ()


virtual long Send (const char buffer, long len)
virtual long Receive (char buffer, long len)
virtual int InitializeServer ()
virtual int InitializeClient ()
void get_in_addr (struct sockaddr sa)
u_short get_in_port (struct sockaddr sa)
virtual void swap (Connection &s)
int Initialize (bool server)

Public Attributes

int sockfd
struct sockaddr_in local_addr
struct sockaddr_in remote_addr
bool isServer
std::string serverIP
int bufferSize
int serverPort
int receiveTimeout

The documentation for this class was generated from the following file:
src/pnp2/include/pnp2/ConnectionSubsys.hpp

5.40

IPV6_Connection Class Reference

Inheritance diagram for IPV6_Connection:

Connection

IPV6_Connection

Public Member Functions

IPV6_Connection (const IPV6_Connection &s)


IPV6_Connection & operator= (const IPV6_Connection &s)
virtual IPV6_Connection clone () const
virtual void swap (IPV6_Connection &s)
virtual void Close ()
virtual long Send (const char buffer, long len)
virtual long Receive (char buffer, long len)
virtual int InitializeServer ()
virtual int InitializeClient ()
void get_in_addr (struct sockaddr sa)
u_short get_in_port (struct sockaddr sa)
virtual void swap (Connection &s)
int Initialize (bool server)

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

68

Class Documentation

Public Attributes
int sockfd
struct sockaddr_in6 local_addr
struct sockaddr_in6 remote_addr
bool isServer
std::string serverIP
int bufferSize
int serverPort
int receiveTimeout

The documentation for this class was generated from the following file:
src/pnp2/include/pnp2/ConnectionSubsys.hpp

5.41

TraCIAPI::JunctionScope Class Reference

Scope for interaction with junctions.

#include <TraCIAPI.h>
Inheritance diagram for TraCIAPI::JunctionScope:

TraCIAPI::TraCIScopeWrapper
TraCIAPI::JunctionScope

Public Member Functions


JunctionScope (TraCIAPI &parent)
std::vector< std::string > getIDList () const
TraCIPosition getPosition (const std::string &junctionID) const

Protected Attributes
TraCIAPI & myParent
The parent TraCI client which offers the connection.

5.41.1

Detailed Description

Scope for interaction with junctions.


The documentation for this class was generated from the following files:
src/sumo/include/utils/traci/TraCIAPI.h
src/sumo/src/utils/traci/TraCIAPI.cpp
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.42 TraCIAPI::LaneScope Class Reference

5.42

69

TraCIAPI::LaneScope Class Reference

Scope for interaction with lanes.

#include <TraCIAPI.h>
Inheritance diagram for TraCIAPI::LaneScope:

TraCIAPI::TraCIScopeWrapper
TraCIAPI::LaneScope

Public Member Functions


LaneScope (TraCIAPI &parent)
std::vector< std::string > getIDList () const
SUMOReal getLength (const std::string &laneID) const
SUMOReal getMaxSpeed (const std::string &laneID) const
SUMOReal getWidth (const std::string &laneID) const
std::vector< std::string > getAllowed (const std::string &laneID) const
std::vector< std::string > getDisallowed (const std::string &laneID) const
unsigned int getLinkNumber (const std::string &laneID) const
TraCIPositionVector getShape (const std::string &laneID) const
std::string getEdgeID (const std::string &laneID) const
SUMOReal getCO2Emission (const std::string &laneID) const
SUMOReal getCOEmission (const std::string &laneID) const
SUMOReal getHCEmission (const std::string &laneID) const
SUMOReal getPMxEmission (const std::string &laneID) const
SUMOReal getNOxEmission (const std::string &laneID) const
SUMOReal getFuelConsumption (const std::string &laneID) const
SUMOReal getNoiseEmission (const std::string &laneID) const
SUMOReal getLastStepMeanSpeed (const std::string &laneID) const
SUMOReal getLastStepOccupancy (const std::string &laneID) const
SUMOReal getLastStepLength (const std::string &laneID) const
SUMOReal getTraveltime (const std::string &laneID) const
unsigned int getLastStepVehicleNumber (const std::string &laneID) const
unsigned int getLastStepHaltingNumber (const std::string &laneID) const
std::vector< std::string > getLastStepVehicleIDs (const std::string &laneID) const
void setAllowed (const std::string &laneID, const std::vector< std::string > &allowedClasses) const
void setDisallowed (const std::string &laneID, const std::vector< std::string > &disallowedClasses) const
void setMaxSpeed (const std::string &laneID, SUMOReal speed) const
void setLength (const std::string &laneID, SUMOReal length) const

Protected Attributes
TraCIAPI & myParent
The parent TraCI client which offers the connection.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

70

Class Documentation

5.42.1

Detailed Description

Scope for interaction with lanes.


The documentation for this class was generated from the following files:
src/sumo/include/utils/traci/TraCIAPI.h
src/sumo/src/utils/traci/TraCIAPI.cpp

5.43

Logger Class Reference

Logger.hpp.

#include <Logger.hpp>

Public Member Functions


Logger ()
Logger Constructor.

void set_is_periodic (bool is_periodic)


Makes Logging Periodic.

void set_max_log_unit (int max_log_unit)


Set maximum log unit in bytes during periodic logging.

void set_logs_to_file (bool logs_to_file)


Log to file instead of stdout.

Logger ()
Writes out the remainder of the logs and closes logfile.

bool create_file (std::string log_path)


Create log file.

bool write ()
Write logged bytes to file.

bool flush ()
Flush out to file.

bool log (std::string log_level, const char format,...)


Log to file with specific log_level.

int size ()
Return the current size of the log in bytes.

std::string clock ()
Return the current clock value.

5.43.1

Detailed Description

Logger.hpp.
Author
Pranav Srinivas Kumar

Date

<%- Date().toISOString().replace(/T/, ).replace(/..+/, ) %> This file declares the Component Logger class
Logger class
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.43 Logger Class Reference

5.43.2

Member Function Documentation

5.43.2.1

bool Logger::create_file ( std::string log_path ) [inline]

Create log file.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

71

72

Class Documentation

Parameters
log_path

in

path to log file.

bool Logger::log ( std::string log_level, const char format, ... ) [inline]

5.43.2.2

Log to file with specific log_level.


Parameters
log_level
format

in
in

5.43.2.3

string indicating logging level.


varargs input to logger.

void Logger::set_is_periodic ( bool is_periodic ) [inline]

Makes Logging Periodic.


Parameters
is_periodic

in

5.43.2.4

boolean indicating whether logging is periodic.

void Logger::set_logs_to_file ( bool logs_to_file ) [inline]

Log to file instead of stdout.


Parameters
logs_to_file

in

5.43.2.5

boolean requiring logging on file.

void Logger::set_max_log_unit ( int max_log_unit ) [inline]

Set maximum log unit in bytes during periodic logging.


Parameters

in

max_log_unit

maximum periodic logging unit in bytes.

The documentation for this class was generated from the following file:
src/node/include/node/Logger.hpp

5.44

TraCIAPI::MeMeScope Class Reference

Scope for interaction with multi entry/-exit detectors.

#include <TraCIAPI.h>
Inheritance diagram for TraCIAPI::MeMeScope:

TraCIAPI::TraCIScopeWrapper
TraCIAPI::MeMeScope

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.45 rapidxml::memory_pool< Ch > Class Template Reference

73

Public Member Functions

MeMeScope (TraCIAPI &parent)


std::vector< std::string > getIDList () const
unsigned int getLastStepVehicleNumber (const std::string &detID) const
SUMOReal getLastStepMeanSpeed (const std::string &detID) const
std::vector< std::string > getLastStepVehicleIDs (const std::string &detID) const
unsigned int getLastStepHaltingNumber (const std::string &detID) const

Protected Attributes
TraCIAPI & myParent
The parent TraCI client which offers the connection.

5.44.1

Detailed Description

Scope for interaction with multi entry/-exit detectors.


The documentation for this class was generated from the following files:
src/sumo/include/utils/traci/TraCIAPI.h
src/sumo/src/utils/traci/TraCIAPI.cpp

5.45

rapidxml::memory_pool< Ch > Class Template Reference

This class is used by the parser to create new nodes and attributes, without overheads of dynamic memory allocation.

#include <rapidxml.hpp>
Inheritance diagram for rapidxml::memory_pool< Ch >:

rapidxml::memory_pool< Ch >
rapidxml::xml_document< Ch >

Public Member Functions


memory_pool ()
Constructs empty pool with default allocator functions.

memory_pool ()
Destroys pool and frees all the memory.

xml_node< Ch > allocate_node (node_type type, const Ch name=0, const Ch value=0, std::size_t
name_size=0, std::size_t value_size=0)
Allocates a new node from the pool, and optionally assigns name and value to it.

xml_attribute< Ch > allocate_attribute (const Ch name=0, const Ch value=0, std::size_t name_size=0,


std::size_t value_size=0)
Allocates a new attribute from the pool, and optionally assigns name and value to it.

Ch allocate_string (const Ch source=0, std::size_t size=0)


Allocates a char array of given size from the pool, and optionally copies a given string to it.

xml_node< Ch > clone_node (const xml_node< Ch > source, xml_node< Ch > result=0)
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

74

Class Documentation

Clones an xml_node and its hierarchy of child nodes and attributes.

void clear ()
Clears the pool.

void set_allocator (alloc_func af, free_func ff)


Sets or resets the user-defined memory allocation functions for the pool.

5.45.1

Detailed Description

template<class Ch = char>class rapidxml::memory_pool< Ch >


This class is used by the parser to create new nodes and attributes, without overheads of dynamic memory allocation.
In most cases, you will not need to use this class directly. However, if you need to create nodes manually or modify
names/values of nodes, you are encouraged to use memory_pool of relevant xml_document to allocate the memory.
Not only is this faster than allocating them by using new operator, but also their lifetime will be tied to the lifetime of
document, possibly simplyfing memory management.
Call allocate_node() or allocate_attribute() functions to obtain new nodes or attributes from the pool. You can also
call allocate_string() function to allocate strings. Such strings can then be used as names or values of nodes without
worrying about their lifetime. Note that there is no free() function all allocations are freed at once when clear()
function is called, or when the pool is destroyed.
It is also possible to create a standalone memory_pool, and use it to allocate nodes, whose lifetime will not be tied
to any document.
Pool maintains RAPIDXML_STATIC_POOL_SIZE bytes of statically allocated memory. Until static memory is
exhausted, no dynamic memory allocations are done. When static memory is exhausted, pool allocates additional
blocks of memory of size RAPIDXML_DYNAMIC_POOL_SIZE each, by using global new[] and delete[]
operators. This behaviour can be changed by setting custom allocation routines. Use set_allocator() function to set
them.
Allocations for nodes, attributes and strings are aligned at RAPIDXML_ALIGNMENT bytes. This value defaults to
the size of pointer on target architecture.
To obtain absolutely top performance from the parser, it is important that all nodes are allocated from a single,
contiguous block of memory. Otherwise, cache misses when jumping between two (or more) disjoint blocks of
memory can slow down parsing quite considerably. If required, you can tweak RAPIDXML_STATIC_POOL_SIZE, RAPIDXML_DYNAMIC_POOL_SIZE and RAPIDXML_ALIGNMENT to obtain best wasted memory to
performance compromise. To do it, define their values before rapidxml.hpp file is included.
Parameters
Ch

Character type of created nodes.

5.45.2

Constructor & Destructor Documentation

5.45.2.1

template<class Ch = char> rapidxml::memory_pool< Ch >::memory_pool ( ) [inline]

Destroys pool and frees all the memory.


This causes memory occupied by nodes allocated by the pool to be freed. Nodes allocated from the pool are no
longer valid.

5.45.3

Member Function Documentation

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.45 rapidxml::memory_pool< Ch > Class Template Reference

5.45.3.1

75

template<class Ch = char> xml_attribute<Ch> rapidxml::memory_pool< Ch >::allocate_attribute ( const


Ch name = 0, const Ch value = 0, std::size_t name_size = 0, std::size_t value_size = 0 ) [inline]

Allocates a new attribute from the pool, and optionally assigns name and value to it.
If the allocation request cannot be accomodated, this function will throw std::bad_alloc. If exceptions are
disabled by defining RAPIDXML_NO_EXCEPTIONS, this function will call rapidxml::parse_error_handler() function.
Parameters
name
value
name_size
value_size

Name to assign to the attribute, or 0 to assign no name.


Value to assign to the attribute, or 0 to assign no value.
Size of name to assign, or 0 to automatically calculate size from name string.
Size of value to assign, or 0 to automatically calculate size from value string.

Returns
Pointer to allocated attribute. This pointer will never be NULL.

5.45.3.2

template<class Ch = char> xml_node<Ch> rapidxml::memory_pool< Ch >::allocate_node ( node_type


type, const Ch name = 0, const Ch value = 0, std::size_t name_size = 0, std::size_t value_size = 0 )

[inline]
Allocates a new node from the pool, and optionally assigns name and value to it.
If the allocation request cannot be accomodated, this function will throw std::bad_alloc. If exceptions are
disabled by defining RAPIDXML_NO_EXCEPTIONS, this function will call rapidxml::parse_error_handler() function.
Parameters
type
name
value
name_size
value_size

Type of node to create.


Name to assign to the node, or 0 to assign no name.
Value to assign to the node, or 0 to assign no value.
Size of name to assign, or 0 to automatically calculate size from name string.
Size of value to assign, or 0 to automatically calculate size from value string.

Returns
Pointer to allocated node. This pointer will never be NULL.

5.45.3.3

template<class Ch = char> Ch rapidxml::memory_pool< Ch >::allocate_string ( const Ch source = 0,


std::size_t size = 0 ) [inline]

Allocates a char array of given size from the pool, and optionally copies a given string to it.
If the allocation request cannot be accomodated, this function will throw std::bad_alloc. If exceptions are
disabled by defining RAPIDXML_NO_EXCEPTIONS, this function will call rapidxml::parse_error_handler() function.
Parameters
source
size

String to initialize the allocated memory with, or 0 to not initialize it.


Number of characters to allocate, or zero to calculate it automatically from source string
length; if size is 0, source string must be specified and null terminated.

Returns
Pointer to allocated char array. This pointer will never be NULL.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

76

Class Documentation

5.45.3.4

template<class Ch = char> void rapidxml::memory_pool< Ch >::clear ( ) [inline]

Clears the pool.


This causes memory occupied by nodes allocated by the pool to be freed. Any nodes or strings allocated from the
pool will no longer be valid.

5.45.3.5

template<class Ch = char> xml_node<Ch> rapidxml::memory_pool< Ch >::clone_node ( const


xml_node< Ch > source, xml_node< Ch > result = 0 ) [inline]

Clones an xml_node and its hierarchy of child nodes and attributes.


Nodes and attributes are allocated from this memory pool. Names and values are not cloned, they are shared
between the clone and the source. Result node can be optionally specified as a second parameter, in which case
its contents will be replaced with cloned source node. This is useful when you want to clone entire document.
Parameters
source
result

Node to clone.
Node to put results in, or 0 to automatically allocate result node

Returns
Pointer to cloned node. This pointer will never be NULL.

5.45.3.6

template<class Ch = char> void rapidxml::memory_pool< Ch >::set_allocator ( alloc_func af, free_func ff


) [inline]

Sets or resets the user-defined memory allocation functions for the pool.
This can only be called when no memory is allocated from the pool yet, otherwise results are undefined. Allocation
function must not return invalid pointer on failure. It should either throw, stop the program, or use longjmp()
function to pass control to other place of program. If it returns invalid pointer, results are undefined.
User defined allocation functions must have the following forms:

void allocate(std::size_t size);


void free(void pointer);
Parameters
af
ff

Allocation function, or 0 to restore default function


Free function, or 0 to restore default function

The documentation for this class was generated from the following file:
src/node/include/node/rapidxml.hpp

5.46

Network::Message Class Reference

Public Member Functions

Message (uint64_t len, uint64_t i, uint64_t conn_id=0)


Message (const Message &s)
Message & operator= (const Message &s)
void swap (Message &s)
void TimeStamp ()
std::string Buffer () const
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.47 Network::message_buffer< T > Class Template Reference

int NumTimes () const


std::vector< double > DoubleTimes () const
double FirstDoubleTime () const
double LastDoubleTime () const
std::vector< timespec > EpochTimes () const
timespec FirstEpochTime () const
timespec LastEpochTime () const
void Clear ()
uint64_t Id () const
void Id (uint64_t i)
uint64_t Bits () const
void Bits (uint64_t b)
uint64_t Bytes () const
void Bytes (uint64_t B)
std::string ToString () const

Public Attributes

std::string buffer
uint64_t bits
uint64_t id
uint64_t connection_id
std::vector< timespec > times

The documentation for this class was generated from the following file:
src/pnp2/include/pnp2/Message.hpp

5.47

Network::message_buffer< T > Class Template Reference

Inheritance diagram for Network::message_buffer< T >:

noncopyable
Network::message_buffer< T >

Public Types
typedef boost::mutex::scoped_lock lock

Public Member Functions

message_buffer (int bits)


void send (T data, uint64_t bits)
T receive (uint64_t timeout_ms=0)
T non_blocking_receive ()
void clear ()
uint64_t bits ()
uint64_t bytes ()

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

77

78

Class Documentation

uint64_t maxBits ()
uint64_t maxBytes ()
uint64_t capacityBits ()
uint64_t capacityBytes ()
void set_capacityBits (uint64_t capacityBits)
void set_capacityBytes (uint64_t capacityBytes)

The documentation for this class was generated from the following file:
src/pnp2/include/pnp2/buffer.hpp

5.48

MsgHandler Class Reference

MsgHandler.

#include <MsgHandler.h>

Public Types
enum MsgType { MT_MESSAGE, MT_WARNING, MT_ERROR }
An enumeration to differ between different types of messages (errors, warning and information)

Public Member Functions


void inform (std::string msg, bool addType=true)
adds a new error to the list

void beginProcessMsg (std::string msg, bool addType=true)


Begins a process information.

void endProcessMsg (std::string msg)


Ends a process information.

void clear ()
Clears information whether an error occured previously.

void addRetriever (OutputDevice retriever)


Adds a further retriever to the instance responsible for a certain msg type.

void removeRetriever (OutputDevice retriever)


Removes the retriever from the handler.

bool isRetriever (OutputDevice retriever) const


Returns whether the given output device retrieves messages from the handler.

bool wasInformed () const


Returns the information whether any messages were added.

template<class T >
MsgHandler & operator<< (const T &t)
Generic output operator.

Static Public Member Functions


static MsgHandler getMessageInstance ()
Returns the instance to add normal messages to.

static MsgHandler getWarningInstance ()


Returns the instance to add warnings to.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.48 MsgHandler Class Reference

79

static MsgHandler getErrorInstance ()


Returns the instance to add errors to.

static void initOutputOptions ()


static void cleanupOnEnd ()
Removes pending handler.

static void assignLock (AbstractMutex lock)


Sets the lock to use The lock will not be deleted.

Protected Member Functions


std::string build (const std::string &msg, bool addType)
Builds the string which includes the mml-message type.

5.48.1

Detailed Description

MsgHandler.

5.48.2

Member Enumeration Documentation

5.48.2.1

enum MsgHandler::MsgType

An enumeration to differ between different types of messages (errors, warning and information)
Enumerator
MT_MESSAGE The message is only something to show.
MT_WARNING The message is a warning.
MT_ERROR The message is an error.

5.48.3

Member Function Documentation

5.48.3.1

void MsgHandler::beginProcessMsg ( std::string msg, bool addType = true )

Begins a process information.


When a longer action is started, this method should be used to inform the user about it. There will be no newline
printed, but the message handler will be informed that a process message has been begun. If an error occurs, a
newline will be printed. After the action has been performed, use endProcessMsg to inform the user about it.

5.48.3.2

template<class T > MsgHandler& MsgHandler::operator<< ( const T & t ) [inline]

Generic output operator.


Returns
The MsgHandler for further processing
The documentation for this class was generated from the following files:
src/sumo/include/utils/common/MsgHandler.h
src/sumo/src/utils/common/MsgHandler.cpp
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

80

Class Documentation

5.49

MsgRetrievingFunction< T > Class Template Reference

Encapsulates an objects method for using it as a message retriever.

#include <MsgRetrievingFunction.h>
Inheritance diagram for MsgRetrievingFunction< T >:

OutputDevice
MsgRetrievingFunction< T >

Public Types
typedef void(T:: Operation )(const MsgHandler::MsgType, const std::string &)
Type of the function to execute.

Public Member Functions


MsgRetrievingFunction (T object, Operation operation, MsgHandler::MsgType type)
Constructor.

MsgRetrievingFunction ()
Destructor.

OutputDevice member methods


virtual bool ok ()
returns the information whether one can write into the device

void close ()
Closes the device and removes it from the dictionary.

void setPrecision (unsigned int precision=OUTPUT_ACCURACY)


Sets the precison or resets it to default.

bool writeXMLHeader (const std::string &rootElement, const std::string &attrs="", const std::string &comment="")
Writes an XML header with optional configuration.

template<typename E >
bool writeHeader (const SumoXMLTag &rootElement)
OutputDevice & openTag (const std::string &xmlElement)
Opens an XML tag.

OutputDevice & openTag (const SumoXMLTag &xmlElement)


Opens an XML tag.

bool closeTag ()
Closes the most recently opened tag.

void lf ()
writes a line feed if applicable

bool isBinary () const


Returns whether we have a binary output.

template<typename T >
OutputDevice & writeAttr (const SumoXMLAttr attr, const T &val)
writes a named attribute

template<typename T >
OutputDevice & writeAttr (const std::string &attr, const T &val)
writes an arbitrary attribute

OutputDevice & writeNonEmptyAttr (const SumoXMLAttr attr, const std::string &val)


Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.49 MsgRetrievingFunction< T > Class Template Reference

81

writes a string attribute only if it is not the empty string and not the string "default"

OutputDevice & writePreformattedTag (const std::string &val)


writes a preformatted tag to the device but ensures that any pending tags are closed

void inform (const std::string &msg, const char progress=0)


Retrieves a message to this device.

template<class T >
OutputDevice & operator<< (const T &t)
Abstract output operator.

Static Public Member Functions


static std::string realString (const SUMOReal v, const int precision=OUTPUT_ACCURACY)
Helper method for string formatting.

static access methods to OutputDevices


static OutputDevice & getDevice (const std::string &name)
Returns the described OutputDevice.

static bool createDeviceByOption (const std::string &optionName, const std::string &rootElement="", const
std::string &schemaFile="")
Creates the device using the output definition stored in the named option.

static OutputDevice & getDeviceByOption (const std::string &name)


Returns the device described by the option.

static void closeAll ()


Closes all registered devices.

Protected Member Functions


Methods that override/implement OutputDevice-methods
std::ostream & getOStream ()
Returns the associated ostream.

virtual void postWriteHook ()


Sends the data which was written to the string stream via the retrieving function.

5.49.1

Detailed Description

template<class T>class MsgRetrievingFunction< T >


Encapsulates an objects method for using it as a message retriever.
You may find an example for this class usage in GUIRunThread.

5.49.2

Constructor & Destructor Documentation

5.49.2.1

template<class T > MsgRetrievingFunction< T >::MsgRetrievingFunction ( T object, Operation


operation, MsgHandler::MsgType type ) [inline]

Constructor.
Parameters

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

82

Class Documentation
object
operation
type

in
in
in

The object to call the method of


The method to call
The type of the message

5.49.3

Member Function Documentation

5.49.3.1

bool OutputDevice::closeTag ( ) [inherited]

Closes the most recently opened tag.


The topmost xml-element from the stack is written into the stream as a closing element. Depending on the formatter
used this may be something like "</" + element + ">" or "/>" or nothing at all.
Returns
Whether a further element existed in the stack and could be closed
Todo it is not verified that the topmost element was closed

5.49.3.2

static bool OutputDevice::createDeviceByOption ( const std::string & optionName, const std::string & rootElement =

"", const std::string & schemaFile = "" ) [static], [inherited]


Creates the device using the output definition stored in the named option.
Creates and returns the device named by the option. Asks whether the option and retrieves the name from the
option if so. Optionally the XML header gets written as well. Returns whether a device was created (option was
set).
Please note, that we do not have to consider the "application base" herein, because this call is only used to get file
names of files referenced within XML-declarations of structures which paths already is aware of the cwd.
Parameters
optionName
rootElement
schemaFile

in
in
in

The name of the option to use for retrieving the output definition
The root element to use (XML-output)
The basename of the schema file to use (XML-output)

Returns
Whether a device was built (the option was set)
Exceptions
IOError

5.49.3.3

If the output could not be built for any reason (error message is supplied)

static OutputDevice& OutputDevice::getDevice ( const std::string & name ) [static], [inherited]

Returns the described OutputDevice.


Creates and returns the named device. "stdout" and "stderr" refer to the relevant console streams, "hostname:port"
initiates socket connection. Otherwise a filename is assumed (where "nul" and "/dev/null" do what you would expect
on both platforms). If there already is a device with the same name this one is returned.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.49 MsgRetrievingFunction< T > Class Template Reference

83

Parameters
name

in

The description of the output name/port/whatever

Returns
The corresponding (built or existing) device
Exceptions
IOError

5.49.3.4

If the output could not be built for any reason (error message is supplied)

static OutputDevice& OutputDevice::getDeviceByOption ( const std::string & name ) [static],

[inherited]
Returns the device described by the option.
Returns the device named by the option. If the option is unknown, unset or the device was not created before,
InvalidArgument is thrown.
Please note, that we do not have to consider the "application base" herein.
Parameters
name

in

The name of the option to use for retrieving the output definition

Returns
The corresponding (built or existing) device
Exceptions
IOError
InvalidArgument

5.49.3.5

If the output could not be built for any reason (error message is supplied)
If the option with the given name does not exist

template<class T > std::ostream& MsgRetrievingFunction< T >::getOStream ( ) [inline],


[protected], [virtual]

Returns the associated ostream.


The stream is an ostringstream, actually, into which the message is written. It is sent when postWriteHook is called.
Returns
The used stream

See Also
postWriteHook
Implements OutputDevice.

5.49.3.6

void OutputDevice::inform ( const std::string & msg, const char progress = 0 ) [inherited]

Retrieves a message to this device.


Implementation of the MessageRetriever interface. Writes the given message to the output device.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

84

Class Documentation

Parameters
msg

in

5.49.3.7

The msg to write to the device

bool OutputDevice::isBinary ( ) const [inline], [inherited]

Returns whether we have a binary output.


Returns
whether we have a binary output

5.49.3.8

virtual bool OutputDevice::ok ( ) [virtual], [inherited]

returns the information whether one can write into the device
Returns
Whether the device can be used (stream is good)

5.49.3.9 OutputDevice& OutputDevice::openTag ( const std::string & xmlElement ) [inherited]


Opens an XML tag.
An indentation, depending on the current xml-element-stack size, is written followed by the given xml element ("<"
+ xmlElement) The xml element is added to the stack, then.
Parameters
xmlElement

in

Name of element to open

Returns
The OutputDevice for further processing

5.49.3.10 OutputDevice& OutputDevice::openTag ( const SumoXMLTag & xmlElement ) [inherited]


Opens an XML tag.
Helper method which finds the correct string before calling openTag.
Parameters

in

xmlElement

Id of the element to open

Returns
The OutputDevice for further processing

5.49.3.11

template<class T > OutputDevice& OutputDevice::operator<< ( const T & t ) [inline],


[inherited]

Abstract output operator.


Returns
The OutputDevice for further processing

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.49 MsgRetrievingFunction< T > Class Template Reference

5.49.3.12

static std::string OutputDevice::realString ( const SUMOReal v, const int precision = OUTPUT_ACCURACY )

[static], [inherited]
Helper method for string formatting.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

85

86

Class Documentation

Parameters
v
precision

in
in

The floating point value to be formatted


the precision to achieve

Returns
The formatted string

5.49.3.13

void OutputDevice::setPrecision ( unsigned int precision = OUTPUT_ACCURACY ) [inherited]

Sets the precison or resets it to default.


Parameters
precision

in

5.49.3.14

The accuracy (number of digits behind .) to set

template<typename T > OutputDevice& OutputDevice::writeAttr ( const SumoXMLAttr attr, const T & val )
[inline], [inherited]

writes a named attribute


Parameters
attr
val

in
in

The attribute (name)


The attribute value

Returns
The OutputDevice for further processing

5.49.3.15

template<typename T > OutputDevice& OutputDevice::writeAttr ( const std::string & attr, const T & val )
[inline], [inherited]

writes an arbitrary attribute


Parameters

in
in

attr
val

The attribute (name)


The attribute value

Returns
The OutputDevice for further processing

5.49.3.16 OutputDevice& OutputDevice::writeNonEmptyAttr ( const SumoXMLAttr attr, const std::string & val )
[inline], [inherited]
writes a string attribute only if it is not the empty string and not the string "default"
Parameters

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.50 MTRand Class Reference


attr
val

in
in

87
The attribute (name)
The attribute value

Returns
The OutputDevice for further processing

5.49.3.17 OutputDevice& OutputDevice::writePreformattedTag ( const std::string & val ) [inline], [inherited]


writes a preformatted tag to the device but ensures that any pending tags are closed
Parameters
val

in

The preformatted data

Returns
The OutputDevice for further processing

5.49.3.18

bool OutputDevice::writeXMLHeader ( const std::string & rootElement, const std::string & attrs = "", const
std::string & comment = "" ) [inherited]

Writes an XML header with optional configuration.


If something has been written (myXMLStack is not empty), nothing is written and false returned.
Parameters

in
in
in

rootElement
attrs
comment

The root element to use


Additional attributes to save within the rootElement
Additional comment (saved in front the rootElement)

Returns
Whether the header could be written (stack was empty)
Todo Check which parameter is used herein
Describe what is saved
The documentation for this class was generated from the following file:
src/sumo/include/utils/common/MsgRetrievingFunction.h

5.50

MTRand Class Reference

Public Types
enum { N = 624 }
enum { SAVE = N + 1 }
typedef unsigned long uint32
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

88

Class Documentation

Public Member Functions

MTRand (const uint32 &oneSeed)


MTRand (uint32 const bigSeed, uint32 const seedLength=N)
double rand ()
double rand (const double &n)
double randExc ()
double randExc (const double &n)
double randDblExc ()
double randDblExc (const double &n)
uint32 randInt ()
uint32 randInt (const uint32 &n)
double operator() ()
double rand53 ()
double randNorm (const double &mean=0.0, const double &variance=0.0)
void seed (const uint32 oneSeed)
void seed (uint32 const bigSeed, const uint32 seedLength=N)
void seed ()
void save (uint32 saveArray) const
void load (uint32 const loadArray)

Static Public Member Functions


static uint32 hash (time_t t, clock_t c)

Protected Types
enum { M = 397 }

Protected Member Functions

void initialize (const uint32 oneSeed)


void reload ()
uint32 hiBit (const uint32 &u) const
uint32 loBits (const uint32 &u) const
uint32 mixBits (const uint32 &u, const uint32 &v) const
uint32 twist (const uint32 &m, const uint32 &s0, const uint32 &s1) const

Protected Attributes
uint32 state [N]
uint32 pNext
int left

Friends
std::ostream & operator<< (std::ostream &os, const MTRand &mtrand)
std::istream & operator>> (std::istream &is, MTRand &mtrand)
The documentation for this class was generated from the following file:
src/sumo/include/foreign/mersenne/MersenneTwister.h
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.51 Named Class Reference

5.51

89

Named Class Reference

Base class for objects which have an id.

#include <Named.h>

Classes
struct ComparatorIdLess
Function-object for stable sorting in containers.

struct NamedLikeComparatorIdLess
Function-object for stable sorting of objects acting like Named without being derived (SUMOVehicle)

class StoringVisitor
Allows to store the object; used as context while traveling the rtree in TraCI.

Public Member Functions


Named (const std::string &id)
Constructor.

virtual Named ()
Destructor.

const std::string & getID () const


Returns the id.

void setID (const std::string &newID)


resets the id

void addTo (const StoringVisitor &cont) const


Adds this object to the given container.

Protected Attributes
std::string myID
The name of the object.

5.51.1

Detailed Description

Base class for objects which have an id.

5.51.2

Constructor & Destructor Documentation

5.51.2.1

Named::Named ( const std::string & id ) [inline]

Constructor.
Parameters

in

id

The id of the object

5.51.3

Member Function Documentation

5.51.3.1

void Named::addTo ( const StoringVisitor & cont ) const [inline]

Adds this object to the given container.


Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

90

Class Documentation

Parameters
in,filled]

5.51.3.2

cont The container to add this item to

const std::string& Named::getID ( ) const [inline]

Returns the id.


Returns
The stored id

5.51.3.3

void Named::setID ( const std::string & newID ) [inline]

resets the id
Parameters
newID

in

The new id of this object

The documentation for this class was generated from the following file:
src/sumo/include/utils/common/Named.h

5.52

Named::NamedLikeComparatorIdLess< NamedLike > Struct Template Reference

Function-object for stable sorting of objects acting like Named without being derived (SUMOVehicle)

#include <Named.h>

Public Member Functions


bool operator() (const NamedLike const a, const NamedLike const b) const

5.52.1

Detailed Description

template<class NamedLike>struct Named::NamedLikeComparatorIdLess< NamedLike >


Function-object for stable sorting of objects acting like Named without being derived (SUMOVehicle)
The documentation for this struct was generated from the following file:
src/sumo/include/utils/common/Named.h

5.53

NamedObjectCont< T > Class Template Reference

A map of named object pointers.

#include <NamedObjectCont.h>

Public Types
typedef std::map< std::string, T > IDMap
Definition of the key to pointer map type.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.53 NamedObjectCont< T > Class Template Reference

91

Public Member Functions


NamedObjectCont ()
Constructor.

virtual NamedObjectCont ()
Destructor.

virtual bool add (const std::string &id, T item)


Adds an item.

virtual bool remove (const std::string &id)


Removes an item.

T get (const std::string &id) const


Retrieves an item.

void clear ()
Removes all items from the container (deletes them, too)

unsigned int size () const


Returns the number of items within the container.

bool erase (const std::string &id)


Removes the named item from the container.

const std::vector< T > & buildAndGetStaticVector () const


std::vector< T > getTempVector () const
void insertIDs (std::vector< std::string > &into) const
const IDMap & getMyMap () const

5.53.1

Detailed Description

template<class T>class NamedObjectCont< T >


A map of named object pointers.
An associative storage (map) for objects (pointers to them to be exact), which do have a name. In order to get the
stored objects as a list, each insertion/deletion sets the internal state value "myHaveChanged" to true, indicating
the list must be rebuild.

5.53.2

Member Function Documentation

5.53.2.1

template<class T > virtual bool NamedObjectCont< T >::add ( const std::string & id, T item ) [inline],
[virtual]

Adds an item.
If another item with the same name is already known, false is reported and the item is not added.
Parameters

in
in

id
item

The id of the item to add


The item to add

Returns
If the item could been added (no item with the same id was within the container before)

5.53.2.2

template<class T > bool NamedObjectCont< T >::erase ( const std::string & id ) [inline]

Removes the named item from the container.


If the named object exists, it is deleted, the key is removed from the map, and true is returned. If the id was not
known, false is returned.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

92

Class Documentation

Parameters
id

in

The id of the item to delete

Returns
Whether the object could be deleted (was within the map)

template<class T > T NamedObjectCont< T >::get ( const std::string & id ) const [inline]

5.53.2.3

Retrieves an item.
Returns 0 when no item with the given id is stored within the container
Parameters
id

in

The id of the item to retrieve

Returns
The item stored under the given id, or 0 if no such item exists

template<class T > virtual bool NamedObjectCont< T >::remove ( const std::string & id ) [inline],
[virtual]

5.53.2.4

Removes an item.
Parameters

in

id

The id of the item to remove

Returns
If the item could been removed (an item with the id was within the container before)

5.53.2.5

template<class T > unsigned int NamedObjectCont< T >::size ( ) const [inline]

Returns the number of items within the container.


Returns
The number of stored items
The documentation for this class was generated from the following file:
src/sumo/include/utils/common/NamedObjectCont.h

5.54

NamedRTree Class Reference

A RT-tree for efficient storing of SUMOs Named objects.

#include <NamedRTree.h>
Inheritance diagram for NamedRTree:
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.54 NamedRTree Class Reference

93

NAMED_RTREE_QUAL
NamedRTree

Public Member Functions


NamedRTree ()
Constructor.

NamedRTree ()
Destructor.

void Insert (const float a_min[2], const float a_max[2], Named const &a_data)
Insert entry.

void Remove (const float a_min[2], const float a_max[2], Named const &a_data)
Remove entry.

void RemoveAll ()
Remove all enrties.

int Search (const float a_min[2], const float a_max[2], const Named::StoringVisitor &c) const
Find all within search rectangle.

5.54.1

Detailed Description

A RT-tree for efficient storing of SUMOs Named objects.


This class specialises the used RT-tree implementation from "rttree.h". It stores names of "Named"-objects.
See Also
Named

5.54.2

Member Function Documentation

5.54.2.1

void NamedRTree::Insert ( const float a_min[2], const float a_max[2], Named const & a_data ) [inline]

Insert entry.
Parameters
a_min
a_max
a_data

Min of bounding rect


Max of bounding rect
The instance of a Named-object to add (the ID is added)

See Also
RTree::Insert

5.54.2.2

void NamedRTree::Remove ( const float a_min[2], const float a_max[2], Named const & a_data ) [inline]

Remove entry.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

94

Class Documentation

Parameters
a_min
a_max
a_data

Min of bounding rect


Max of bounding rect
The instance of a Named-object to remove

See Also
RTree::Remove

5.54.2.3

void NamedRTree::RemoveAll ( ) [inline]

Remove all enrties.


See Also
RTree::RemoveAll

5.54.2.4

int NamedRTree::Search ( const float a_min[2], const float a_max[2], const Named::StoringVisitor & c ) const

[inline]
Find all within search rectangle.
Parameters
a_min
a_max
a_searchResult
a_resultCallback
a_context

Min of search bounding rect


Max of search bounding rect
Search result array. Caller should set grow size. Function will reset, not append to array.
Callback function to return result. Callback should return true to continue searching
User context to pass as parameter to a_resultCallback

Returns
Returns the number of entries found

See Also
RTree::Search
The documentation for this class was generated from the following file:
src/sumo/include/utils/common/NamedRTree.h

5.55

NetworkBuffer Class Reference

Public Member Functions

NetworkBuffer (long _capacity=0)


NetworkBuffer (const NetworkBuffer &s)
NetworkBuffer & operator= (const NetworkBuffer &s)
NetworkBuffer clone () const
void swap (NetworkBuffer &s)
long MaxSize () const
long Size () const
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.56 Network::NetworkProfile Class Reference

95

long Capacity () const


void Capacity (long _capacity)
int Push (Message data)
int Pop (Message &data)

The documentation for this class was generated from the following file:
src/pnp2/include/pnp2/NetworkBuffer.hpp

5.56

Network::NetworkProfile Class Reference

Defines how the bandwidth and latency of a given network link vary as functions of time over a specified period.

#include <NetworkProfile.hpp>

Public Member Functions

NetworkProfile (const NetworkProfile &s)


NetworkProfile & operator= (const NetworkProfile &s)
NetworkProfile clone () const
void swap (NetworkProfile &s)
std::string toString ()
int setStartTime (double t)
void setPeriod (double t)
void setPriority (uint64_t p)
void setUUID (uint64_t u)
int initializeFromFile (const char fname)
int initializeFromString (char buffer)
int initializeFromIStream (std::istream &stream)
int parse_csv (std::vector< std::vector< double > > csv)
double getOffset (timespec &t)
uint64_t getDataAtTime (timespec t)
Returns the interpolated, cumulative data that can have been sent by time t.

int getCurrentInterval (uint64_t &bandwidth, double &latency)


Returns the bandwidth and latency for the interval containing the current system clocks time.

int getNextInterval (timespec &start, uint64_t &bandwidth, double &latency)


Returns the start, bandwidth, and latency values for the next interval after the one that contains the current system
clocks time.

double Delay (uint64_t dataLenBits, timespec sentTime)


Returns the amount of time in seconds that data of length dataLenBits will take to transmit at time sentTime.

bool Initialized () const


bool HasEntries () const

Public Attributes
std::vector< ResourceEntry > resources
time-sorted array of

timespec start_time
the start time of the profile in epoch time

double period
the period of the profile in seconds

uint64_t priority
the system-wide unique priority of the profile

uint64_t uuid
the unique ID of the profile

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

96

Class Documentation

5.56.1

Detailed Description

Defines how the bandwidth and latency of a given network link vary as functions of time over a specified period.

5.56.2

Member Function Documentation

5.56.2.1

double Network::NetworkProfile::Delay ( uint64_t dataLenBits, timespec sentTime ) [inline]

Returns the amount of time in seconds that data of length dataLenBits will take to transmit at time sentTime.
Parameters
dataLenBits
sentTime

in
in

the length of the data in bits


the epoch time when the data was sent

Returns
double seconds from the current time before more data can be sent

5.56.2.2

int Network::NetworkProfile::getCurrentInterval ( uint64_t & bandwidth, double & latency ) [inline]

Returns the bandwidth and latency for the interval containing the current system clocks time.
Parameters

out
out

5.56.2.3

bandwidth
latency

the current available bandwidth


the current latency data will experience on the link

uint64_t Network::NetworkProfile::getDataAtTime ( timespec t ) [inline]

Returns the interpolated, cumulative data that can have been sent by time t.
Parameters
t

in

5.56.2.4

the time in question (epoch time)

int Network::NetworkProfile::getNextInterval ( timespec & start, uint64_t & bandwidth, double & latency )

[inline]
Returns the start, bandwidth, and latency values for the next interval after the one that contains the current system
clocks time.
Parameters

out
out
out

start
bandwidth
latency

the start time of the next interval in epoch time


the available bandwidth in the next interval
the latency that will be experienced by data in the next interval

5.56.3

Member Data Documentation

5.56.3.1

std::vector<ResourceEntry> Network::NetworkProfile::resources

time-sorted array of
ResourceEntry elements defining the bandwidth, data, and latency intervals
The documentation for this class was generated from the following file:
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.57 NumberFormatException Class Reference

97

src/pnp2/include/pnp2/NetworkProfile.hpp

5.57

NumberFormatException Class Reference

NumberFormatException Thrown when the string that shall be converted into a numerical representation has any
other characters then digits and a dot.

#include <UtilExceptions.h>
Inheritance diagram for NumberFormatException:

runtime_error
FormatException
NumberFormatException

Public Member Functions


NumberFormatException ()
constructor

5.57.1

Detailed Description

NumberFormatException Thrown when the string that shall be converted into a numerical representation has any
other characters then digits and a dot.
The documentation for this class was generated from the following file:
src/sumo/include/utils/common/UtilExceptions.h

5.58

Option Class Reference

A class representing a single program option.

#include <Option.h>
Inheritance diagram for Option:

Option
Option_Bool

Option_Float

Option_Integer

Option_IntVector

Option_String
Option_FileName

Public Member Functions


virtual Option ()
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

98

Class Documentation

destructor

bool isSet () const


returns the information whether this options holds a valid value

void unSet ()
marks this option as unset

virtual SUMOReal getFloat () const


Returns the stored SUMOReal value.

virtual int getInt () const


Returns the stored integer value.

virtual std::string getString () const


Returns the stored string value.

virtual bool getBool () const


Returns the stored boolean value.

virtual const IntVector & getIntVector () const


Returns the stored integer vector.

virtual bool set (const std::string &v)=0


Stores the given value (used for non-bool options)

virtual std::string getValueString () const =0


Returns the string-representation of the value.

virtual bool isBool () const


Returns the information whether the option is a bool option.

virtual bool isDefault () const


Returns the information whether the option holds the default value.

virtual bool isFileName () const


Returns the information whether this option is a file name.

bool isWriteable () const


Returns the information whether the option may be set a further time.

void resetWritable ()
Resets the option to be writeable.

const std::string & getDescription () const


Returns the description of what this option does.

void setDescription (const std::string &desc)


Sets the description of what this option does.

virtual const std::string & getTypeName () const


Returns the mml-type name of this option.

Protected Member Functions


bool markSet ()
Marks the information as set.

Option (bool set=false)


Constructor.

Option (const Option &s)


Copy constructor.

virtual Option & operator= (const Option &s)


Assignment operator.

Protected Attributes
std::string myTypeName
A type name for this option (has presets, but may be overwritten)

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.58 Option Class Reference

5.58.1

99

Detailed Description

A class representing a single program option.


The base class for a single program option. All options which hold values are derived from this class as the type of
stored values may differ.
Most of the getter-methods throw exceptions because this base class is not meant to hold any values by itself.
Instead, the derived classes implement the appropriate method (Option_Integer implements getInt, f.e.). So, when
one tries to retrieve a value which is not of the type of the option, an exception will be thrown. This behaviour is
meant to be valid, because errors like this one only occur when building and testing the application.
Due to described behaviour, this class has no public constructors. Only construction of derived, value and type
holding, classes is allowed.
At the begin (after being constructed) an Option either has a default value or not. In dependance to this, myHaveTheDefaultValue is set. Also, myAmSet is set to true if a default value was supported. myAmWritable is set to true,
indicating that a new value may be set.
Each option may have a description about its purpose stored. Furthermore, it stores a man-readable type name for
this option.

5.58.2

Constructor & Destructor Documentation

5.58.2.1

Option::Option ( bool set = false ) [protected]

Constructor.
This constructor should be used by derived classes. The boolean value indicates whether a default value was
supplied or not.
Parameters
set

in

A default value was supplied

5.58.3

Member Function Documentation

5.58.3.1

virtual bool Option::getBool ( ) const [virtual]

Returns the stored boolean value.


Option_Bool returns the stored boolean in this methods reimplementation. All other option classes do not override
this method which throws an InvalidArgument-exception.
Returns
Returns the stored boolean if being an instance of Option_Bool
Exceptions
InvalidArgument

If the class is not an instance of Option_Bool

Reimplemented in Option_Bool.

5.58.3.2

const std::string& Option::getDescription ( ) const

Returns the description of what this option does.


The description stored in myDescription is returned.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

100

Class Documentation

Returns
The description of this options purpose

5.58.3.3

virtual SUMOReal Option::getFloat ( ) const [virtual]

Returns the stored SUMOReal value.


Option_Float returns the stored real number in this methods reimplementation. All other option classes do not
override this method which throws an InvalidArgument-exception.
Returns
Returns the stored real number if being an instance of Option_Float
Exceptions
InvalidArgument

If the class is not an instance of Option_Float

Reimplemented in Option_Float.

5.58.3.4

virtual int Option::getInt ( ) const [virtual]

Returns the stored integer value.


Option_Integer returns the stored integer number in this methods reimplementation. All other option classesdo not
override this method which throws an InvalidArgument-exception.
Returns
Returns the stored integer number if being an instance of Option_Integer
Exceptions
InvalidArgument

If the class is not an instance of Option_Integer

Reimplemented in Option_Integer.

5.58.3.5

virtual const IntVector& Option::getIntVector ( ) const [virtual]

Returns the stored integer vector.


Option_IntVector returns the stored integer vector in this methods reimplementation. All other option classes do not
override this method which throws an InvalidArgument-exception.
Returns
Returns the stored integer vector if being an instance of Option_IntVector
Exceptions
InvalidArgument

If the class is not an instance of Option_IntVector

Reimplemented in Option_IntVector.

5.58.3.6

virtual std::string Option::getString ( ) const [virtual]

Returns the stored string value.


Option_String and Option_FileName return the stored string in this methods reimplementation. All other option
classes do not override this method which throws an InvalidArgument-exception.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.58 Option Class Reference

101

Returns
Returns the stored string if being an instance of Option_String
Exceptions
InvalidArgument

If the class is not an instance of Option_String

Reimplemented in Option_String.

5.58.3.7

virtual const std::string& Option::getTypeName ( ) const [virtual]

Returns the mml-type name of this option.


The type name stored in myTypeName is returned.
Returns
The man-readable type name

5.58.3.8

virtual std::string Option::getValueString ( ) const [pure virtual]

Returns the string-representation of the value.


The stored value is encoded into a string and returned.
Returns
The stored value encoded into a stringImplemented in Option_IntVector, Option_Bool, Option_Float, Option_String, and Option_Integer.

5.58.3.9

virtual bool Option::isBool ( ) const [virtual]

Returns the information whether the option is a bool option.


Returns false. Only Option_Bool overrides this method returning true.
Returns
true if the Option is an Option_Bool, false otherwise
Reimplemented in Option_Bool.

5.58.3.10

virtual bool Option::isDefault ( ) const [virtual]

Returns the information whether the option holds the default value.
Returns
true if the option was not set from command line / configuration, false otherwise

5.58.3.11

virtual bool Option::isFileName ( ) const [virtual]

Returns the information whether this option is a file name.


Returns false. Only Option_FileName overrides this method returning true.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

102

Class Documentation

Returns
true if the Option is an Option_FileName, false otherwise
Reimplemented in Option_FileName.

5.58.3.12

bool Option::isSet ( ) const

returns the information whether this options holds a valid value


Returns
Whether a value has been set

5.58.3.13

bool Option::isWriteable ( ) const

Returns the information whether the option may be set a further time.
This method returns whether the option was not already set using command line options / configuration. This is
done by returning the value of myAmWritable.
Returns
Whether the option may be set from the command line / configuration

5.58.3.14

bool Option::markSet ( ) [protected]

Marks the information as set.


Sets the "myAmSet" - information. Returns whether the option was writeable before.
Returns
Whether the option was not set before.

5.58.3.15

void Option::resetWritable ( )

Resets the option to be writeable.


An option is writable after initialisation, but as soon as it gets set, it is no longer writeable. This method resets the
writable-flag.

5.58.3.16

virtual bool Option::set ( const std::string & v ) [pure virtual]

Stores the given value (used for non-bool options)


This method is overriden by all option classes but Option_Bool. The value is converted into the proper type and
stored in "myValue". Then, "markSet" is called in order to know that a value has been set.
The method defined in Option throws an exception, because all derived classes should override it - for Option_Bool,
it is tested on a different position whether to use this method or bool set(bool).
The method returns whether the value could be set (the return value from "markSet").
If the string could not be converted into the type, an InvalidArgument is thrown.
Returns
Whether the new value could be set

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.59 Option_Bool Class Reference

103

Exceptions
InvalidArgument

If being an instance of Option or Option_Bool or if the value could not be converted

Implemented in Option_IntVector, Option_Bool, Option_Float, Option_String, and Option_Integer.

5.58.3.17

void Option::setDescription ( const std::string & desc )

Sets the description of what this option does.


The description stored in myDescription is returned.
Returns
The description of this options purpose
The documentation for this class was generated from the following file:
src/sumo/include/utils/options/Option.h

5.59

Option_Bool Class Reference

Inheritance diagram for Option_Bool:

Option
Option_Bool

Public Member Functions


Option_Bool ()
Constructor for an option with no default value.

Option_Bool (bool value)


Constructor for an option with a default value.

Option_Bool (const Option_Bool &s)


Copy constructor.

Option_Bool ()
Destructor.

Option_Bool & operator= (const Option_Bool &s)


Assignment operator.

bool getBool () const


Returns the stored boolean value.

bool set (const std::string &v)


sets the given value (converts it to bool)

std::string getValueString () const


Returns the string-representation of the value.

bool isBool () const


Returns true, the information whether the option is a bool option.

bool isSet () const


returns the information whether this options holds a valid value

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

104

Class Documentation

void unSet ()
marks this option as unset

virtual SUMOReal getFloat () const


Returns the stored SUMOReal value.

virtual int getInt () const


Returns the stored integer value.

virtual std::string getString () const


Returns the stored string value.

virtual const IntVector & getIntVector () const


Returns the stored integer vector.

virtual bool isDefault () const


Returns the information whether the option holds the default value.

virtual bool isFileName () const


Returns the information whether this option is a file name.

bool isWriteable () const


Returns the information whether the option may be set a further time.

void resetWritable ()
Resets the option to be writeable.

const std::string & getDescription () const


Returns the description of what this option does.

void setDescription (const std::string &desc)


Sets the description of what this option does.

virtual const std::string & getTypeName () const


Returns the mml-type name of this option.

Protected Member Functions


bool markSet ()
Marks the information as set.

Protected Attributes
std::string myTypeName
A type name for this option (has presets, but may be overwritten)

5.59.1

Constructor & Destructor Documentation

5.59.1.1

Option_Bool::Option_Bool ( )

Constructor for an option with no default value.


Calls Option(false)

5.59.1.2

Option_Bool::Option_Bool ( bool value )

Constructor for an option with a default value.


Calls Option(true)

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.59 Option_Bool Class Reference

105

Parameters
value

in

This options default value

5.59.2

Member Function Documentation

5.59.2.1

bool Option_Bool::getBool ( ) const [virtual]

Returns the stored boolean value.


See Also
bool Option::getBool()

Returns
Returns the stored boolean
Reimplemented from Option.

5.59.2.2

const std::string& Option::getDescription ( ) const [inherited]

Returns the description of what this option does.


The description stored in myDescription is returned.
Returns
The description of this options purpose

5.59.2.3

virtual SUMOReal Option::getFloat ( ) const [virtual], [inherited]

Returns the stored SUMOReal value.


Option_Float returns the stored real number in this methods reimplementation. All other option classes do not
override this method which throws an InvalidArgument-exception.
Returns
Returns the stored real number if being an instance of Option_Float
Exceptions
InvalidArgument

If the class is not an instance of Option_Float

Reimplemented in Option_Float.

5.59.2.4

virtual int Option::getInt ( ) const [virtual], [inherited]

Returns the stored integer value.


Option_Integer returns the stored integer number in this methods reimplementation. All other option classesdo not
override this method which throws an InvalidArgument-exception.
Returns
Returns the stored integer number if being an instance of Option_Integer

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

106

Class Documentation

Exceptions
InvalidArgument

If the class is not an instance of Option_Integer

Reimplemented in Option_Integer.

5.59.2.5

virtual const IntVector& Option::getIntVector ( ) const [virtual], [inherited]

Returns the stored integer vector.


Option_IntVector returns the stored integer vector in this methods reimplementation. All other option classes do not
override this method which throws an InvalidArgument-exception.
Returns
Returns the stored integer vector if being an instance of Option_IntVector
Exceptions
InvalidArgument

If the class is not an instance of Option_IntVector

Reimplemented in Option_IntVector.

5.59.2.6

virtual std::string Option::getString ( ) const [virtual], [inherited]

Returns the stored string value.


Option_String and Option_FileName return the stored string in this methods reimplementation. All other option
classes do not override this method which throws an InvalidArgument-exception.
Returns
Returns the stored string if being an instance of Option_String
Exceptions
InvalidArgument

If the class is not an instance of Option_String

Reimplemented in Option_String.

5.59.2.7

virtual const std::string& Option::getTypeName ( ) const [virtual], [inherited]

Returns the mml-type name of this option.


The type name stored in myTypeName is returned.
Returns
The man-readable type name

5.59.2.8

std::string Option_Bool::getValueString ( ) const [virtual]

Returns the string-representation of the value.


If myValue is true, "true" is returned, "false" otherwise.
See Also
std::string Option::getValueString()

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.59 Option_Bool Class Reference

107

Returns
The stored value encoded into a string
Implements Option.

5.59.2.9

bool Option_Bool::isBool ( ) const [virtual]

Returns true, the information whether the option is a bool option.


Returns true.
See Also
bool Option::isBool()
Returns
true
Reimplemented from Option.

5.59.2.10

virtual bool Option::isDefault ( ) const [virtual], [inherited]

Returns the information whether the option holds the default value.
Returns
true if the option was not set from command line / configuration, false otherwise

5.59.2.11

virtual bool Option::isFileName ( ) const [virtual], [inherited]

Returns the information whether this option is a file name.


Returns false. Only Option_FileName overrides this method returning true.
Returns
true if the Option is an Option_FileName, false otherwise
Reimplemented in Option_FileName.

5.59.2.12

bool Option::isSet ( ) const [inherited]

returns the information whether this options holds a valid value


Returns
Whether a value has been set

5.59.2.13

bool Option::isWriteable ( ) const [inherited]

Returns the information whether the option may be set a further time.
This method returns whether the option was not already set using command line options / configuration. This is
done by returning the value of myAmWritable.
Returns
Whether the option may be set from the command line / configuration

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

108

Class Documentation

5.59.2.14

bool Option::markSet ( ) [protected], [inherited]

Marks the information as set.


Sets the "myAmSet" - information. Returns whether the option was writeable before.
Returns
Whether the option was not set before.

5.59.2.15

void Option::resetWritable ( ) [inherited]

Resets the option to be writeable.


An option is writable after initialisation, but as soon as it gets set, it is no longer writeable. This method resets the
writable-flag.

5.59.2.16

void Option::setDescription ( const std::string & desc ) [inherited]

Sets the description of what this option does.


The description stored in myDescription is returned.
Returns
The description of this options purpose
The documentation for this class was generated from the following file:
src/sumo/include/utils/options/Option.h

5.60

Option_FileName Class Reference

Inheritance diagram for Option_FileName:

Option
Option_String
Option_FileName

Public Member Functions


Option_FileName ()
Constructor for an option with no default value.

Option_FileName (const std::string &value)


Constructor for an option with a default value.

Option_FileName (const Option_String &s)


Copy constructor.

virtual Option_FileName ()
Destructor.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.60 Option_FileName Class Reference

Option_FileName & operator= (const Option_FileName &s)


Assignment operator.

bool isFileName () const


Returns true, the information whether this option is a file name.

std::string getString () const


Returns the stored string value.

bool set (const std::string &v)


Stores the given value.

std::string getValueString () const


Returns the string-representation of the value.

bool isSet () const


returns the information whether this options holds a valid value

void unSet ()
marks this option as unset

virtual SUMOReal getFloat () const


Returns the stored SUMOReal value.

virtual int getInt () const


Returns the stored integer value.

virtual bool getBool () const


Returns the stored boolean value.

virtual const IntVector & getIntVector () const


Returns the stored integer vector.

virtual bool isBool () const


Returns the information whether the option is a bool option.

virtual bool isDefault () const


Returns the information whether the option holds the default value.

bool isWriteable () const


Returns the information whether the option may be set a further time.

void resetWritable ()
Resets the option to be writeable.

const std::string & getDescription () const


Returns the description of what this option does.

void setDescription (const std::string &desc)


Sets the description of what this option does.

virtual const std::string & getTypeName () const


Returns the mml-type name of this option.

Protected Member Functions


bool markSet ()
Marks the information as set.

Protected Attributes
std::string myValue
the value, valid only when the base-classes "myAmSet"-member is true

std::string myTypeName
A type name for this option (has presets, but may be overwritten)

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

109

110

Class Documentation

5.60.1

Constructor & Destructor Documentation

5.60.1.1

Option_FileName::Option_FileName ( const std::string & value )

Constructor for an option with a default value.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.60 Option_FileName Class Reference

111

Parameters
value

in

This options default value

5.60.2

Member Function Documentation

5.60.2.1

virtual bool Option::getBool ( ) const [virtual], [inherited]

Returns the stored boolean value.


Option_Bool returns the stored boolean in this methods reimplementation. All other option classes do not override
this method which throws an InvalidArgument-exception.
Returns
Returns the stored boolean if being an instance of Option_Bool
Exceptions
InvalidArgument

If the class is not an instance of Option_Bool

Reimplemented in Option_Bool.

5.60.2.2

const std::string& Option::getDescription ( ) const [inherited]

Returns the description of what this option does.


The description stored in myDescription is returned.
Returns
The description of this options purpose

5.60.2.3

virtual SUMOReal Option::getFloat ( ) const [virtual], [inherited]

Returns the stored SUMOReal value.


Option_Float returns the stored real number in this methods reimplementation. All other option classes do not
override this method which throws an InvalidArgument-exception.
Returns
Returns the stored real number if being an instance of Option_Float
Exceptions
InvalidArgument

If the class is not an instance of Option_Float

Reimplemented in Option_Float.

5.60.2.4

virtual int Option::getInt ( ) const [virtual], [inherited]

Returns the stored integer value.


Option_Integer returns the stored integer number in this methods reimplementation. All other option classesdo not
override this method which throws an InvalidArgument-exception.
Returns
Returns the stored integer number if being an instance of Option_Integer

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

112

Class Documentation

Exceptions
InvalidArgument

If the class is not an instance of Option_Integer

Reimplemented in Option_Integer.

5.60.2.5

virtual const IntVector& Option::getIntVector ( ) const [virtual], [inherited]

Returns the stored integer vector.


Option_IntVector returns the stored integer vector in this methods reimplementation. All other option classes do not
override this method which throws an InvalidArgument-exception.
Returns
Returns the stored integer vector if being an instance of Option_IntVector
Exceptions
InvalidArgument

If the class is not an instance of Option_IntVector

Reimplemented in Option_IntVector.

5.60.2.6

std::string Option_String::getString ( ) const [virtual], [inherited]

Returns the stored string value.


See Also
std::string Option::getString()
Returns
Returns the stored string
Reimplemented from Option.

5.60.2.7

virtual const std::string& Option::getTypeName ( ) const [virtual], [inherited]

Returns the mml-type name of this option.


The type name stored in myTypeName is returned.
Returns
The man-readable type name

5.60.2.8

std::string Option_String::getValueString ( ) const [virtual], [inherited]

Returns the string-representation of the value.


The stored value is encoded into a string and returned.
See Also
std::string Option::getValueString()
Returns
The stored value encoded into a string
Implements Option.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.60 Option_FileName Class Reference

5.60.2.9

113

virtual bool Option::isBool ( ) const [virtual], [inherited]

Returns the information whether the option is a bool option.


Returns false. Only Option_Bool overrides this method returning true.
Returns
true if the Option is an Option_Bool, false otherwise
Reimplemented in Option_Bool.

5.60.2.10

virtual bool Option::isDefault ( ) const [virtual], [inherited]

Returns the information whether the option holds the default value.
Returns
true if the option was not set from command line / configuration, false otherwise

5.60.2.11

bool Option_FileName::isFileName ( ) const [virtual]

Returns true, the information whether this option is a file name.


Returns true.
Returns
true
Reimplemented from Option.

5.60.2.12

bool Option::isSet ( ) const [inherited]

returns the information whether this options holds a valid value


Returns
Whether a value has been set

5.60.2.13

bool Option::isWriteable ( ) const [inherited]

Returns the information whether the option may be set a further time.
This method returns whether the option was not already set using command line options / configuration. This is
done by returning the value of myAmWritable.
Returns
Whether the option may be set from the command line / configuration

5.60.2.14

bool Option::markSet ( ) [protected], [inherited]

Marks the information as set.


Sets the "myAmSet" - information. Returns whether the option was writeable before.
Returns
Whether the option was not set before.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

114

Class Documentation

5.60.2.15

void Option::resetWritable ( ) [inherited]

Resets the option to be writeable.


An option is writable after initialisation, but as soon as it gets set, it is no longer writeable. This method resets the
writable-flag.

5.60.2.16

bool Option_String::set ( const std::string & v ) [virtual], [inherited]

Stores the given value.


The value is stored in "myValue". Then, "markSet" is called in order to know that a value has been set.
The method returns whether the value could be set (the return value from "markSet").
See Also
bool Option::set(std::string v)

Returns
Whether the new value could be set
Implements Option.

5.60.2.17

void Option::setDescription ( const std::string & desc ) [inherited]

Sets the description of what this option does.


The description stored in myDescription is returned.
Returns
The description of this options purpose
The documentation for this class was generated from the following file:
src/sumo/include/utils/options/Option.h

5.61

Option_Float Class Reference

Inheritance diagram for Option_Float:

Option
Option_Float

Public Member Functions


Option_Float ()
Constructor for an option with no default value.

Option_Float (SUMOReal value)


Constructor for an option with a default value.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.61 Option_Float Class Reference

Option_Float (const Option_Float &s)


Copy constructor.

Option_Float ()
Destructor.

Option_Float & operator= (const Option_Float &s)


Assignment operator.

SUMOReal getFloat () const


Returns the stored SUMOReal value.

bool set (const std::string &v)


Stores the given value after parsing it into a SUMOReal.

std::string getValueString () const


Returns the string-representation of the value.

bool isSet () const


returns the information whether this options holds a valid value

void unSet ()
marks this option as unset

virtual int getInt () const


Returns the stored integer value.

virtual std::string getString () const


Returns the stored string value.

virtual bool getBool () const


Returns the stored boolean value.

virtual const IntVector & getIntVector () const


Returns the stored integer vector.

virtual bool isBool () const


Returns the information whether the option is a bool option.

virtual bool isDefault () const


Returns the information whether the option holds the default value.

virtual bool isFileName () const


Returns the information whether this option is a file name.

bool isWriteable () const


Returns the information whether the option may be set a further time.

void resetWritable ()
Resets the option to be writeable.

const std::string & getDescription () const


Returns the description of what this option does.

void setDescription (const std::string &desc)


Sets the description of what this option does.

virtual const std::string & getTypeName () const


Returns the mml-type name of this option.

Protected Member Functions


bool markSet ()
Marks the information as set.

Protected Attributes
std::string myTypeName
A type name for this option (has presets, but may be overwritten)

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

115

116

Class Documentation

5.61.1

Constructor & Destructor Documentation

5.61.1.1

Option_Float::Option_Float ( )

Constructor for an option with no default value.


Calls Option(false)

5.61.1.2

Option_Float::Option_Float ( SUMOReal value )

Constructor for an option with a default value.


Calls Option(true)
Parameters
value

in

This options default value

5.61.2

Member Function Documentation

5.61.2.1

virtual bool Option::getBool ( ) const [virtual], [inherited]

Returns the stored boolean value.


Option_Bool returns the stored boolean in this methods reimplementation. All other option classes do not override
this method which throws an InvalidArgument-exception.
Returns
Returns the stored boolean if being an instance of Option_Bool
Exceptions
InvalidArgument

If the class is not an instance of Option_Bool

Reimplemented in Option_Bool.

5.61.2.2

const std::string& Option::getDescription ( ) const [inherited]

Returns the description of what this option does.


The description stored in myDescription is returned.
Returns
The description of this options purpose

5.61.2.3

SUMOReal Option_Float::getFloat ( ) const [virtual]

Returns the stored SUMOReal value.


See Also
SUMOReal Option::getFloat()
Returns
Returns the stored real number
Reimplemented from Option.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.61 Option_Float Class Reference

5.61.2.4

117

virtual int Option::getInt ( ) const [virtual], [inherited]

Returns the stored integer value.


Option_Integer returns the stored integer number in this methods reimplementation. All other option classesdo not
override this method which throws an InvalidArgument-exception.
Returns
Returns the stored integer number if being an instance of Option_Integer
Exceptions
InvalidArgument

If the class is not an instance of Option_Integer

Reimplemented in Option_Integer.

5.61.2.5

virtual const IntVector& Option::getIntVector ( ) const [virtual], [inherited]

Returns the stored integer vector.


Option_IntVector returns the stored integer vector in this methods reimplementation. All other option classes do not
override this method which throws an InvalidArgument-exception.
Returns
Returns the stored integer vector if being an instance of Option_IntVector
Exceptions
InvalidArgument

If the class is not an instance of Option_IntVector

Reimplemented in Option_IntVector.

5.61.2.6

virtual std::string Option::getString ( ) const [virtual], [inherited]

Returns the stored string value.


Option_String and Option_FileName return the stored string in this methods reimplementation. All other option
classes do not override this method which throws an InvalidArgument-exception.
Returns
Returns the stored string if being an instance of Option_String
Exceptions
InvalidArgument

If the class is not an instance of Option_String

Reimplemented in Option_String.

5.61.2.7

virtual const std::string& Option::getTypeName ( ) const [virtual], [inherited]

Returns the mml-type name of this option.


The type name stored in myTypeName is returned.
Returns
The man-readable type name

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

118

Class Documentation

5.61.2.8

std::string Option_Float::getValueString ( ) const [virtual]

Returns the string-representation of the value.


The stored value is encoded into a string and returned.
See Also
std::string Option::getValueString()

Returns
The stored value encoded into a string
Implements Option.

5.61.2.9

virtual bool Option::isBool ( ) const [virtual], [inherited]

Returns the information whether the option is a bool option.


Returns false. Only Option_Bool overrides this method returning true.
Returns
true if the Option is an Option_Bool, false otherwise
Reimplemented in Option_Bool.

5.61.2.10

virtual bool Option::isDefault ( ) const [virtual], [inherited]

Returns the information whether the option holds the default value.
Returns
true if the option was not set from command line / configuration, false otherwise

5.61.2.11

virtual bool Option::isFileName ( ) const [virtual], [inherited]

Returns the information whether this option is a file name.


Returns false. Only Option_FileName overrides this method returning true.
Returns
true if the Option is an Option_FileName, false otherwise
Reimplemented in Option_FileName.

5.61.2.12

bool Option::isSet ( ) const [inherited]

returns the information whether this options holds a valid value


Returns
Whether a value has been set

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.61 Option_Float Class Reference

5.61.2.13

119

bool Option::isWriteable ( ) const [inherited]

Returns the information whether the option may be set a further time.
This method returns whether the option was not already set using command line options / configuration. This is
done by returning the value of myAmWritable.
Returns
Whether the option may be set from the command line / configuration

5.61.2.14

bool Option::markSet ( ) [protected], [inherited]

Marks the information as set.


Sets the "myAmSet" - information. Returns whether the option was writeable before.
Returns
Whether the option was not set before.

5.61.2.15

void Option::resetWritable ( ) [inherited]

Resets the option to be writeable.


An option is writable after initialisation, but as soon as it gets set, it is no longer writeable. This method resets the
writable-flag.

5.61.2.16

bool Option_Float::set ( const std::string & v ) [virtual]

Stores the given value after parsing it into a SUMOReal.


The value is converted into a SUMOReal and stored in "myValue". Then, "markSet" is called in order to know that
a value has been set.
The method returns whether the value could be set (the return value from "markSet").
If the string could not be converted into a SUMOReal, an InvalidArgument is thrown.
See Also
bool Option::set(std::string v)

Returns
Whether the new value could be set
Exceptions
InvalidArgument

If the value could not be converted into a SUMOReal

Implements Option.

5.61.2.17

void Option::setDescription ( const std::string & desc ) [inherited]

Sets the description of what this option does.


The description stored in myDescription is returned.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

120

Class Documentation

Returns
The description of this options purpose
The documentation for this class was generated from the following file:
src/sumo/include/utils/options/Option.h

5.62

Option_Integer Class Reference

An integer-option.

#include <Option.h>
Inheritance diagram for Option_Integer:

Option
Option_Integer

Public Member Functions


Option_Integer ()
Constructor for an option with no default value.

Option_Integer (int value)


Constructor for an option with a default value.

Option_Integer (const Option_Integer &s)


Copy constructor.

Option_Integer ()
Destructor.

Option_Integer & operator= (const Option_Integer &s)


Assignment operator.

int getInt () const


Returns the stored integer value.

bool set (const std::string &v)


Stores the given value after parsing it into an integer.

std::string getValueString () const


Returns the string-representation of the value.

bool isSet () const


returns the information whether this options holds a valid value

void unSet ()
marks this option as unset

virtual SUMOReal getFloat () const


Returns the stored SUMOReal value.

virtual std::string getString () const


Returns the stored string value.

virtual bool getBool () const


Returns the stored boolean value.

virtual const IntVector & getIntVector () const


Returns the stored integer vector.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.62 Option_Integer Class Reference

virtual bool isBool () const


Returns the information whether the option is a bool option.

virtual bool isDefault () const


Returns the information whether the option holds the default value.

virtual bool isFileName () const


Returns the information whether this option is a file name.

bool isWriteable () const


Returns the information whether the option may be set a further time.

void resetWritable ()
Resets the option to be writeable.

const std::string & getDescription () const


Returns the description of what this option does.

void setDescription (const std::string &desc)


Sets the description of what this option does.

virtual const std::string & getTypeName () const


Returns the mml-type name of this option.

Protected Member Functions


bool markSet ()
Marks the information as set.

Protected Attributes
std::string myTypeName
A type name for this option (has presets, but may be overwritten)

5.62.1

Detailed Description

An integer-option.

5.62.2

Constructor & Destructor Documentation

5.62.2.1

Option_Integer::Option_Integer ( )

Constructor for an option with no default value.


Calls Option(false)

5.62.2.2

Option_Integer::Option_Integer ( int value )

Constructor for an option with a default value.


Calls Option(true)
Parameters

in

value

This options default value

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

121

122

Class Documentation

5.62.3

Member Function Documentation

5.62.3.1

virtual bool Option::getBool ( ) const [virtual], [inherited]

Returns the stored boolean value.


Option_Bool returns the stored boolean in this methods reimplementation. All other option classes do not override
this method which throws an InvalidArgument-exception.
Returns
Returns the stored boolean if being an instance of Option_Bool
Exceptions
InvalidArgument

If the class is not an instance of Option_Bool

Reimplemented in Option_Bool.

5.62.3.2

const std::string& Option::getDescription ( ) const [inherited]

Returns the description of what this option does.


The description stored in myDescription is returned.
Returns
The description of this options purpose

5.62.3.3

virtual SUMOReal Option::getFloat ( ) const [virtual], [inherited]

Returns the stored SUMOReal value.


Option_Float returns the stored real number in this methods reimplementation. All other option classes do not
override this method which throws an InvalidArgument-exception.
Returns
Returns the stored real number if being an instance of Option_Float
Exceptions
InvalidArgument

If the class is not an instance of Option_Float

Reimplemented in Option_Float.

5.62.3.4

int Option_Integer::getInt ( ) const [virtual]

Returns the stored integer value.


See Also
Option::getInt()

Returns
Returns the stored integer number
Reimplemented from Option.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.62 Option_Integer Class Reference

5.62.3.5

123

virtual const IntVector& Option::getIntVector ( ) const [virtual], [inherited]

Returns the stored integer vector.


Option_IntVector returns the stored integer vector in this methods reimplementation. All other option classes do not
override this method which throws an InvalidArgument-exception.
Returns
Returns the stored integer vector if being an instance of Option_IntVector
Exceptions
InvalidArgument

If the class is not an instance of Option_IntVector

Reimplemented in Option_IntVector.

5.62.3.6

virtual std::string Option::getString ( ) const [virtual], [inherited]

Returns the stored string value.


Option_String and Option_FileName return the stored string in this methods reimplementation. All other option
classes do not override this method which throws an InvalidArgument-exception.
Returns
Returns the stored string if being an instance of Option_String
Exceptions
InvalidArgument

If the class is not an instance of Option_String

Reimplemented in Option_String.

5.62.3.7

virtual const std::string& Option::getTypeName ( ) const [virtual], [inherited]

Returns the mml-type name of this option.


The type name stored in myTypeName is returned.
Returns
The man-readable type name

5.62.3.8

std::string Option_Integer::getValueString ( ) const [virtual]

Returns the string-representation of the value.


The stored value is encoded into a string and returned.
See Also
std::string Option::getValueString()

Returns
The stored value encoded into a string
Implements Option.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

124

Class Documentation

5.62.3.9

virtual bool Option::isBool ( ) const [virtual], [inherited]

Returns the information whether the option is a bool option.


Returns false. Only Option_Bool overrides this method returning true.
Returns
true if the Option is an Option_Bool, false otherwise
Reimplemented in Option_Bool.

5.62.3.10

virtual bool Option::isDefault ( ) const [virtual], [inherited]

Returns the information whether the option holds the default value.
Returns
true if the option was not set from command line / configuration, false otherwise

5.62.3.11

virtual bool Option::isFileName ( ) const [virtual], [inherited]

Returns the information whether this option is a file name.


Returns false. Only Option_FileName overrides this method returning true.
Returns
true if the Option is an Option_FileName, false otherwise
Reimplemented in Option_FileName.

5.62.3.12

bool Option::isSet ( ) const [inherited]

returns the information whether this options holds a valid value


Returns
Whether a value has been set

5.62.3.13

bool Option::isWriteable ( ) const [inherited]

Returns the information whether the option may be set a further time.
This method returns whether the option was not already set using command line options / configuration. This is
done by returning the value of myAmWritable.
Returns
Whether the option may be set from the command line / configuration

5.62.3.14

bool Option::markSet ( ) [protected], [inherited]

Marks the information as set.


Sets the "myAmSet" - information. Returns whether the option was writeable before.
Returns
Whether the option was not set before.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.63 Option_IntVector Class Reference

5.62.3.15

125

void Option::resetWritable ( ) [inherited]

Resets the option to be writeable.


An option is writable after initialisation, but as soon as it gets set, it is no longer writeable. This method resets the
writable-flag.

5.62.3.16

bool Option_Integer::set ( const std::string & v ) [virtual]

Stores the given value after parsing it into an integer.


The value is converted into an integer and stored in "myValue". Then, "markSet" is called in order to know that a
value has been set.
The method returns whether the value could be set (the return value from "markSet").
If the string could not be converted into an integer, an InvalidArgument is thrown.
See Also
bool Option::set(std::string v)

Returns
Whether the new value could be set
Exceptions
InvalidArgument

If the value could not be converted into an integer

Implements Option.

5.62.3.17

void Option::setDescription ( const std::string & desc ) [inherited]

Sets the description of what this option does.


The description stored in myDescription is returned.
Returns
The description of this options purpose
The documentation for this class was generated from the following file:
src/sumo/include/utils/options/Option.h

5.63

Option_IntVector Class Reference

Inheritance diagram for Option_IntVector:

Option
Option_IntVector

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

126

Class Documentation

Public Member Functions


Option_IntVector ()
Constructor for an option with no default value.

Option_IntVector (const IntVector &value)


Constructor for an option with a default value.

Option_IntVector (const Option_IntVector &s)


Copy constructor.

virtual Option_IntVector ()
Destructor.

Option_IntVector & operator= (const Option_IntVector &s)


Assignment operator.

const IntVector & getIntVector () const


Returns the stored integer vector.

bool set (const std::string &v)


Stores the given value after parsing it into a vector of integers.

std::string getValueString () const


Returns the string-representation of the value.

bool isSet () const


returns the information whether this options holds a valid value

void unSet ()
marks this option as unset

virtual SUMOReal getFloat () const


Returns the stored SUMOReal value.

virtual int getInt () const


Returns the stored integer value.

virtual std::string getString () const


Returns the stored string value.

virtual bool getBool () const


Returns the stored boolean value.

virtual bool isBool () const


Returns the information whether the option is a bool option.

virtual bool isDefault () const


Returns the information whether the option holds the default value.

virtual bool isFileName () const


Returns the information whether this option is a file name.

bool isWriteable () const


Returns the information whether the option may be set a further time.

void resetWritable ()
Resets the option to be writeable.

const std::string & getDescription () const


Returns the description of what this option does.

void setDescription (const std::string &desc)


Sets the description of what this option does.

virtual const std::string & getTypeName () const


Returns the mml-type name of this option.

Protected Member Functions


bool markSet ()
Marks the information as set.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.63 Option_IntVector Class Reference

127

Protected Attributes
std::string myTypeName
A type name for this option (has presets, but may be overwritten)

5.63.1

Constructor & Destructor Documentation

5.63.1.1

Option_IntVector::Option_IntVector ( const IntVector & value )

Constructor for an option with a default value.


Parameters
value

in

This options default value

5.63.2

Member Function Documentation

5.63.2.1

virtual bool Option::getBool ( ) const [virtual], [inherited]

Returns the stored boolean value.


Option_Bool returns the stored boolean in this methods reimplementation. All other option classes do not override
this method which throws an InvalidArgument-exception.
Returns
Returns the stored boolean if being an instance of Option_Bool
Exceptions
InvalidArgument

If the class is not an instance of Option_Bool

Reimplemented in Option_Bool.

5.63.2.2

const std::string& Option::getDescription ( ) const [inherited]

Returns the description of what this option does.


The description stored in myDescription is returned.
Returns
The description of this options purpose

5.63.2.3

virtual SUMOReal Option::getFloat ( ) const [virtual], [inherited]

Returns the stored SUMOReal value.


Option_Float returns the stored real number in this methods reimplementation. All other option classes do not
override this method which throws an InvalidArgument-exception.
Returns
Returns the stored real number if being an instance of Option_Float

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

128

Class Documentation

Exceptions
InvalidArgument

If the class is not an instance of Option_Float

Reimplemented in Option_Float.

5.63.2.4

virtual int Option::getInt ( ) const [virtual], [inherited]

Returns the stored integer value.


Option_Integer returns the stored integer number in this methods reimplementation. All other option classesdo not
override this method which throws an InvalidArgument-exception.
Returns
Returns the stored integer number if being an instance of Option_Integer
Exceptions
InvalidArgument

If the class is not an instance of Option_Integer

Reimplemented in Option_Integer.

5.63.2.5

const IntVector& Option_IntVector::getIntVector ( ) const [virtual]

Returns the stored integer vector.


See Also
const IntVector &Option::getIntVector()

Returns
Returns the stored integer vector
Reimplemented from Option.

5.63.2.6

virtual std::string Option::getString ( ) const [virtual], [inherited]

Returns the stored string value.


Option_String and Option_FileName return the stored string in this methods reimplementation. All other option
classes do not override this method which throws an InvalidArgument-exception.
Returns
Returns the stored string if being an instance of Option_String
Exceptions
InvalidArgument

If the class is not an instance of Option_String

Reimplemented in Option_String.

5.63.2.7

virtual const std::string& Option::getTypeName ( ) const [virtual], [inherited]

Returns the mml-type name of this option.


The type name stored in myTypeName is returned.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.63 Option_IntVector Class Reference


Returns
The man-readable type name

5.63.2.8

std::string Option_IntVector::getValueString ( ) const [virtual]

Returns the string-representation of the value.


The stored value is encoded into a string and returned.
See Also
std::string Option::getValueString()
Returns
The stored value encoded into a string
Implements Option.

5.63.2.9

virtual bool Option::isBool ( ) const [virtual], [inherited]

Returns the information whether the option is a bool option.


Returns false. Only Option_Bool overrides this method returning true.
Returns
true if the Option is an Option_Bool, false otherwise
Reimplemented in Option_Bool.

5.63.2.10

virtual bool Option::isDefault ( ) const [virtual], [inherited]

Returns the information whether the option holds the default value.
Returns
true if the option was not set from command line / configuration, false otherwise

5.63.2.11

virtual bool Option::isFileName ( ) const [virtual], [inherited]

Returns the information whether this option is a file name.


Returns false. Only Option_FileName overrides this method returning true.
Returns
true if the Option is an Option_FileName, false otherwise
Reimplemented in Option_FileName.

5.63.2.12

bool Option::isSet ( ) const [inherited]

returns the information whether this options holds a valid value


Returns
Whether a value has been set

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

129

130

Class Documentation

5.63.2.13

bool Option::isWriteable ( ) const [inherited]

Returns the information whether the option may be set a further time.
This method returns whether the option was not already set using command line options / configuration. This is
done by returning the value of myAmWritable.
Returns
Whether the option may be set from the command line / configuration

5.63.2.14

bool Option::markSet ( ) [protected], [inherited]

Marks the information as set.


Sets the "myAmSet" - information. Returns whether the option was writeable before.
Returns
Whether the option was not set before.

5.63.2.15

void Option::resetWritable ( ) [inherited]

Resets the option to be writeable.


An option is writable after initialisation, but as soon as it gets set, it is no longer writeable. This method resets the
writable-flag.

5.63.2.16

bool Option_IntVector::set ( const std::string & v ) [virtual]

Stores the given value after parsing it into a vector of integers.


The value is converted into a vector of integers and stored in "myValue". Then, "markSet" is called in order to know
that a value has been set.
The method returns whether the value could be set (the return value from "markSet").
If the string could not be converted into a vector of integers, an InvalidArgument is thrown.
See Also
bool Option::set(std::string v)

Returns
Whether the new value could be set
Exceptions
InvalidArgument

If the value could not be converted into a vector of integers

Implements Option.

5.63.2.17

void Option::setDescription ( const std::string & desc ) [inherited]

Sets the description of what this option does.


The description stored in myDescription is returned.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.64 Option_String Class Reference

131

Returns
The description of this options purpose
The documentation for this class was generated from the following file:
src/sumo/include/utils/options/Option.h

5.64

Option_String Class Reference

Inheritance diagram for Option_String:

Option
Option_String
Option_FileName

Public Member Functions


Option_String ()
Constructor for an option with no default value.

Option_String (const std::string &value, std::string typeName="STR")


Constructor for an option with a default value.

Option_String (const Option_String &s)


Copy constructor.

virtual Option_String ()
Destructor.

Option_String & operator= (const Option_String &s)


Assignment operator.

std::string getString () const


Returns the stored string value.

bool set (const std::string &v)


Stores the given value.

std::string getValueString () const


Returns the string-representation of the value.

bool isSet () const


returns the information whether this options holds a valid value

void unSet ()
marks this option as unset

virtual SUMOReal getFloat () const


Returns the stored SUMOReal value.

virtual int getInt () const


Returns the stored integer value.

virtual bool getBool () const


Returns the stored boolean value.

virtual const IntVector & getIntVector () const


Returns the stored integer vector.

virtual bool isBool () const


Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

132

Class Documentation

Returns the information whether the option is a bool option.

virtual bool isDefault () const


Returns the information whether the option holds the default value.

virtual bool isFileName () const


Returns the information whether this option is a file name.

bool isWriteable () const


Returns the information whether the option may be set a further time.

void resetWritable ()
Resets the option to be writeable.

const std::string & getDescription () const


Returns the description of what this option does.

void setDescription (const std::string &desc)


Sets the description of what this option does.

virtual const std::string & getTypeName () const


Returns the mml-type name of this option.

Protected Member Functions


bool markSet ()
Marks the information as set.

Protected Attributes
std::string myValue
the value, valid only when the base-classes "myAmSet"-member is true

std::string myTypeName
A type name for this option (has presets, but may be overwritten)

5.64.1

Constructor & Destructor Documentation

5.64.1.1

Option_String::Option_String ( )

Constructor for an option with no default value.


Calls Option(false)

5.64.1.2

Option_String::Option_String ( const std::string & value, std::string typeName = "STR" )

Constructor for an option with a default value.


Calls Option(true)
Parameters

in

value

This options default value

5.64.2

Member Function Documentation

5.64.2.1

virtual bool Option::getBool ( ) const [virtual], [inherited]

Returns the stored boolean value.


Option_Bool returns the stored boolean in this methods reimplementation. All other option classes do not override
this method which throws an InvalidArgument-exception.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.64 Option_String Class Reference

133

Returns
Returns the stored boolean if being an instance of Option_Bool
Exceptions
InvalidArgument

If the class is not an instance of Option_Bool

Reimplemented in Option_Bool.

5.64.2.2

const std::string& Option::getDescription ( ) const [inherited]

Returns the description of what this option does.


The description stored in myDescription is returned.
Returns
The description of this options purpose

5.64.2.3

virtual SUMOReal Option::getFloat ( ) const [virtual], [inherited]

Returns the stored SUMOReal value.


Option_Float returns the stored real number in this methods reimplementation. All other option classes do not
override this method which throws an InvalidArgument-exception.
Returns
Returns the stored real number if being an instance of Option_Float
Exceptions
InvalidArgument

If the class is not an instance of Option_Float

Reimplemented in Option_Float.

5.64.2.4

virtual int Option::getInt ( ) const [virtual], [inherited]

Returns the stored integer value.


Option_Integer returns the stored integer number in this methods reimplementation. All other option classesdo not
override this method which throws an InvalidArgument-exception.
Returns
Returns the stored integer number if being an instance of Option_Integer
Exceptions
InvalidArgument

If the class is not an instance of Option_Integer

Reimplemented in Option_Integer.

5.64.2.5

virtual const IntVector& Option::getIntVector ( ) const [virtual], [inherited]

Returns the stored integer vector.


Option_IntVector returns the stored integer vector in this methods reimplementation. All other option classes do not
override this method which throws an InvalidArgument-exception.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

134

Class Documentation

Returns
Returns the stored integer vector if being an instance of Option_IntVector
Exceptions
InvalidArgument

If the class is not an instance of Option_IntVector

Reimplemented in Option_IntVector.

5.64.2.6

std::string Option_String::getString ( ) const [virtual]

Returns the stored string value.


See Also
std::string Option::getString()
Returns
Returns the stored string
Reimplemented from Option.

5.64.2.7

virtual const std::string& Option::getTypeName ( ) const [virtual], [inherited]

Returns the mml-type name of this option.


The type name stored in myTypeName is returned.
Returns
The man-readable type name

5.64.2.8

std::string Option_String::getValueString ( ) const [virtual]

Returns the string-representation of the value.


The stored value is encoded into a string and returned.
See Also
std::string Option::getValueString()
Returns
The stored value encoded into a string
Implements Option.

5.64.2.9

virtual bool Option::isBool ( ) const [virtual], [inherited]

Returns the information whether the option is a bool option.


Returns false. Only Option_Bool overrides this method returning true.
Returns
true if the Option is an Option_Bool, false otherwise
Reimplemented in Option_Bool.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.64 Option_String Class Reference

5.64.2.10

135

virtual bool Option::isDefault ( ) const [virtual], [inherited]

Returns the information whether the option holds the default value.
Returns
true if the option was not set from command line / configuration, false otherwise

5.64.2.11

virtual bool Option::isFileName ( ) const [virtual], [inherited]

Returns the information whether this option is a file name.


Returns false. Only Option_FileName overrides this method returning true.
Returns
true if the Option is an Option_FileName, false otherwise
Reimplemented in Option_FileName.

5.64.2.12

bool Option::isSet ( ) const [inherited]

returns the information whether this options holds a valid value


Returns
Whether a value has been set

5.64.2.13

bool Option::isWriteable ( ) const [inherited]

Returns the information whether the option may be set a further time.
This method returns whether the option was not already set using command line options / configuration. This is
done by returning the value of myAmWritable.
Returns
Whether the option may be set from the command line / configuration

5.64.2.14

bool Option::markSet ( ) [protected], [inherited]

Marks the information as set.


Sets the "myAmSet" - information. Returns whether the option was writeable before.
Returns
Whether the option was not set before.

5.64.2.15

void Option::resetWritable ( ) [inherited]

Resets the option to be writeable.


An option is writable after initialisation, but as soon as it gets set, it is no longer writeable. This method resets the
writable-flag.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

136

Class Documentation

5.64.2.16

bool Option_String::set ( const std::string & v ) [virtual]

Stores the given value.


The value is stored in "myValue". Then, "markSet" is called in order to know that a value has been set.
The method returns whether the value could be set (the return value from "markSet").
See Also
bool Option::set(std::string v)

Returns
Whether the new value could be set
Implements Option.

5.64.2.17

void Option::setDescription ( const std::string & desc ) [inherited]

Sets the description of what this option does.


The description stored in myDescription is returned.
Returns
The description of this options purpose
The documentation for this class was generated from the following file:
src/sumo/include/utils/options/Option.h

5.65

Options Class Reference

Public Member Functions

int Parse (int argc, char argv)


void Print ()
int Parse (int argc, char argv)
void Print ()
int Parse (int argc, char argv)
void Print ()

Public Attributes

long port
long bitLength
double runTime
int numPeriods
std::string ip
std::string tgFile
std::string outputFile
std::string interface
std::string parent
std::string handle
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.66 OptionsCont Class Reference

std::string profile
bool isRouter
bool useTBF
uint64_t buffer
uint64_t bucket

The documentation for this class was generated from the following files:
src/pnp2/include/pnp2/Client.hpp
src/pnp2/include/pnp2/Server.hpp
src/pnp2/include/pnp2/tcWrapper.hpp

5.66

OptionsCont Class Reference

A storage for options typed value containers)

#include <OptionsCont.h>

Public Member Functions


OptionsCont ()
Constructor.

OptionsCont ()
Destructor.

void resetWritable ()
Resets all options to be writeable.

void clear ()
Removes all information from the container.

bool processMetaOptions (bool missingOptions)


Checks for help and configuration output, returns whether we should exit.

const std::vector< std::string > & getSubTopics () const


return the list of subtopics

std::vector< std::string > getSubTopicsEntries (const std::string &subtopic) const


return the list of entries for the given subtopic

std::string getTypeName (const std::string name)


return the type name for the given option

const std::string & getFullName () const


Methods setting and getting information about the appplication and currently set options
void setApplicationName (const std::string &appName, const std::string &fullName)
Sets the application name.

void setApplicationDescription (const std::string &appDesc)


Sets the application description.

void addCallExample (const std::string &example, const std::string &desc)


Add a call example.

void setAdditionalHelpMessage (const std::string &add)


Sets an additional message to be printed at the begin of the help screen.

void addCopyrightNotice (const std::string &copyrightLine)


Adds a copyright notice to the help output.

void clearCopyrightNotices ()
Removes all copyright information.

void addOptionSubTopic (const std::string &topic)


Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

137

138

Class Documentation

Adds an option subtopic.

void printHelp (std::ostream &os)


Prints the help.

void writeConfiguration (std::ostream &os, bool filled, bool complete, bool addComments) const
Writes the configuration.

void writeSchema (std::ostream &os, bool addComments)


Writes the xml schema for the configuration.

void writeXMLHeader (std::ostream &os)


Writes a standard XML header, including the configuration.

Methods for registering options


void doRegister (const std::string &name, Option v)
Adds an option under the given name.

void doRegister (const std::string &name, char abbr, Option v)


Adds an option under the given name and the given abbreviation.

void addSynonyme (const std::string &name1, const std::string &name2, bool isDeprecated=false)
Adds a synonyme for an options name (any order)

void addDescription (const std::string &name, const std::string &subtopic, const std::string &description)
Adds a description for an option.

Methods for retrieving information about options


bool exists (const std::string &name) const
Returns the information whether the named option is known.

bool isSet (const std::string &name, bool failOnNonExistant=true) const


Returns the information whether the named option is set.

void unSet (const std::string &name, bool failOnNonExistant=true) const


Marks the option as unset.

bool isDefault (const std::string &name) const


Returns the information whether the named option has still the default value.

bool isBool (const std::string &name) const


Returns the information whether the option is a boolean option.

bool isUsableFileList (const std::string &name) const


Checks whether the named option is usable as a file list (with at least a single file)

bool checkDependingSuboptions (const std::string &name, const std::string &prefix) const


Checks whether an option is set, which has options with a prefix depending on it.

void relocateFiles (const std::string &configuration) const


Modifies file name options according to the configuration path.

std::vector< std::string > getSynonymes (const std::string &name) const


Returns the synonymes of an option name.

bool isWriteable (const std::string &name)


Returns the information whether the named option may be set.

Methods for retrieving values from options


std::string getString (const std::string &name) const
Returns the string-value of the named option (only for Option_String)

SUMOReal getFloat (const std::string &name) const


Returns the SUMOReal-value of the named option (only for Option_Float)

int getInt (const std::string &name) const


Returns the int-value of the named option (only for Option_Integer)

bool getBool (const std::string &name) const


Returns the boolean-value of the named option (only for Option_Bool)

const IntVector & getIntVector (const std::string &name) const


Returns the list of integer-value of the named option (only for Option_IntVector)

std::vector< std::string > getStringVector (const std::string &name) const


Returns the list of string-vector-value of the named option (only for Option_String)

bool isInStringVector (const std::string &optionName, const std::string &itemName)


Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.66 OptionsCont Class Reference

139

Returns the named option is a list of string values containing the specified item.

Methods for setting values into options


bool set (const std::string &name, const std::string &value)
Sets the given value for the named option.

Static Public Member Functions


static OptionsCont & getOptions ()
Retrieves the options.

Friends
std::ostream & operator<< (std::ostream &os, const OptionsCont &oc)
Output operator.

5.66.1

Detailed Description

A storage for options typed value containers)


This container stores options (typed value containers) by their names. In the case of command line tools, this
container is the main interface between a users definitions about what to do (command line options, configuration
files) and the application.
At the begin, the application should initialise the container. Because the OptionsCont is also responsible for printing
the help screen, one should name and describe the application, first. This means that the first usage of this container
should look similar to this:
OptionsCont &oc = OptionsCont::getOptions();
// give some application descriptions
oc.setApplicationDescription(<ONE_LINE_DESCRIPTION>);
oc.setApplicationName(<APPLICATION_NAME>, "SUMO <APPLICATION_NAME> Version " + (string)
VERSION_STRING);

See Also
setApplicationDescription
setApplicationName
Then, you may also add some example calls using addCallExample.
See Also
addCallExample
In the next step, option subtopics are registered. This is needed for the help screen and for writing the templates/saving configurations. A subtopic is added using addOptionSubTopic(<SUBTOPIC_NAME>).
See Also
addOptionSubTopic
After this, you may add options to the container. This is done using doRegister. This method requires a long name
for the option and the value container. The value container must be an instance of one of the classes derived from
"Option". Do not use Option itself! This is a base class which is meant to supply a default behaviour, but this default
behaviour throws exceptions only!
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

140

Class Documentation

See Also
Option
doRegister
addSynonyme
Once stored inside this container, options will not be visible to the world and are deleted by the container. Only
values and stati of the options may be returned. While accessing the options, the programmer must assure that he
asks for the right value (only Option_Bool is able to return a boolean value, other option types will throw exceptions).
Further, options added to the container must not be deleted outside this container (the container becomes the
owner).
For being printed in the help screen, a description together with the subtopic the option belongs to must be given to
OptionsCont. This is done using addDescription(<OPTION_NAME>, <SUBTOPIC>, <DESCRIPTION>).
See Also
addDescription

http://sumo.dlr.de/wiki/index.php/OptionsSubSystem

5.66.2

Member Function Documentation

5.66.2.1

void OptionsCont::addCallExample ( const std::string & example, const std::string & desc )

Add a call example.


Parameters
example
desc

in
in

5.66.2.2

A call example (without the app name)


A verbose description

void OptionsCont::addCopyrightNotice ( const std::string & copyrightLine )

Adds a copyright notice to the help output.


Parameters
copyrightLine

in

5.66.2.3

The line to put out as a copyright notice

void OptionsCont::addDescription ( const std::string & name, const std::string & subtopic, const std::string &
description )

Adds a description for an option.


Tries to retrieve the named option and to set the given description. Adds the name to the list of option names to be
located in the named subtopic.
Throws an InvalidArgument if the option is not known or already has a description set.
Parameters

in
in
in

name
subtopic
description

The options name


The subtopic to locate the description within
The description

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.66 OptionsCont Class Reference

141

Exceptions
InvalidArgument

5.66.2.4

If none of the synonymes or both synonymes with different options were registered
before

void OptionsCont::addOptionSubTopic ( const std::string & topic )

Adds an option subtopic.


Sub-topics are used to join several options into one thematic field. They are used on writing the help screen and
the configuration. They have no further meaning besides making the outputs better readable.
Parameters
topic

in

5.66.2.5

The options sub topic

void OptionsCont::addSynonyme ( const std::string & name1, const std::string & name2, bool isDeprecated =

false )
Adds a synonyme for an options name (any order)
Tries to find one of the synonymes. If both are known and the option differs for both, an InvalidArgument exception
is thrown. If none is known, also.
If one of the synonymes is known and the other not, the option from the known one is made accessible by the other.
In the case both synonymes are known and have the same option assigned, nothing is done.
Parameters
name1
name2
isDeprecated

in
in
in

The first synonyme


The second synonyme
whether the synonyme is considered deprecated

Exceptions
InvalidArgument

5.66.2.6

If none of the synonymes or both synonymes with different options were registered
before

bool OptionsCont::checkDependingSuboptions ( const std::string & name, const std::string & prefix ) const

Checks whether an option is set, which has options with a prefix depending on it.
The method returns true, if the named option is set or no option dependoing on it is set. Throws an InvalidArgument
exception if the option is not known.
Parameters

in
in

name
prefix

The name of the option to check


The prefix of depending options

Returns
Whether the dependencies are fulfilled

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

142

Class Documentation

Exceptions
InvalidArgument

5.66.2.7

If the option does not exist

void OptionsCont::doRegister ( const std::string & name, Option v )

Adds an option under the given name.


Parameters
name
v

in
in

The (long) name of the option


The option (typed value storage)

Exceptions
InvalidArgument

5.66.2.8

If the name is already used

void OptionsCont::doRegister ( const std::string & name, char abbr, Option v )

Adds an option under the given name and the given abbreviation.
Adds the option under both names using void doRegister(const std::string &name, Option v);
Parameters
name
abbr
v

in
in
in

The (long) name of the option


The (short) name of the option
The option (typed value storage)

Exceptions
InvalidArgument

5.66.2.9

If one of the names is already used

bool OptionsCont::exists ( const std::string & name ) const

Returns the information whether the named option is known.


Returns
true if an option has been added before under the given name, false otherwise

5.66.2.10

bool OptionsCont::getBool ( const std::string & name ) const

Returns the boolean-value of the named option (only for Option_Bool)


This method returns the boolean-value of an existing boolean-option. If the named option does not exist or is not a
boolean-option, an InvalidArgument is thrown.
Parameters

in

name

The name of the option to return the boolean-value of

Returns
The boolean-value of the named, existing boolean-option

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.66 OptionsCont Class Reference

143

Exceptions
InvalidArgument

5.66.2.11

If the option does not exist or is not a boolean-option

SUMOReal OptionsCont::getFloat ( const std::string & name ) const

Returns the SUMOReal-value of the named option (only for Option_Float)


This method returns the SUMOReal-value of an existing SUMOReal-option. If the named option does not exist or
is not a SUMOReal-option, an InvalidArgument is thrown.
Parameters
name

in

The name of the option to return the SUMOReal-value of

Returns
The SUMOReal-value of the named, existing SUMOReal-option
Exceptions
InvalidArgument

5.66.2.12

If the option does not exist or is not a SUMOReal-option

int OptionsCont::getInt ( const std::string & name ) const

Returns the int-value of the named option (only for Option_Integer)


This method returns the int-value of an existing int-option. If the named option does not exist or is not a int-option,
an InvalidArgument is thrown.
Parameters
name

in

The name of the option to return the int-value of

Returns
The int-value of the named, existing int-option
Exceptions
InvalidArgument

5.66.2.13

If the option does not exist or is not a int-option

const IntVector& OptionsCont::getIntVector ( const std::string & name ) const

Returns the list of integer-value of the named option (only for Option_IntVector)
This method returns the int-vector-value of an existing int-vector-option. If the named option does not exist or is not
a int-vector-option, an InvalidArgument is thrown.
Parameters

in

name

The name of the option to return the int-vector-value of

Returns
The int-vector-value of the named, existing int-vector-option

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

144

Class Documentation

Exceptions
InvalidArgument

5.66.2.14

If the option does not exist or is not a int-vector-option

std::string OptionsCont::getString ( const std::string & name ) const

Returns the string-value of the named option (only for Option_String)


This method returns the string-value of an existing string-option. If the named option does not exist or is not a
string-option, an InvalidArgument is thrown.
Parameters
name

in

The name of the option to return the string-value of

Returns
The string-value of the named, existing string-option
Exceptions
InvalidArgument

5.66.2.15

If the option does not exist or is not a string-option

std::vector<std::string> OptionsCont::getStringVector ( const std::string & name ) const

Returns the list of string-vector-value of the named option (only for Option_String)
This method returns the string-vector-value of an existing string-option. If the named option does not exist or is not
a string-option, an InvalidArgument is thrown.
The string-value is determined, first. If the legacy-divider ; is found within the string, a warning is generated. The
retrieved string is splitted at , and ;.
Parameters
name

in

The name of the option to return the string-vector-value of

Returns
The string-vector-value of the named, existing string-option
Exceptions
InvalidArgument

If the option does not exist or is not a string-option

Todo Is it possible to retrieve a const-reference of the string?


See Also
getString()

5.66.2.16

std::vector<std::string> OptionsCont::getSynonymes ( const std::string & name ) const

Returns the synonymes of an option name.


The named option is extracted, first. An InvalidArgument is thrown if it does not exist. Otherwise, other names for
the named option are searched and returned (the original name is not in the list).

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.66 OptionsCont Class Reference

145

Parameters
name

in

The name of the option to return synonymes of

Returns
List of existing synonymes
Exceptions
InvalidArgument

5.66.2.17

If the named option does not exist

bool OptionsCont::isBool ( const std::string & name ) const

Returns the information whether the option is a boolean option.


The option is retrieved from the container, first, what may cause an InvalidArgument exception if it is not known.
Otherwise, this options isBool-method is called.
Parameters

in

name

The name of the option to check

Returns
Whether the existing named option is a bool option
Exceptions
InvalidArgument

5.66.2.18

If the option does not exist

bool OptionsCont::isDefault ( const std::string & name ) const

Returns the information whether the named option has still the default value.
The named option is tried to be retrieved from the container. If it does not exist, an InvalidArgument is thrown. If it
could be retrieved, the information whether the option still has the default value is returned.
An option "is default" if no value has been set from the command line / the configuration file.
Returns
true if the option still has the default value
Exceptions
InvalidArgument

5.66.2.19

If the named option is not known

bool OptionsCont::isInStringVector ( const std::string & optionName, const std::string & itemName )

Returns the named option is a list of string values containing the specified item.
If the named option is not set, false is returned. Otherwise, the string-vector of this option is retrieved using getStringVector what may throw an InvalidArgument exception if the named option is not a string option or not existing
at all.
The given itemName is searched in the obtained string-vector and the method returns whether it is stored in the list
or not.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

146

Class Documentation

Parameters
optionName
itemName

in
in

The name of the option to evaluate entries of


The item to be searched for in the entries of the named option

Returns
Whether the named item is set in the named string-option
Exceptions
InvalidArgument

If the option does not exist or is not a string-option

See Also
getStringVector()
Todo Try to optimize - at each call, the vector is rebuilt

5.66.2.20

bool OptionsCont::isSet ( const std::string & name, bool failOnNonExistant = true ) const

Returns the information whether the named option is set.


The named option is tried to be retrieved from the container. If it does not exist, an InvalidArgument is thrown. If it
could be retrieved, the information whether the option has a value stored is returned.
An option "is set" if a default value was supplied or a value has been set from the command line / the configuration
file.
Parameters

in
in

name
failOnNonExistant

The name of the option to check


Whether asking for an unregistered option should trigger an exception

Returns
true if the option has a valid value, false otherwise
Exceptions
InvalidArgument

5.66.2.21

If the named option is not known

bool OptionsCont::isUsableFileList ( const std::string & name ) const

Checks whether the named option is usable as a file list (with at least a single file)
The method returns true, if the named option is set with entries containing names of accessable files.
Throw an InvalidArgument exception if the option is not known. If the option is not set, false is returned. Also, if the
list is empty (conatins delimiters only) or if one of the named files (obtained using getStringVector) does not exist,
false is returned. Additionally, an error is sent to MsgHandler in both cases.
In the case two delimiters were placed in the option value directly after each other, a warning is generated.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.66 OptionsCont Class Reference

147

Parameters
name

in

The name of the option to check

Returns
Whether the option contains names of files which can be accessed (for reading)
Exceptions
InvalidArgument

5.66.2.22

If the option does not exist or is not a string-option

bool OptionsCont::isWriteable ( const std::string & name )

Returns the information whether the named option may be set.


An option is writable after initialisation, but as soon as it gets set, it is no longer writeable. This method returns
whether the named option is writeable. If the named option is not known, an InvalidArgument is thrown.
Parameters
name

in

The name of the option to check

Returns
Whether the value can be set
Exceptions
InvalidArgument

5.66.2.23

If the option does not exist

void OptionsCont::printHelp ( std::ostream & os )

Prints the help.


Parameters
os

in

5.66.2.24

The stream to write the help into

bool OptionsCont::processMetaOptions ( bool missingOptions )

Checks for help and configuration output, returns whether we should exit.
Returns false if no error was detected and the application may be executed (at least from this point of view). If
missingOptions is true, the user is informed that they should be supplied (returns true). Otherwise it is checked
whether help shall be printed what is done if so, returning true. Also, it is checked whether the set options shall be
printed and the configuration template or the current configuration shall be written.
This method throws a ProcessError if the configuration should be saved, but the file is not accessable. An error
message is supplied.
Parameters

in

missingOptions

Whether no options have been given

Returns
Whether the application shall stop

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

148

Class Documentation

Exceptions
ProcessError

5.66.2.25

If the configuration file could not be saved

void OptionsCont::relocateFiles ( const std::string & configuration ) const

Modifies file name options according to the configuration path.


If the configuration path given is a relative one all filenames inside are adapted such that they refer to the correct
location.
Parameters
configuration

in

5.66.2.26

The path to the configuration file

void OptionsCont::resetWritable ( )

Resets all options to be writeable.


An option is writable after initialisation, but as soon as it gets set, it is no longer writeable. This method resets the
writable-flag of all known options.

5.66.2.27

bool OptionsCont::set ( const std::string & name, const std::string & value )

Sets the given value for the named option.


The option is retrieved from the container, first, what yields in a InvalidArgument exception for not known options.
If the option is not writable (was set before), an error is generated using reportDoubleSetting, and false is returned.
Otherwise, the option is told to set the given value using Option::set. Possible problems herein are caught and
reported to the error-handler, yielding in returning false.
If the new value could be set, true is returned.
Parameters

in
in

name
value

The name of the option to set


The value to set

Returns
Whether the value could be set
Exceptions
InvalidArgument

If the option does not exist

See Also
reportDoubleSetting
Option::set(const std::string &)

5.66.2.28

void OptionsCont::setAdditionalHelpMessage ( const std::string & add )

Sets an additional message to be printed at the begin of the help screen.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.66 OptionsCont Class Reference

149

Parameters
example

in

5.66.2.29

Some additional information about how to use the application

void OptionsCont::setApplicationDescription ( const std::string & appDesc )

Sets the application description.


Parameters
appDesc

in

5.66.2.30

A description of the application

void OptionsCont::setApplicationName ( const std::string & appName, const std::string & fullName )

Sets the application name.


Parameters
name
v

in
in

5.66.2.31

The name of the excutable


The name of the executable with version information

void OptionsCont::unSet ( const std::string & name, bool failOnNonExistant = true ) const

Marks the option as unset.


Parameters
name
failOnNonExistant

in
in

5.66.2.32

The name of the option to check


Whether asking for an unregistered option should trigger an exception

void OptionsCont::writeConfiguration ( std::ostream & os, bool filled, bool complete, bool addComments ) const

Writes the configuration.


The configuration is written as XML into the given stream, allowing to reload it on a next run.
Parameters
os
filled
complete
addComments

in
in
in
in

5.66.2.33

The stream to write the configuration into


Whether only set (and not default) options shall be written
Whether all options shall be written
Whether comments (option descriptions) shall be written

void OptionsCont::writeSchema ( std::ostream & os, bool addComments )

Writes the xml schema for the configuration.


The schema for the configuration is written as XML into the given stream, allowing to validate the configuration
against.
Parameters

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

150

Class Documentation
os
addComments

in
in

5.66.2.34

The stream to write the schema into


Whether comments (option descriptions) shall be written

void OptionsCont::writeXMLHeader ( std::ostream & os )

Writes a standard XML header, including the configuration.


The header consists of the xml-declaration with encoding as defined by SUMOSAXAttributes::ENCODING, followed
by a note which contains the current date and time and the application configuration (set values).
Parameters
os

in

The stream to write the header into

5.66.3

Friends And Related Function Documentation

5.66.3.1

std::ostream& operator<< ( std::ostream & os, const OptionsCont & oc ) [friend]

Output operator.
Generates the output used when current option values shall be printed.
Parameters
os
oc

in
in

The stream to write into


The options to print

Returns
The stream to write into
The documentation for this class was generated from the following file:
src/sumo/include/utils/options/OptionsCont.h

5.67

OptionsIO Class Reference

Helping methods for parsing of command line arguments and reading a configuration file.

#include <OptionsIO.h>

Static Public Member Functions


static void getOptions (bool loadConfig, int argc=0, char argv=0)
Parses the command line arguments and loads the configuration optionally.

static void loadConfiguration ()


Loads and parses the configuration.

5.67.1

Detailed Description

Helping methods for parsing of command line arguments and reading a configuration file.
Any errors are reported by throwing a ProcessError exception which contains a description about the failure.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.68 OptionsLoader Class Reference

151

5.67.2

Member Function Documentation

5.67.2.1

static void OptionsIO::getOptions ( bool loadConfig, int argc = 0, char argv = 0 ) [static]

Parses the command line arguments and loads the configuration optionally.
Command line arguments are parsed, first, throwing a ProcessError if something fails. If loadConfig is false, the
method returns after this. Otherwise, options are reset to being writeable and the configuration is loaded using
"loadConfiguration". After this, the options are reset again and the command line arguments are reparsed.
This workflow allows to read the name of a configuration file from command line arguments, first, then to load values
from this configuration file and reset them by other values from the command line.
Parameters
loadConfig
argc
argv

in
in
in

5.67.2.2

Whether the configuration shall be loaded


number of arguments given at the command line
arguments given at the command line

static void OptionsIO::loadConfiguration ( ) [static]

Loads and parses the configuration.


The name of the configuration file is extracted from the global OptionsCont ("configuration-file" is used as the name
of the option to get the name of the configuration).
The documentation for this class was generated from the following file:
src/sumo/include/utils/options/OptionsIO.h

5.68

OptionsLoader Class Reference

A SAX-Handler for loading options.

#include <OptionsLoader.h>
Inheritance diagram for OptionsLoader:

HandlerBase
OptionsLoader

Public Member Functions


OptionsLoader ()
Constructor.

OptionsLoader ()
destructor

bool errorOccured () const


Returns the information whether an error occured.

Handlers for the SAX DocumentHandler interface


virtual void startElement (const XMLCh const name, XERCES_CPP_NAMESPACE::AttributeList &attributes)
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

152

Class Documentation

Called on the occurence of the beginning of a tag.

void characters (const XMLCh const chars, const XERCES3_SIZE_t length)


Called on the occurence of character data.

void endElement (const XMLCh const name)


Called on the end of an element.

Handlers for the SAX ErrorHandler interface


void warning (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
Called on an XML-warning.

void error (const XERCES_CPP_NAMESPACE::SAXParseException &exception)


Called on an XML-error.

void fatalError (const XERCES_CPP_NAMESPACE::SAXParseException &exception)


Called on an XML-fatal error.

5.68.1

Detailed Description

A SAX-Handler for loading options.

5.68.2

Member Function Documentation

5.68.2.1

void OptionsLoader::characters ( const XMLCh const chars, const XERCES3_SIZE_t length )

Called on the occurence of character data.


If this occurs inside a single tag it sets the option named by the tag to the value given by the character data. This is
considered deprecated in favor of attributes.
Todo Describe better

5.68.2.2

void OptionsLoader::endElement ( const XMLCh const name )

Called on the end of an element.


Resets the element name

5.68.2.3

void OptionsLoader::error ( const XERCES_CPP_NAMESPACE::SAXParseException & exception )

Called on an XML-error.
The warning is reported to the the error-instance of MsgHandler

5.68.2.4

void OptionsLoader::fatalError ( const XERCES_CPP_NAMESPACE::SAXParseException & exception )

Called on an XML-fatal error.


The warning is reported to the the error-instance of MsgHandler

5.68.2.5

virtual void OptionsLoader::startElement ( const XMLCh const name, XERCES_CPP_NAMESPACE::AttributeList &


attributes ) [virtual]

Called on the occurence of the beginning of a tag.


Sets the name of the last item
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.69 OptionsParser Class Reference

5.68.2.6

153

void OptionsLoader::warning ( const XERCES_CPP_NAMESPACE::SAXParseException & exception )

Called on an XML-warning.
The warning is reported to the the warning-instance of MsgHandler
The documentation for this class was generated from the following file:
src/sumo/include/utils/options/OptionsLoader.h

5.69

OptionsParser Class Reference

Parses command line arguments.

#include <OptionsParser.h>

Static Public Member Functions


static bool parse (int argc, char argv)
Parses the given command line arguments.

5.69.1

Detailed Description

Parses command line arguments.


The only public method parses the given list of arguments. It returns false when something failed. This may happen
if the syntax of the arguments is invalid, a value is tried to be set several times or an unknown option is tried to be
set.
The class assumes all options are unset or using default values only.

5.69.2

Member Function Documentation

5.69.2.1

static bool OptionsParser::parse ( int argc, char argv ) [static]

Parses the given command line arguments.


Parameters

in
in
in

oc
argc
argv

The options container to fill


The number of given command line arguments
The command line arguments

Returns
Whether the parsing was successfull
Exceptions
InvalidArgument

If a performed setting of an option failed (see Option::set)

The documentation for this class was generated from the following file:
src/sumo/include/utils/options/OptionsParser.h
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

154

Class Documentation

5.70

OutOfBoundsException Class Reference

OutOfBoundsException Thrown when an array element out of the arrays bounderies is accessed.

#include <UtilExceptions.h>
Inheritance diagram for OutOfBoundsException:

runtime_error
OutOfBoundsException

Public Member Functions


OutOfBoundsException ()
constructor

5.70.1

Detailed Description

OutOfBoundsException Thrown when an array element out of the arrays bounderies is accessed.
The documentation for this class was generated from the following file:
src/sumo/include/utils/common/UtilExceptions.h

5.71

OutputDevice Class Reference

Static storage of an output device and its base (abstract) implementation.

#include <OutputDevice.h>
Inheritance diagram for OutputDevice:
OutputDevice
MsgRetrievingFunction< T >

OutputDevice_CERR

OutputDevice_COUT

OutputDevice_File

OutputDevice_Network

OutputDevice_String

Static Public Member Functions


static std::string realString (const SUMOReal v, const int precision=OUTPUT_ACCURACY)
Helper method for string formatting.

static access methods to OutputDevices


static OutputDevice & getDevice (const std::string &name)
Returns the described OutputDevice.

static bool createDeviceByOption (const std::string &optionName, const std::string &rootElement="", const
std::string &schemaFile="")
Creates the device using the output definition stored in the named option.

static OutputDevice & getDeviceByOption (const std::string &name)


Returns the device described by the option.

static void closeAll ()


Closes all registered devices.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.71 OutputDevice Class Reference

155

OutputDevice member methods


OutputDevice (const bool binary=false, const unsigned int defaultIndentation=0)
Constructor.

virtual OutputDevice ()
Destructor.

virtual bool ok ()
returns the information whether one can write into the device

void close ()
Closes the device and removes it from the dictionary.

void setPrecision (unsigned int precision=OUTPUT_ACCURACY)


Sets the precison or resets it to default.

bool writeXMLHeader (const std::string &rootElement, const std::string &attrs="", const std::string &comment="")
Writes an XML header with optional configuration.

template<typename E >
bool writeHeader (const SumoXMLTag &rootElement)
OutputDevice & openTag (const std::string &xmlElement)
Opens an XML tag.

OutputDevice & openTag (const SumoXMLTag &xmlElement)


Opens an XML tag.

bool closeTag ()
Closes the most recently opened tag.

void lf ()
writes a line feed if applicable

bool isBinary () const


Returns whether we have a binary output.

template<typename T >
OutputDevice & writeAttr (const SumoXMLAttr attr, const T &val)
writes a named attribute

template<typename T >
OutputDevice & writeAttr (const std::string &attr, const T &val)
writes an arbitrary attribute

OutputDevice & writeNonEmptyAttr (const SumoXMLAttr attr, const std::string &val)


writes a string attribute only if it is not the empty string and not the string "default"

OutputDevice & writePreformattedTag (const std::string &val)


writes a preformatted tag to the device but ensures that any pending tags are closed

void inform (const std::string &msg, const char progress=0)


Retrieves a message to this device.

template<class T >
OutputDevice & operator<< (const T &t)
Abstract output operator.

OutputDevice (const OutputDevice &)


Invalidated copy constructor.

virtual std::ostream & getOStream ()=0


Returns the associated ostream.

virtual void postWriteHook ()


Called after every write access.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

156

Class Documentation

5.71.1

Detailed Description

Static storage of an output device and its base (abstract) implementation.


OutputDevices are basically a capsule around an std::ostream, which give a unified access to sockets, files and
stdout.
Usually, an application builds as many output devices as needed. Each output device may also be used to save
outputs from several sources (several detectors, for example). Building is done using OutputDevice::getDevice()
what also parses the given output description in order to decide what kind of an OutputDevice shall be built. OutputDevices are closed via OutputDevice::closeAll(), normally called at the applications end.
Although everything that can be written to a stream can also be written to an OutputDevice, there is special support
for XML tags (remembering all open tags to close them at the end). OutputDevices are still lacking support for
function pointers with the << operator (no endl, use
). The most important method to implement in subclasses is getOStream, the most used part of the interface is the
<< operator.
The Boolean markers are used rarely and might get removed in future versions.

5.71.2

Member Function Documentation

5.71.2.1

bool OutputDevice::closeTag ( )

Closes the most recently opened tag.


The topmost xml-element from the stack is written into the stream as a closing element. Depending on the formatter
used this may be something like "</" + element + ">" or "/>" or nothing at all.
Returns
Whether a further element existed in the stack and could be closed
Todo it is not verified that the topmost element was closed

5.71.2.2

static bool OutputDevice::createDeviceByOption ( const std::string & optionName, const std::string & rootElement =

"", const std::string & schemaFile = "" ) [static]


Creates the device using the output definition stored in the named option.
Creates and returns the device named by the option. Asks whether the option and retrieves the name from the
option if so. Optionally the XML header gets written as well. Returns whether a device was created (option was
set).
Please note, that we do not have to consider the "application base" herein, because this call is only used to get file
names of files referenced within XML-declarations of structures which paths already is aware of the cwd.
Parameters

in
in
in

optionName
rootElement
schemaFile

The name of the option to use for retrieving the output definition
The root element to use (XML-output)
The basename of the schema file to use (XML-output)

Returns
Whether a device was built (the option was set)

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.71 OutputDevice Class Reference

157

Exceptions
IOError

5.71.2.3

If the output could not be built for any reason (error message is supplied)

static OutputDevice& OutputDevice::getDevice ( const std::string & name ) [static]

Returns the described OutputDevice.


Creates and returns the named device. "stdout" and "stderr" refer to the relevant console streams, "hostname:port"
initiates socket connection. Otherwise a filename is assumed (where "nul" and "/dev/null" do what you would expect
on both platforms). If there already is a device with the same name this one is returned.
Parameters
name

in

The description of the output name/port/whatever

Returns
The corresponding (built or existing) device
Exceptions
IOError

5.71.2.4

If the output could not be built for any reason (error message is supplied)

static OutputDevice& OutputDevice::getDeviceByOption ( const std::string & name ) [static]

Returns the device described by the option.


Returns the device named by the option. If the option is unknown, unset or the device was not created before,
InvalidArgument is thrown.
Please note, that we do not have to consider the "application base" herein.
Parameters
name

in

The name of the option to use for retrieving the output definition

Returns
The corresponding (built or existing) device
Exceptions
IOError
InvalidArgument

5.71.2.5

If the output could not be built for any reason (error message is supplied)
If the option with the given name does not exist

void OutputDevice::inform ( const std::string & msg, const char progress = 0 )

Retrieves a message to this device.


Implementation of the MessageRetriever interface. Writes the given message to the output device.
Parameters

in

5.71.2.6

msg

The msg to write to the device

bool OutputDevice::isBinary ( ) const [inline]

Returns whether we have a binary output.


Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

158

Class Documentation

Returns
whether we have a binary output

5.71.2.7

virtual bool OutputDevice::ok ( ) [virtual]

returns the information whether one can write into the device
Returns
Whether the device can be used (stream is good)

5.71.2.8 OutputDevice& OutputDevice::openTag ( const std::string & xmlElement )


Opens an XML tag.
An indentation, depending on the current xml-element-stack size, is written followed by the given xml element ("<"
+ xmlElement) The xml element is added to the stack, then.
Parameters
xmlElement

in

Name of element to open

Returns
The OutputDevice for further processing

5.71.2.9 OutputDevice& OutputDevice::openTag ( const SumoXMLTag & xmlElement )


Opens an XML tag.
Helper method which finds the correct string before calling openTag.
Parameters

in

xmlElement

Id of the element to open

Returns
The OutputDevice for further processing

5.71.2.10

template<class T > OutputDevice& OutputDevice::operator<< ( const T & t ) [inline]

Abstract output operator.


Returns
The OutputDevice for further processing

5.71.2.11

virtual void OutputDevice::postWriteHook ( ) [protected], [virtual]

Called after every write access.


Default implementation does nothing.
Reimplemented in OutputDevice_Network, MsgRetrievingFunction< T >, OutputDevice_CERR, and OutputDevice_COUT.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.71 OutputDevice Class Reference

5.71.2.12

static std::string OutputDevice::realString ( const SUMOReal v, const int precision = OUTPUT_ACCURACY )

[static]
Helper method for string formatting.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

159

160

Class Documentation

Parameters
v
precision

in
in

The floating point value to be formatted


the precision to achieve

Returns
The formatted string

5.71.2.13

void OutputDevice::setPrecision ( unsigned int precision = OUTPUT_ACCURACY )

Sets the precison or resets it to default.


Parameters
precision

in

5.71.2.14

The accuracy (number of digits behind .) to set

template<typename T > OutputDevice& OutputDevice::writeAttr ( const SumoXMLAttr attr, const T & val )
[inline]

writes a named attribute


Parameters
attr
val

in
in

The attribute (name)


The attribute value

Returns
The OutputDevice for further processing

5.71.2.15

template<typename T > OutputDevice& OutputDevice::writeAttr ( const std::string & attr, const T & val )
[inline]

writes an arbitrary attribute


Parameters
attr
val

in
in

The attribute (name)


The attribute value

Returns
The OutputDevice for further processing

5.71.2.16 OutputDevice& OutputDevice::writeNonEmptyAttr ( const SumoXMLAttr attr, const std::string & val )

[inline]
writes a string attribute only if it is not the empty string and not the string "default"
Parameters

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.72 OutputDevice_CERR Class Reference


attr
val

in
in

161

The attribute (name)


The attribute value

Returns
The OutputDevice for further processing

5.71.2.17 OutputDevice& OutputDevice::writePreformattedTag ( const std::string & val ) [inline]


writes a preformatted tag to the device but ensures that any pending tags are closed
Parameters
val

in

The preformatted data

Returns
The OutputDevice for further processing

5.71.2.18

bool OutputDevice::writeXMLHeader ( const std::string & rootElement, const std::string & attrs = "", const
std::string & comment = "" )

Writes an XML header with optional configuration.


If something has been written (myXMLStack is not empty), nothing is written and false returned.
Parameters

in
in
in

rootElement
attrs
comment

The root element to use


Additional attributes to save within the rootElement
Additional comment (saved in front the rootElement)

Returns
Whether the header could be written (stack was empty)
Todo Check which parameter is used herein
Describe what is saved
The documentation for this class was generated from the following file:
src/sumo/include/utils/iodevices/OutputDevice.h

5.72

OutputDevice_CERR Class Reference

An output device that encapsulates cerr.

#include <OutputDevice_CERR.h>
Inheritance diagram for OutputDevice_CERR:

OutputDevice
OutputDevice_CERR

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

162

Class Documentation

Public Member Functions


OutputDevice member methods
virtual bool ok ()
returns the information whether one can write into the device

void close ()
Closes the device and removes it from the dictionary.

void setPrecision (unsigned int precision=OUTPUT_ACCURACY)


Sets the precison or resets it to default.

bool writeXMLHeader (const std::string &rootElement, const std::string &attrs="", const std::string &comment="")
Writes an XML header with optional configuration.

template<typename E >
bool writeHeader (const SumoXMLTag &rootElement)
OutputDevice & openTag (const std::string &xmlElement)
Opens an XML tag.

OutputDevice & openTag (const SumoXMLTag &xmlElement)


Opens an XML tag.

bool closeTag ()
Closes the most recently opened tag.

void lf ()
writes a line feed if applicable

bool isBinary () const


Returns whether we have a binary output.

template<typename T >
OutputDevice & writeAttr (const SumoXMLAttr attr, const T &val)
writes a named attribute

template<typename T >
OutputDevice & writeAttr (const std::string &attr, const T &val)
writes an arbitrary attribute

OutputDevice & writeNonEmptyAttr (const SumoXMLAttr attr, const std::string &val)


writes a string attribute only if it is not the empty string and not the string "default"

OutputDevice & writePreformattedTag (const std::string &val)


writes a preformatted tag to the device but ensures that any pending tags are closed

void inform (const std::string &msg, const char progress=0)


Retrieves a message to this device.

template<class T >
OutputDevice & operator<< (const T &t)
Abstract output operator.

Static Public Member Functions


static OutputDevice getDevice ()
Returns the single cerr instance.

static std::string realString (const SUMOReal v, const int precision=OUTPUT_ACCURACY)


Helper method for string formatting.

static access methods to OutputDevices


static OutputDevice & getDevice (const std::string &name)
Returns the described OutputDevice.

static bool createDeviceByOption (const std::string &optionName, const std::string &rootElement="", const
std::string &schemaFile="")
Creates the device using the output definition stored in the named option.

static OutputDevice & getDeviceByOption (const std::string &name)


Returns the device described by the option.

static void closeAll ()


Closes all registered devices.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.72 OutputDevice_CERR Class Reference

163

Protected Member Functions


Methods that override/implement OutputDevice-methods
std::ostream & getOStream ()
Returns the associated ostream.

virtual void postWriteHook ()


Called after every write access.

5.72.1

Detailed Description

An output device that encapsulates cerr.

5.72.2

Member Function Documentation

5.72.2.1

bool OutputDevice::closeTag ( ) [inherited]

Closes the most recently opened tag.


The topmost xml-element from the stack is written into the stream as a closing element. Depending on the formatter
used this may be something like "</" + element + ">" or "/>" or nothing at all.
Returns
Whether a further element existed in the stack and could be closed
Todo it is not verified that the topmost element was closed

5.72.2.2

static bool OutputDevice::createDeviceByOption ( const std::string & optionName, const std::string & rootElement =

"", const std::string & schemaFile = "" ) [static], [inherited]


Creates the device using the output definition stored in the named option.
Creates and returns the device named by the option. Asks whether the option and retrieves the name from the
option if so. Optionally the XML header gets written as well. Returns whether a device was created (option was
set).
Please note, that we do not have to consider the "application base" herein, because this call is only used to get file
names of files referenced within XML-declarations of structures which paths already is aware of the cwd.
Parameters
optionName
rootElement
schemaFile

in
in
in

The name of the option to use for retrieving the output definition
The root element to use (XML-output)
The basename of the schema file to use (XML-output)

Returns
Whether a device was built (the option was set)
Exceptions
IOError

5.72.2.3

If the output could not be built for any reason (error message is supplied)

static OutputDevice OutputDevice_CERR::getDevice ( ) [static]

Returns the single cerr instance.


Creates and returns the cerr device.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

164

Class Documentation

5.72.2.4

static OutputDevice& OutputDevice::getDevice ( const std::string & name ) [static], [inherited]

Returns the described OutputDevice.


Creates and returns the named device. "stdout" and "stderr" refer to the relevant console streams, "hostname:port"
initiates socket connection. Otherwise a filename is assumed (where "nul" and "/dev/null" do what you would expect
on both platforms). If there already is a device with the same name this one is returned.
Parameters
name

in

The description of the output name/port/whatever

Returns
The corresponding (built or existing) device
Exceptions
IOError

5.72.2.5

If the output could not be built for any reason (error message is supplied)

static OutputDevice& OutputDevice::getDeviceByOption ( const std::string & name ) [static],

[inherited]
Returns the device described by the option.
Returns the device named by the option. If the option is unknown, unset or the device was not created before,
InvalidArgument is thrown.
Please note, that we do not have to consider the "application base" herein.
Parameters
name

in

The name of the option to use for retrieving the output definition

Returns
The corresponding (built or existing) device
Exceptions
IOError
InvalidArgument

5.72.2.6

If the output could not be built for any reason (error message is supplied)
If the option with the given name does not exist

std::ostream& OutputDevice_CERR::getOStream ( ) [protected], [virtual]

Returns the associated ostream.


Returns
cerr
Implements OutputDevice.

5.72.2.7

void OutputDevice::inform ( const std::string & msg, const char progress = 0 ) [inherited]

Retrieves a message to this device.


Implementation of the MessageRetriever interface. Writes the given message to the output device.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.72 OutputDevice_CERR Class Reference

165

Parameters
msg

in

5.72.2.8

The msg to write to the device

bool OutputDevice::isBinary ( ) const [inline], [inherited]

Returns whether we have a binary output.


Returns
whether we have a binary output

5.72.2.9

virtual bool OutputDevice::ok ( ) [virtual], [inherited]

returns the information whether one can write into the device
Returns
Whether the device can be used (stream is good)

5.72.2.10 OutputDevice& OutputDevice::openTag ( const std::string & xmlElement ) [inherited]


Opens an XML tag.
An indentation, depending on the current xml-element-stack size, is written followed by the given xml element ("<"
+ xmlElement) The xml element is added to the stack, then.
Parameters
xmlElement

in

Name of element to open

Returns
The OutputDevice for further processing

5.72.2.11 OutputDevice& OutputDevice::openTag ( const SumoXMLTag & xmlElement ) [inherited]


Opens an XML tag.
Helper method which finds the correct string before calling openTag.
Parameters

in

xmlElement

Id of the element to open

Returns
The OutputDevice for further processing

5.72.2.12

template<class T > OutputDevice& OutputDevice::operator<< ( const T & t ) [inline],


[inherited]

Abstract output operator.


Returns
The OutputDevice for further processing

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

166

Class Documentation

5.72.2.13

virtual void OutputDevice_CERR::postWriteHook ( ) [protected], [virtual]

Called after every write access.


Calls flush on stderr.
Reimplemented from OutputDevice.

5.72.2.14

static std::string OutputDevice::realString ( const SUMOReal v, const int precision = OUTPUT_ACCURACY )

[static], [inherited]
Helper method for string formatting.
Parameters
v
precision

in
in

The floating point value to be formatted


the precision to achieve

Returns
The formatted string

5.72.2.15

void OutputDevice::setPrecision ( unsigned int precision = OUTPUT_ACCURACY ) [inherited]

Sets the precison or resets it to default.


Parameters
precision

in

5.72.2.16

The accuracy (number of digits behind .) to set

template<typename T > OutputDevice& OutputDevice::writeAttr ( const SumoXMLAttr attr, const T & val )
[inline], [inherited]

writes a named attribute


Parameters
attr
val

in
in

The attribute (name)


The attribute value

Returns
The OutputDevice for further processing

5.72.2.17

template<typename T > OutputDevice& OutputDevice::writeAttr ( const std::string & attr, const T & val )
[inline], [inherited]

writes an arbitrary attribute


Parameters

in
in

attr
val

The attribute (name)


The attribute value

Returns
The OutputDevice for further processing

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.72 OutputDevice_CERR Class Reference

5.72.2.18 OutputDevice& OutputDevice::writeNonEmptyAttr ( const SumoXMLAttr attr, const std::string & val )
[inline], [inherited]
writes a string attribute only if it is not the empty string and not the string "default"

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

167

168

Class Documentation

Parameters
attr
val

in
in

The attribute (name)


The attribute value

Returns
The OutputDevice for further processing

5.72.2.19 OutputDevice& OutputDevice::writePreformattedTag ( const std::string & val ) [inline], [inherited]


writes a preformatted tag to the device but ensures that any pending tags are closed
Parameters
val

in

The preformatted data

Returns
The OutputDevice for further processing

5.72.2.20

bool OutputDevice::writeXMLHeader ( const std::string & rootElement, const std::string & attrs = "", const
std::string & comment = "" ) [inherited]

Writes an XML header with optional configuration.


If something has been written (myXMLStack is not empty), nothing is written and false returned.
Parameters

in
in
in

rootElement
attrs
comment

The root element to use


Additional attributes to save within the rootElement
Additional comment (saved in front the rootElement)

Returns
Whether the header could be written (stack was empty)
Todo Check which parameter is used herein
Describe what is saved
The documentation for this class was generated from the following file:
src/sumo/include/utils/iodevices/OutputDevice_CERR.h

5.73

OutputDevice_COUT Class Reference

An output device that encapsulates cout.

#include <OutputDevice_COUT.h>
Inheritance diagram for OutputDevice_COUT:

OutputDevice
OutputDevice_COUT

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.73 OutputDevice_COUT Class Reference

169

Public Member Functions


OutputDevice member methods
virtual bool ok ()
returns the information whether one can write into the device

void close ()
Closes the device and removes it from the dictionary.

void setPrecision (unsigned int precision=OUTPUT_ACCURACY)


Sets the precison or resets it to default.

bool writeXMLHeader (const std::string &rootElement, const std::string &attrs="", const std::string &comment="")
Writes an XML header with optional configuration.

template<typename E >
bool writeHeader (const SumoXMLTag &rootElement)
OutputDevice & openTag (const std::string &xmlElement)
Opens an XML tag.

OutputDevice & openTag (const SumoXMLTag &xmlElement)


Opens an XML tag.

bool closeTag ()
Closes the most recently opened tag.

void lf ()
writes a line feed if applicable

bool isBinary () const


Returns whether we have a binary output.

template<typename T >
OutputDevice & writeAttr (const SumoXMLAttr attr, const T &val)
writes a named attribute

template<typename T >
OutputDevice & writeAttr (const std::string &attr, const T &val)
writes an arbitrary attribute

OutputDevice & writeNonEmptyAttr (const SumoXMLAttr attr, const std::string &val)


writes a string attribute only if it is not the empty string and not the string "default"

OutputDevice & writePreformattedTag (const std::string &val)


writes a preformatted tag to the device but ensures that any pending tags are closed

void inform (const std::string &msg, const char progress=0)


Retrieves a message to this device.

template<class T >
OutputDevice & operator<< (const T &t)
Abstract output operator.

Static Public Member Functions


static OutputDevice getDevice ()
Returns the single cout instance.

static std::string realString (const SUMOReal v, const int precision=OUTPUT_ACCURACY)


Helper method for string formatting.

static access methods to OutputDevices


static OutputDevice & getDevice (const std::string &name)
Returns the described OutputDevice.

static bool createDeviceByOption (const std::string &optionName, const std::string &rootElement="", const
std::string &schemaFile="")
Creates the device using the output definition stored in the named option.

static OutputDevice & getDeviceByOption (const std::string &name)


Returns the device described by the option.

static void closeAll ()


Closes all registered devices.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

170

Class Documentation

Protected Member Functions


Methods that override/implement OutputDevice-methods
std::ostream & getOStream ()
Returns the associated ostream.

virtual void postWriteHook ()


Called after every write access.

5.73.1

Detailed Description

An output device that encapsulates cout.

5.73.2

Member Function Documentation

5.73.2.1

bool OutputDevice::closeTag ( ) [inherited]

Closes the most recently opened tag.


The topmost xml-element from the stack is written into the stream as a closing element. Depending on the formatter
used this may be something like "</" + element + ">" or "/>" or nothing at all.
Returns
Whether a further element existed in the stack and could be closed
Todo it is not verified that the topmost element was closed

5.73.2.2

static bool OutputDevice::createDeviceByOption ( const std::string & optionName, const std::string & rootElement =

"", const std::string & schemaFile = "" ) [static], [inherited]


Creates the device using the output definition stored in the named option.
Creates and returns the device named by the option. Asks whether the option and retrieves the name from the
option if so. Optionally the XML header gets written as well. Returns whether a device was created (option was
set).
Please note, that we do not have to consider the "application base" herein, because this call is only used to get file
names of files referenced within XML-declarations of structures which paths already is aware of the cwd.
Parameters
optionName
rootElement
schemaFile

in
in
in

The name of the option to use for retrieving the output definition
The root element to use (XML-output)
The basename of the schema file to use (XML-output)

Returns
Whether a device was built (the option was set)
Exceptions
IOError

5.73.2.3

If the output could not be built for any reason (error message is supplied)

static OutputDevice OutputDevice_COUT::getDevice ( ) [static]

Returns the single cout instance.


Creates and returns the cout device.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.73 OutputDevice_COUT Class Reference

5.73.2.4

171

static OutputDevice& OutputDevice::getDevice ( const std::string & name ) [static], [inherited]

Returns the described OutputDevice.


Creates and returns the named device. "stdout" and "stderr" refer to the relevant console streams, "hostname:port"
initiates socket connection. Otherwise a filename is assumed (where "nul" and "/dev/null" do what you would expect
on both platforms). If there already is a device with the same name this one is returned.
Parameters
name

in

The description of the output name/port/whatever

Returns
The corresponding (built or existing) device
Exceptions
IOError

5.73.2.5

If the output could not be built for any reason (error message is supplied)

static OutputDevice& OutputDevice::getDeviceByOption ( const std::string & name ) [static],

[inherited]
Returns the device described by the option.
Returns the device named by the option. If the option is unknown, unset or the device was not created before,
InvalidArgument is thrown.
Please note, that we do not have to consider the "application base" herein.
Parameters
name

in

The name of the option to use for retrieving the output definition

Returns
The corresponding (built or existing) device
Exceptions
IOError
InvalidArgument

5.73.2.6

If the output could not be built for any reason (error message is supplied)
If the option with the given name does not exist

std::ostream& OutputDevice_COUT::getOStream ( ) [protected], [virtual]

Returns the associated ostream.


Returns
cout
Implements OutputDevice.

5.73.2.7

void OutputDevice::inform ( const std::string & msg, const char progress = 0 ) [inherited]

Retrieves a message to this device.


Implementation of the MessageRetriever interface. Writes the given message to the output device.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

172

Class Documentation

Parameters
msg

in

5.73.2.8

The msg to write to the device

bool OutputDevice::isBinary ( ) const [inline], [inherited]

Returns whether we have a binary output.


Returns
whether we have a binary output

5.73.2.9

virtual bool OutputDevice::ok ( ) [virtual], [inherited]

returns the information whether one can write into the device
Returns
Whether the device can be used (stream is good)

5.73.2.10 OutputDevice& OutputDevice::openTag ( const std::string & xmlElement ) [inherited]


Opens an XML tag.
An indentation, depending on the current xml-element-stack size, is written followed by the given xml element ("<"
+ xmlElement) The xml element is added to the stack, then.
Parameters
xmlElement

in

Name of element to open

Returns
The OutputDevice for further processing

5.73.2.11 OutputDevice& OutputDevice::openTag ( const SumoXMLTag & xmlElement ) [inherited]


Opens an XML tag.
Helper method which finds the correct string before calling openTag.
Parameters

in

xmlElement

Id of the element to open

Returns
The OutputDevice for further processing

5.73.2.12

template<class T > OutputDevice& OutputDevice::operator<< ( const T & t ) [inline],


[inherited]

Abstract output operator.


Returns
The OutputDevice for further processing

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.73 OutputDevice_COUT Class Reference

5.73.2.13

173

virtual void OutputDevice_COUT::postWriteHook ( ) [protected], [virtual]

Called after every write access.


Calls flush on stdout.
Reimplemented from OutputDevice.

5.73.2.14

static std::string OutputDevice::realString ( const SUMOReal v, const int precision = OUTPUT_ACCURACY )

[static], [inherited]
Helper method for string formatting.
Parameters
v
precision

in
in

The floating point value to be formatted


the precision to achieve

Returns
The formatted string

5.73.2.15

void OutputDevice::setPrecision ( unsigned int precision = OUTPUT_ACCURACY ) [inherited]

Sets the precison or resets it to default.


Parameters
precision

in

5.73.2.16

The accuracy (number of digits behind .) to set

template<typename T > OutputDevice& OutputDevice::writeAttr ( const SumoXMLAttr attr, const T & val )
[inline], [inherited]

writes a named attribute


Parameters
attr
val

in
in

The attribute (name)


The attribute value

Returns
The OutputDevice for further processing

5.73.2.17

template<typename T > OutputDevice& OutputDevice::writeAttr ( const std::string & attr, const T & val )
[inline], [inherited]

writes an arbitrary attribute


Parameters

in
in

attr
val

The attribute (name)


The attribute value

Returns
The OutputDevice for further processing

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

174

Class Documentation

5.73.2.18 OutputDevice& OutputDevice::writeNonEmptyAttr ( const SumoXMLAttr attr, const std::string & val )
[inline], [inherited]
writes a string attribute only if it is not the empty string and not the string "default"

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.74 OutputDevice_File Class Reference

175

Parameters
attr
val

in
in

The attribute (name)


The attribute value

Returns
The OutputDevice for further processing

5.73.2.19 OutputDevice& OutputDevice::writePreformattedTag ( const std::string & val ) [inline], [inherited]


writes a preformatted tag to the device but ensures that any pending tags are closed
Parameters
val

in

The preformatted data

Returns
The OutputDevice for further processing

5.73.2.20

bool OutputDevice::writeXMLHeader ( const std::string & rootElement, const std::string & attrs = "", const
std::string & comment = "" ) [inherited]

Writes an XML header with optional configuration.


If something has been written (myXMLStack is not empty), nothing is written and false returned.
Parameters

in
in
in

rootElement
attrs
comment

The root element to use


Additional attributes to save within the rootElement
Additional comment (saved in front the rootElement)

Returns
Whether the header could be written (stack was empty)
Todo Check which parameter is used herein
Describe what is saved
The documentation for this class was generated from the following file:
src/sumo/include/utils/iodevices/OutputDevice_COUT.h

5.74

OutputDevice_File Class Reference

An output device that encapsulates an ofstream.

#include <OutputDevice_File.h>
Inheritance diagram for OutputDevice_File:

OutputDevice
OutputDevice_File

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

176

Class Documentation

Public Member Functions


OutputDevice_File (const std::string &fullName, const bool binary)
Constructor.

OutputDevice_File ()
Destructor.

Static Public Member Functions


static std::string realString (const SUMOReal v, const int precision=OUTPUT_ACCURACY)
Helper method for string formatting.

static access methods to OutputDevices


static OutputDevice & getDevice (const std::string &name)
Returns the described OutputDevice.

static bool createDeviceByOption (const std::string &optionName, const std::string &rootElement="", const
std::string &schemaFile="")
Creates the device using the output definition stored in the named option.

static OutputDevice & getDeviceByOption (const std::string &name)


Returns the device described by the option.

static void closeAll ()


Closes all registered devices.

Protected Member Functions


Methods that override/implement OutputDevice-methods
std::ostream & getOStream ()
Returns the associated ostream.

OutputDevice member methods


virtual bool ok ()
returns the information whether one can write into the device

void close ()
Closes the device and removes it from the dictionary.

void setPrecision (unsigned int precision=OUTPUT_ACCURACY)


Sets the precison or resets it to default.

bool writeXMLHeader (const std::string &rootElement, const std::string &attrs="", const std::string &comment="")
Writes an XML header with optional configuration.

template<typename E >
bool writeHeader (const SumoXMLTag &rootElement)
OutputDevice & openTag (const std::string &xmlElement)
Opens an XML tag.

OutputDevice & openTag (const SumoXMLTag &xmlElement)


Opens an XML tag.

bool closeTag ()
Closes the most recently opened tag.

void lf ()
writes a line feed if applicable

bool isBinary () const


Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.74 OutputDevice_File Class Reference

177

Returns whether we have a binary output.

template<typename T >
OutputDevice & writeAttr (const SumoXMLAttr attr, const T &val)
writes a named attribute

template<typename T >
OutputDevice & writeAttr (const std::string &attr, const T &val)
writes an arbitrary attribute

OutputDevice & writeNonEmptyAttr (const SumoXMLAttr attr, const std::string &val)


writes a string attribute only if it is not the empty string and not the string "default"

OutputDevice & writePreformattedTag (const std::string &val)


writes a preformatted tag to the device but ensures that any pending tags are closed

void inform (const std::string &msg, const char progress=0)


Retrieves a message to this device.

template<class T >
OutputDevice & operator<< (const T &t)
Abstract output operator.

virtual void postWriteHook ()


Called after every write access.

5.74.1

Detailed Description

An output device that encapsulates an ofstream.


Please note that the device gots responsible for the stream and deletes it (it should not be deleted elsewhere).

5.74.2

Constructor & Destructor Documentation

5.74.2.1

OutputDevice_File::OutputDevice_File ( const std::string & fullName, const bool binary )

Constructor.
Parameters
strm

in

The output stream to used

Exceptions
IOError

Should not be thrown by this implementation

5.74.3

Member Function Documentation

5.74.3.1

bool OutputDevice::closeTag ( ) [inherited]

Closes the most recently opened tag.


The topmost xml-element from the stack is written into the stream as a closing element. Depending on the formatter
used this may be something like "</" + element + ">" or "/>" or nothing at all.
Returns
Whether a further element existed in the stack and could be closed
Todo it is not verified that the topmost element was closed

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

178

Class Documentation

5.74.3.2

static bool OutputDevice::createDeviceByOption ( const std::string & optionName, const std::string & rootElement =

"", const std::string & schemaFile = "" ) [static], [inherited]


Creates the device using the output definition stored in the named option.
Creates and returns the device named by the option. Asks whether the option and retrieves the name from the
option if so. Optionally the XML header gets written as well. Returns whether a device was created (option was
set).
Please note, that we do not have to consider the "application base" herein, because this call is only used to get file
names of files referenced within XML-declarations of structures which paths already is aware of the cwd.
Parameters
optionName
rootElement
schemaFile

in
in
in

The name of the option to use for retrieving the output definition
The root element to use (XML-output)
The basename of the schema file to use (XML-output)

Returns
Whether a device was built (the option was set)
Exceptions
IOError

5.74.3.3

If the output could not be built for any reason (error message is supplied)

static OutputDevice& OutputDevice::getDevice ( const std::string & name ) [static], [inherited]

Returns the described OutputDevice.


Creates and returns the named device. "stdout" and "stderr" refer to the relevant console streams, "hostname:port"
initiates socket connection. Otherwise a filename is assumed (where "nul" and "/dev/null" do what you would expect
on both platforms). If there already is a device with the same name this one is returned.
Parameters
name

in

The description of the output name/port/whatever

Returns
The corresponding (built or existing) device
Exceptions
IOError

5.74.3.4

If the output could not be built for any reason (error message is supplied)

static OutputDevice& OutputDevice::getDeviceByOption ( const std::string & name ) [static],

[inherited]
Returns the device described by the option.
Returns the device named by the option. If the option is unknown, unset or the device was not created before,
InvalidArgument is thrown.
Please note, that we do not have to consider the "application base" herein.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.74 OutputDevice_File Class Reference

179

Parameters
name

in

The name of the option to use for retrieving the output definition

Returns
The corresponding (built or existing) device
Exceptions
IOError
InvalidArgument

5.74.3.5

If the output could not be built for any reason (error message is supplied)
If the option with the given name does not exist

std::ostream& OutputDevice_File::getOStream ( ) [protected], [virtual]

Returns the associated ostream.


Returns
The used stream
Implements OutputDevice.

5.74.3.6

void OutputDevice::inform ( const std::string & msg, const char progress = 0 ) [inherited]

Retrieves a message to this device.


Implementation of the MessageRetriever interface. Writes the given message to the output device.
Parameters
msg

in

5.74.3.7

The msg to write to the device

bool OutputDevice::isBinary ( ) const [inline], [inherited]

Returns whether we have a binary output.


Returns
whether we have a binary output

5.74.3.8

virtual bool OutputDevice::ok ( ) [virtual], [inherited]

returns the information whether one can write into the device
Returns
Whether the device can be used (stream is good)

5.74.3.9 OutputDevice& OutputDevice::openTag ( const std::string & xmlElement ) [inherited]


Opens an XML tag.
An indentation, depending on the current xml-element-stack size, is written followed by the given xml element ("<"
+ xmlElement) The xml element is added to the stack, then.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

180

Class Documentation

Parameters
xmlElement

in

Name of element to open

Returns
The OutputDevice for further processing

5.74.3.10 OutputDevice& OutputDevice::openTag ( const SumoXMLTag & xmlElement ) [inherited]


Opens an XML tag.
Helper method which finds the correct string before calling openTag.
Parameters
xmlElement

in

Id of the element to open

Returns
The OutputDevice for further processing

5.74.3.11

template<class T > OutputDevice& OutputDevice::operator<< ( const T & t ) [inline],


[inherited]

Abstract output operator.


Returns
The OutputDevice for further processing

5.74.3.12

virtual void OutputDevice::postWriteHook ( ) [protected], [virtual], [inherited]

Called after every write access.


Default implementation does nothing.
Reimplemented in OutputDevice_Network, MsgRetrievingFunction< T >, OutputDevice_CERR, and OutputDevice_COUT.

5.74.3.13

static std::string OutputDevice::realString ( const SUMOReal v, const int precision = OUTPUT_ACCURACY )

[static], [inherited]
Helper method for string formatting.
Parameters

in
in

v
precision

The floating point value to be formatted


the precision to achieve

Returns
The formatted string

5.74.3.14

void OutputDevice::setPrecision ( unsigned int precision = OUTPUT_ACCURACY ) [inherited]

Sets the precison or resets it to default.


Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.74 OutputDevice_File Class Reference

181

Parameters
precision

in

5.74.3.15

The accuracy (number of digits behind .) to set

template<typename T > OutputDevice& OutputDevice::writeAttr ( const SumoXMLAttr attr, const T & val )
[inline], [inherited]

writes a named attribute


Parameters
attr
val

in
in

The attribute (name)


The attribute value

Returns
The OutputDevice for further processing

5.74.3.16

template<typename T > OutputDevice& OutputDevice::writeAttr ( const std::string & attr, const T & val )
[inline], [inherited]

writes an arbitrary attribute


Parameters

in
in

attr
val

The attribute (name)


The attribute value

Returns
The OutputDevice for further processing

5.74.3.17 OutputDevice& OutputDevice::writeNonEmptyAttr ( const SumoXMLAttr attr, const std::string & val )
[inline], [inherited]
writes a string attribute only if it is not the empty string and not the string "default"
Parameters

in
in

attr
val

The attribute (name)


The attribute value

Returns
The OutputDevice for further processing

5.74.3.18 OutputDevice& OutputDevice::writePreformattedTag ( const std::string & val ) [inline], [inherited]


writes a preformatted tag to the device but ensures that any pending tags are closed
Parameters

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

182

Class Documentation

val

in

The preformatted data

Returns
The OutputDevice for further processing

5.74.3.19

bool OutputDevice::writeXMLHeader ( const std::string & rootElement, const std::string & attrs = "", const
std::string & comment = "" ) [inherited]

Writes an XML header with optional configuration.


If something has been written (myXMLStack is not empty), nothing is written and false returned.
Parameters
rootElement
attrs
comment

in
in
in

The root element to use


Additional attributes to save within the rootElement
Additional comment (saved in front the rootElement)

Returns
Whether the header could be written (stack was empty)
Todo Check which parameter is used herein
Describe what is saved
The documentation for this class was generated from the following file:
src/sumo/include/utils/iodevices/OutputDevice_File.h

5.75

OutputDevice_Network Class Reference

An output device for TCP/IP network connections.

#include <OutputDevice_Network.h>
Inheritance diagram for OutputDevice_Network:

OutputDevice
OutputDevice_Network

Public Member Functions


OutputDevice_Network (const std::string &host, const int port)
Constructor.

OutputDevice_Network ()
Destructor.

OutputDevice member methods


virtual bool ok ()
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.75 OutputDevice_Network Class Reference

183

returns the information whether one can write into the device

void close ()
Closes the device and removes it from the dictionary.

void setPrecision (unsigned int precision=OUTPUT_ACCURACY)


Sets the precison or resets it to default.

bool writeXMLHeader (const std::string &rootElement, const std::string &attrs="", const std::string &comment="")
Writes an XML header with optional configuration.

template<typename E >
bool writeHeader (const SumoXMLTag &rootElement)
OutputDevice & openTag (const std::string &xmlElement)
Opens an XML tag.

OutputDevice & openTag (const SumoXMLTag &xmlElement)


Opens an XML tag.

bool closeTag ()
Closes the most recently opened tag.

void lf ()
writes a line feed if applicable

bool isBinary () const


Returns whether we have a binary output.

template<typename T >
OutputDevice & writeAttr (const SumoXMLAttr attr, const T &val)
writes a named attribute

template<typename T >
OutputDevice & writeAttr (const std::string &attr, const T &val)
writes an arbitrary attribute

OutputDevice & writeNonEmptyAttr (const SumoXMLAttr attr, const std::string &val)


writes a string attribute only if it is not the empty string and not the string "default"

OutputDevice & writePreformattedTag (const std::string &val)


writes a preformatted tag to the device but ensures that any pending tags are closed

void inform (const std::string &msg, const char progress=0)


Retrieves a message to this device.

template<class T >
OutputDevice & operator<< (const T &t)
Abstract output operator.

Static Public Member Functions


static std::string realString (const SUMOReal v, const int precision=OUTPUT_ACCURACY)
Helper method for string formatting.

static access methods to OutputDevices


static OutputDevice & getDevice (const std::string &name)
Returns the described OutputDevice.

static bool createDeviceByOption (const std::string &optionName, const std::string &rootElement="", const
std::string &schemaFile="")
Creates the device using the output definition stored in the named option.

static OutputDevice & getDeviceByOption (const std::string &name)


Returns the device described by the option.

static void closeAll ()


Closes all registered devices.

Protected Member Functions


Methods that override/implement OutputDevice-methods
std::ostream & getOStream ()
Returns the associated ostream.

virtual void postWriteHook ()


Sends the data which was written to the string stream over the socket.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

184

Class Documentation

5.75.1

Detailed Description

An output device for TCP/IP network connections.


The implementation uses a portable socket implementation from the Shawn project (shawn.sf.net) located in
src/foreign/tcpip/socket.h. It uses an internal storage for the messages, which is sent via the socket when "postWriteHook" is called.
See Also
postWriteHook

5.75.2

Constructor & Destructor Documentation

5.75.2.1

OutputDevice_Network::OutputDevice_Network ( const std::string & host, const int port )

Constructor.
Parameters
host
port

in
in

The host to connect


The port to connect

Exceptions
IOError

If the connection could not be established

5.75.3

Member Function Documentation

5.75.3.1

bool OutputDevice::closeTag ( ) [inherited]

Closes the most recently opened tag.


The topmost xml-element from the stack is written into the stream as a closing element. Depending on the formatter
used this may be something like "</" + element + ">" or "/>" or nothing at all.
Returns
Whether a further element existed in the stack and could be closed
Todo it is not verified that the topmost element was closed

5.75.3.2

static bool OutputDevice::createDeviceByOption ( const std::string & optionName, const std::string & rootElement =

"", const std::string & schemaFile = "" ) [static], [inherited]


Creates the device using the output definition stored in the named option.
Creates and returns the device named by the option. Asks whether the option and retrieves the name from the
option if so. Optionally the XML header gets written as well. Returns whether a device was created (option was
set).
Please note, that we do not have to consider the "application base" herein, because this call is only used to get file
names of files referenced within XML-declarations of structures which paths already is aware of the cwd.
Parameters

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.75 OutputDevice_Network Class Reference


optionName
rootElement
schemaFile

in
in
in

185

The name of the option to use for retrieving the output definition
The root element to use (XML-output)
The basename of the schema file to use (XML-output)

Returns
Whether a device was built (the option was set)
Exceptions
IOError

5.75.3.3

If the output could not be built for any reason (error message is supplied)

static OutputDevice& OutputDevice::getDevice ( const std::string & name ) [static], [inherited]

Returns the described OutputDevice.


Creates and returns the named device. "stdout" and "stderr" refer to the relevant console streams, "hostname:port"
initiates socket connection. Otherwise a filename is assumed (where "nul" and "/dev/null" do what you would expect
on both platforms). If there already is a device with the same name this one is returned.
Parameters
name

in

The description of the output name/port/whatever

Returns
The corresponding (built or existing) device
Exceptions
IOError

5.75.3.4

If the output could not be built for any reason (error message is supplied)

static OutputDevice& OutputDevice::getDeviceByOption ( const std::string & name ) [static],

[inherited]
Returns the device described by the option.
Returns the device named by the option. If the option is unknown, unset or the device was not created before,
InvalidArgument is thrown.
Please note, that we do not have to consider the "application base" herein.
Parameters
name

in

The name of the option to use for retrieving the output definition

Returns
The corresponding (built or existing) device
Exceptions
IOError
InvalidArgument

5.75.3.5

If the output could not be built for any reason (error message is supplied)
If the option with the given name does not exist

std::ostream& OutputDevice_Network::getOStream ( ) [protected], [virtual]

Returns the associated ostream.


The stream is an ostringstream, actually, into which the message is written. It is sent when postWriteHook is called.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

186

Class Documentation

Returns
The used stream

See Also
postWriteHook
Implements OutputDevice.

5.75.3.6

void OutputDevice::inform ( const std::string & msg, const char progress = 0 ) [inherited]

Retrieves a message to this device.


Implementation of the MessageRetriever interface. Writes the given message to the output device.
Parameters
msg

in

5.75.3.7

The msg to write to the device

bool OutputDevice::isBinary ( ) const [inline], [inherited]

Returns whether we have a binary output.


Returns
whether we have a binary output

5.75.3.8

virtual bool OutputDevice::ok ( ) [virtual], [inherited]

returns the information whether one can write into the device
Returns
Whether the device can be used (stream is good)

5.75.3.9 OutputDevice& OutputDevice::openTag ( const std::string & xmlElement ) [inherited]


Opens an XML tag.
An indentation, depending on the current xml-element-stack size, is written followed by the given xml element ("<"
+ xmlElement) The xml element is added to the stack, then.
Parameters

in

xmlElement

Name of element to open

Returns
The OutputDevice for further processing

5.75.3.10 OutputDevice& OutputDevice::openTag ( const SumoXMLTag & xmlElement ) [inherited]


Opens an XML tag.
Helper method which finds the correct string before calling openTag.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.75 OutputDevice_Network Class Reference

187

Parameters
xmlElement

in

Id of the element to open

Returns
The OutputDevice for further processing

5.75.3.11

template<class T > OutputDevice& OutputDevice::operator<< ( const T & t ) [inline],


[inherited]

Abstract output operator.


Returns
The OutputDevice for further processing

5.75.3.12

virtual void OutputDevice_Network::postWriteHook ( ) [protected], [virtual]

Sends the data which was written to the string stream over the socket.
Converts the stored message into a vector of chars and sends them via to the socket implementation. Resets the
message, afterwards.
Reimplemented from OutputDevice.

5.75.3.13

static std::string OutputDevice::realString ( const SUMOReal v, const int precision = OUTPUT_ACCURACY )

[static], [inherited]
Helper method for string formatting.
Parameters
v
precision

in
in

The floating point value to be formatted


the precision to achieve

Returns
The formatted string

5.75.3.14

void OutputDevice::setPrecision ( unsigned int precision = OUTPUT_ACCURACY ) [inherited]

Sets the precison or resets it to default.


Parameters
precision

in

5.75.3.15

The accuracy (number of digits behind .) to set

template<typename T > OutputDevice& OutputDevice::writeAttr ( const SumoXMLAttr attr, const T & val )
[inline], [inherited]

writes a named attribute

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

188

Class Documentation

Parameters
attr
val

in
in

The attribute (name)


The attribute value

Returns
The OutputDevice for further processing

5.75.3.16

template<typename T > OutputDevice& OutputDevice::writeAttr ( const std::string & attr, const T & val )
[inline], [inherited]

writes an arbitrary attribute


Parameters
attr
val

in
in

The attribute (name)


The attribute value

Returns
The OutputDevice for further processing

5.75.3.17 OutputDevice& OutputDevice::writeNonEmptyAttr ( const SumoXMLAttr attr, const std::string & val )
[inline], [inherited]
writes a string attribute only if it is not the empty string and not the string "default"
Parameters
attr
val

in
in

The attribute (name)


The attribute value

Returns
The OutputDevice for further processing

5.75.3.18 OutputDevice& OutputDevice::writePreformattedTag ( const std::string & val ) [inline], [inherited]


writes a preformatted tag to the device but ensures that any pending tags are closed
Parameters

in

val

The preformatted data

Returns
The OutputDevice for further processing

5.75.3.19

bool OutputDevice::writeXMLHeader ( const std::string & rootElement, const std::string & attrs = "", const
std::string & comment = "" ) [inherited]

Writes an XML header with optional configuration.


If something has been written (myXMLStack is not empty), nothing is written and false returned.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.76 OutputDevice_String Class Reference

189

Parameters
rootElement
attrs
comment

in
in
in

The root element to use


Additional attributes to save within the rootElement
Additional comment (saved in front the rootElement)

Returns
Whether the header could be written (stack was empty)
Todo Check which parameter is used herein
Describe what is saved
The documentation for this class was generated from the following file:
src/sumo/include/utils/iodevices/OutputDevice_Network.h

5.76

OutputDevice_String Class Reference

An output device that encapsulates an ofstream.

#include <OutputDevice_String.h>
Inheritance diagram for OutputDevice_String:

OutputDevice
OutputDevice_String

Public Member Functions


OutputDevice_String (const bool binary=false, const unsigned int defaultIndentation=0)
Constructor
Exceptions
IOError

Should not be thrown by this implementation.

OutputDevice_String ()
Destructor.

std::string getString ()
Returns the current content as a string.

Static Public Member Functions


static std::string realString (const SUMOReal v, const int precision=OUTPUT_ACCURACY)
Helper method for string formatting.

static access methods to OutputDevices


static OutputDevice & getDevice (const std::string &name)
Returns the described OutputDevice.

static bool createDeviceByOption (const std::string &optionName, const std::string &rootElement="", const
std::string &schemaFile="")
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

190

Class Documentation

Creates the device using the output definition stored in the named option.

static OutputDevice & getDeviceByOption (const std::string &name)


Returns the device described by the option.

static void closeAll ()


Closes all registered devices.

Protected Member Functions


Methods that override/implement OutputDevice-methods
std::ostream & getOStream ()
Returns the associated ostream.

OutputDevice member methods


virtual bool ok ()
returns the information whether one can write into the device

void close ()
Closes the device and removes it from the dictionary.

void setPrecision (unsigned int precision=OUTPUT_ACCURACY)


Sets the precison or resets it to default.

bool writeXMLHeader (const std::string &rootElement, const std::string &attrs="", const std::string &comment="")
Writes an XML header with optional configuration.

template<typename E >
bool writeHeader (const SumoXMLTag &rootElement)
OutputDevice & openTag (const std::string &xmlElement)
Opens an XML tag.

OutputDevice & openTag (const SumoXMLTag &xmlElement)


Opens an XML tag.

bool closeTag ()
Closes the most recently opened tag.

void lf ()
writes a line feed if applicable

bool isBinary () const


Returns whether we have a binary output.

template<typename T >
OutputDevice & writeAttr (const SumoXMLAttr attr, const T &val)
writes a named attribute

template<typename T >
OutputDevice & writeAttr (const std::string &attr, const T &val)
writes an arbitrary attribute

OutputDevice & writeNonEmptyAttr (const SumoXMLAttr attr, const std::string &val)


writes a string attribute only if it is not the empty string and not the string "default"

OutputDevice & writePreformattedTag (const std::string &val)


writes a preformatted tag to the device but ensures that any pending tags are closed

void inform (const std::string &msg, const char progress=0)


Retrieves a message to this device.

template<class T >
OutputDevice & operator<< (const T &t)
Abstract output operator.

virtual void postWriteHook ()


Called after every write access.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.76 OutputDevice_String Class Reference

5.76.1

191

Detailed Description

An output device that encapsulates an ofstream.


Please note that the device gots responsible for the stream and deletes it (it should not be deleted elsewhere).

5.76.2

Member Function Documentation

5.76.2.1

bool OutputDevice::closeTag ( ) [inherited]

Closes the most recently opened tag.


The topmost xml-element from the stack is written into the stream as a closing element. Depending on the formatter
used this may be something like "</" + element + ">" or "/>" or nothing at all.
Returns
Whether a further element existed in the stack and could be closed
Todo it is not verified that the topmost element was closed

5.76.2.2

static bool OutputDevice::createDeviceByOption ( const std::string & optionName, const std::string & rootElement =

"", const std::string & schemaFile = "" ) [static], [inherited]


Creates the device using the output definition stored in the named option.
Creates and returns the device named by the option. Asks whether the option and retrieves the name from the
option if so. Optionally the XML header gets written as well. Returns whether a device was created (option was
set).
Please note, that we do not have to consider the "application base" herein, because this call is only used to get file
names of files referenced within XML-declarations of structures which paths already is aware of the cwd.
Parameters
optionName
rootElement
schemaFile

in
in
in

The name of the option to use for retrieving the output definition
The root element to use (XML-output)
The basename of the schema file to use (XML-output)

Returns
Whether a device was built (the option was set)
Exceptions
IOError

5.76.2.3

If the output could not be built for any reason (error message is supplied)

static OutputDevice& OutputDevice::getDevice ( const std::string & name ) [static], [inherited]

Returns the described OutputDevice.


Creates and returns the named device. "stdout" and "stderr" refer to the relevant console streams, "hostname:port"
initiates socket connection. Otherwise a filename is assumed (where "nul" and "/dev/null" do what you would expect
on both platforms). If there already is a device with the same name this one is returned.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

192

Class Documentation

Parameters
name

in

The description of the output name/port/whatever

Returns
The corresponding (built or existing) device
Exceptions
IOError

5.76.2.4

If the output could not be built for any reason (error message is supplied)

static OutputDevice& OutputDevice::getDeviceByOption ( const std::string & name ) [static],

[inherited]
Returns the device described by the option.
Returns the device named by the option. If the option is unknown, unset or the device was not created before,
InvalidArgument is thrown.
Please note, that we do not have to consider the "application base" herein.
Parameters
name

in

The name of the option to use for retrieving the output definition

Returns
The corresponding (built or existing) device
Exceptions
IOError
InvalidArgument

5.76.2.5

If the output could not be built for any reason (error message is supplied)
If the option with the given name does not exist

std::ostream& OutputDevice_String::getOStream ( ) [protected], [virtual]

Returns the associated ostream.


Returns
The used stream
Implements OutputDevice.

5.76.2.6

std::string OutputDevice_String::getString ( )

Returns the current content as a string.


Returns
The content as string

5.76.2.7

void OutputDevice::inform ( const std::string & msg, const char progress = 0 ) [inherited]

Retrieves a message to this device.


Implementation of the MessageRetriever interface. Writes the given message to the output device.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.76 OutputDevice_String Class Reference

193

Parameters
msg

in

5.76.2.8

The msg to write to the device

bool OutputDevice::isBinary ( ) const [inline], [inherited]

Returns whether we have a binary output.


Returns
whether we have a binary output

5.76.2.9

virtual bool OutputDevice::ok ( ) [virtual], [inherited]

returns the information whether one can write into the device
Returns
Whether the device can be used (stream is good)

5.76.2.10 OutputDevice& OutputDevice::openTag ( const std::string & xmlElement ) [inherited]


Opens an XML tag.
An indentation, depending on the current xml-element-stack size, is written followed by the given xml element ("<"
+ xmlElement) The xml element is added to the stack, then.
Parameters
xmlElement

in

Name of element to open

Returns
The OutputDevice for further processing

5.76.2.11 OutputDevice& OutputDevice::openTag ( const SumoXMLTag & xmlElement ) [inherited]


Opens an XML tag.
Helper method which finds the correct string before calling openTag.
Parameters

in

xmlElement

Id of the element to open

Returns
The OutputDevice for further processing

5.76.2.12

template<class T > OutputDevice& OutputDevice::operator<< ( const T & t ) [inline],


[inherited]

Abstract output operator.


Returns
The OutputDevice for further processing

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

194

Class Documentation

5.76.2.13

virtual void OutputDevice::postWriteHook ( ) [protected], [virtual], [inherited]

Called after every write access.


Default implementation does nothing.
Reimplemented in OutputDevice_Network, MsgRetrievingFunction< T >, OutputDevice_CERR, and OutputDevice_COUT.

5.76.2.14

static std::string OutputDevice::realString ( const SUMOReal v, const int precision = OUTPUT_ACCURACY )

[static], [inherited]
Helper method for string formatting.
Parameters
v
precision

in
in

The floating point value to be formatted


the precision to achieve

Returns
The formatted string

5.76.2.15

void OutputDevice::setPrecision ( unsigned int precision = OUTPUT_ACCURACY ) [inherited]

Sets the precison or resets it to default.


Parameters
precision

in

5.76.2.16

The accuracy (number of digits behind .) to set

template<typename T > OutputDevice& OutputDevice::writeAttr ( const SumoXMLAttr attr, const T & val )
[inline], [inherited]

writes a named attribute


Parameters
attr
val

in
in

The attribute (name)


The attribute value

Returns
The OutputDevice for further processing

5.76.2.17

template<typename T > OutputDevice& OutputDevice::writeAttr ( const std::string & attr, const T & val )
[inline], [inherited]

writes an arbitrary attribute


Parameters

in

attr

The attribute (name)

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.76 OutputDevice_String Class Reference

val

in

195

The attribute value

Returns
The OutputDevice for further processing

5.76.2.18 OutputDevice& OutputDevice::writeNonEmptyAttr ( const SumoXMLAttr attr, const std::string & val )
[inline], [inherited]
writes a string attribute only if it is not the empty string and not the string "default"
Parameters
attr
val

in
in

The attribute (name)


The attribute value

Returns
The OutputDevice for further processing

5.76.2.19 OutputDevice& OutputDevice::writePreformattedTag ( const std::string & val ) [inline], [inherited]


writes a preformatted tag to the device but ensures that any pending tags are closed
Parameters
val

in

The preformatted data

Returns
The OutputDevice for further processing

5.76.2.20

bool OutputDevice::writeXMLHeader ( const std::string & rootElement, const std::string & attrs = "", const
std::string & comment = "" ) [inherited]

Writes an XML header with optional configuration.


If something has been written (myXMLStack is not empty), nothing is written and false returned.
Parameters

in
in
in

rootElement
attrs
comment

The root element to use


Additional attributes to save within the rootElement
Additional comment (saved in front the rootElement)

Returns
Whether the header could be written (stack was empty)
Todo Check which parameter is used herein
Describe what is saved
The documentation for this class was generated from the following file:
src/sumo/include/utils/iodevices/OutputDevice_String.h
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

196

Class Documentation

5.77

OutputFormatter Class Reference

Abstract base class for output formatters.

#include <OutputFormatter.h>
Inheritance diagram for OutputFormatter:

OutputFormatter
BinaryFormatter

PlainXMLFormatter

Public Member Functions


virtual OutputFormatter ()
Destructor.

virtual bool writeXMLHeader (std::ostream &into, const std::string &rootElement, const std::string &attrs="",
const std::string &comment="")=0
Writes an XML header with optional configuration.

virtual void openTag (std::ostream &into, const std::string &xmlElement)=0


Opens an XML tag.

virtual void openTag (std::ostream &into, const SumoXMLTag &xmlElement)=0


Opens an XML tag.

virtual bool closeTag (std::ostream &into)=0


Closes the most recently opened tag.

virtual void writePreformattedTag (std::ostream &into, const std::string &val)=0

5.77.1

Detailed Description

Abstract base class for output formatters.


OutputFormatter format XML like output into the output stream. There are only two implementation at the moment,
"normal" XML and binary XML.

5.77.2

Member Function Documentation

5.77.2.1

virtual bool OutputFormatter::closeTag ( std::ostream & into ) [pure virtual]

Closes the most recently opened tag.


Parameters

in

into

The output stream to use

Returns
Whether a further element existed in the stack and could be closed
Todo it is not verified that the topmost element was closed
Implemented in BinaryFormatter, and PlainXMLFormatter.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.78 Parameterised Class Reference

5.77.2.2

197

virtual void OutputFormatter::openTag ( std::ostream & into, const std::string & xmlElement ) [pure

virtual]
Opens an XML tag.
An indentation, depending on the current xml-element-stack size, is written followed by the given xml element ("<"
+ xmlElement) The xml element is added to the stack, then.
Parameters
into
xmlElement

in
in

The output stream to use


Name of element to open

Returns
The OutputDevice for further processing
Implemented in BinaryFormatter, and PlainXMLFormatter.

5.77.2.3

virtual void OutputFormatter::openTag ( std::ostream & into, const SumoXMLTag & xmlElement ) [pure

virtual]
Opens an XML tag.
Helper method which finds the correct string before calling openTag.
Parameters
into
xmlElement

in
in

The output stream to use


Id of the element to open

Implemented in BinaryFormatter, and PlainXMLFormatter.

5.77.2.4

virtual bool OutputFormatter::writeXMLHeader ( std::ostream & into, const std::string & rootElement, const std::string
& attrs = "", const std::string & comment = "" ) [pure virtual]

Writes an XML header with optional configuration.


If something has been written (myXMLStack is not empty), nothing is written and false returned.
Parameters

in
in
in
in

into
rootElement
attrs
comment

The output stream to use


The root element to use
Additional attributes to save within the rootElement
Additional comment (saved in front the rootElement)

Todo Check which parameter is used herein


Describe what is saved
Implemented in BinaryFormatter, and PlainXMLFormatter.
The documentation for this class was generated from the following file:
src/sumo/include/utils/iodevices/OutputFormatter.h

5.78

Parameterised Class Reference

An upper class for objects with additional parameters.

#include <Parameterised.h>
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

198

Class Documentation

Public Member Functions


Parameterised ()
Constructor.

Parameterised (const std::map< std::string, std::string > &mapArg)


Constructor.

Parameterised ()
Destructor.

void addParameter (const std::string &key, const std::string &value)


Adds a parameter.

void addParameter (const std::map< std::string, std::string > &mapArg)


Adds all given parameter.

void addParameter (const Parameterised &p)


Adds all given parameter.

bool knowsParameter (const std::string &key) const


Returns whether the parameter is known.

const std::string & getParameter (const std::string &key, const std::string &defaultValue) const
Returns the value for a given key.

void clearParameter ()
Clears the parameter map.

const std::map< std::string,


std::string > & getMap () const
Returns the inner key/value map.

5.78.1

Detailed Description

An upper class for objects with additional parameters.

5.78.2

Constructor & Destructor Documentation

5.78.2.1

Parameterised::Parameterised ( const std::map< std::string, std::string > & mapArg )

Constructor.
Parameters
mapArg

in

Pre-given parameter

5.78.3

Member Function Documentation

5.78.3.1

void Parameterised::addParameter ( const std::string & key, const std::string & value )

Adds a parameter.
Parameters
key
value

in
in

5.78.3.2

The parameters name


The parameters value

void Parameterised::addParameter ( const std::map< std::string, std::string > & mapArg )

Adds all given parameter.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.79 rapidxml::parse_error Class Reference


Parameters
mapArg

in

5.78.3.3

The keys/values to insert

void Parameterised::addParameter ( const Parameterised & p )

Adds all given parameter.


Parameters
p

in

The keys/values to insert

const std::map<std::string, std::string>& Parameterised::getMap ( ) const [inline]

5.78.3.4

Returns the inner key/value map.


Returns
the inner map

5.78.3.5

const std::string & Parameterised::getParameter ( const std::string & key, const std::string & defaultValue ) const

Returns the value for a given key.


Parameters
key
defaultValue

in
in

The key to ask for


The default value to return if no value is stored under the key

Returns
The value stored under the key

5.78.3.6

bool Parameterised::knowsParameter ( const std::string & key ) const

Returns whether the parameter is known.


Parameters

in

key

The key to ask for

Returns
Whether the key is known
The documentation for this class was generated from the following files:
src/sumo/include/utils/common/Parameterised.h
src/sumo/src/utils/common/Parameterised.cpp

5.79

rapidxml::parse_error Class Reference

Parse error exception.


Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

199

200

Class Documentation

#include <rapidxml.hpp>
Inheritance diagram for rapidxml::parse_error:

exception
rapidxml::parse_error

Public Member Functions


parse_error (const char what, void where)
Constructs parse error.

virtual const char what () const throw ()


Gets human readable description of error.

template<class Ch >
Ch where () const
Gets pointer to character data where error happened.

5.79.1

Detailed Description

Parse error exception.


This exception is thrown by the parser when an error occurs. Use what() function to get human-readable error
message. Use where() function to get a pointer to position within source text where error was detected.
If throwing exceptions by the parser is undesirable, it can be disabled by defining RAPIDXML_NO_EXCEPTIONS
macro before rapidxml.hpp is included. This will cause the parser to call rapidxml::parse_error_handler() function
instead of throwing an exception. This function must be defined by the user.
This class derives from std::exception class.

5.79.2

Member Function Documentation

5.79.2.1

virtual const char rapidxml::parse_error::what ( ) const throw )

[inline], [virtual]

Gets human readable description of error.


Returns
Pointer to null terminated description of the error.

5.79.2.2

template<class Ch > Ch rapidxml::parse_error::where ( ) const [inline]

Gets pointer to character data where error happened.


Ch should be the same as char type of xml_document that produced the error.
Returns
Pointer to location within the parsed string where error occured.
The documentation for this class was generated from the following file:
src/node/include/node/rapidxml.hpp
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.80 PlainXMLFormatter Class Reference

5.80

201

PlainXMLFormatter Class Reference

Output formatter for plain XML output.

#include <PlainXMLFormatter.h>
Inheritance diagram for PlainXMLFormatter:

OutputFormatter
PlainXMLFormatter

Public Member Functions


PlainXMLFormatter (const unsigned int defaultIndentation=0)
Constructor.

virtual PlainXMLFormatter ()
Destructor.

bool writeXMLHeader (std::ostream &into, const std::string &rootElement, const std::string &attrs="", const
std::string &comment="")
Writes an XML header with optional configuration.

bool writeHeader (std::ostream &into, const SumoXMLTag &rootElement)


Writes an XML header with optional configuration.

void openTag (std::ostream &into, const std::string &xmlElement)


Opens an XML tag.

void openTag (std::ostream &into, const SumoXMLTag &xmlElement)


Opens an XML tag.

bool closeTag (std::ostream &into)


Closes the most recently opened tag.

void writePreformattedTag (std::ostream &into, const std::string &val)


writes a preformatted tag to the device but ensures that any pending tags are closed

Static Public Member Functions


template<class T >
static void writeAttr (std::ostream &into, const std::string &attr, const T &val)
writes an arbitrary attribute

template<class T >
static void writeAttr (std::ostream &into, const SumoXMLAttr attr, const T &val)
writes a named attribute

5.80.1

Detailed Description

Output formatter for plain XML output.


PlainXMLFormatter format XML like output into the output stream.

5.80.2

Member Function Documentation

5.80.2.1

bool PlainXMLFormatter::closeTag ( std::ostream & into ) [virtual]

Closes the most recently opened tag.


Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

202

Class Documentation

Parameters
into

in

The output stream to use

Returns
Whether a further element existed in the stack and could be closed
Todo it is not verified that the topmost element was closed
Implements OutputFormatter.

5.80.2.2

void PlainXMLFormatter::openTag ( std::ostream & into, const std::string & xmlElement ) [virtual]

Opens an XML tag.


An indentation, depending on the current xml-element-stack size, is written followed by the given xml element ("<"
+ xmlElement) The xml element is added to the stack, then.
Parameters
into
xmlElement

in
in

The output stream to use


Name of element to open

Returns
The OutputDevice for further processing
Implements OutputFormatter.

5.80.2.3

void PlainXMLFormatter::openTag ( std::ostream & into, const SumoXMLTag & xmlElement ) [virtual]

Opens an XML tag.


Helper method which finds the correct string before calling openTag.
Parameters
into
xmlElement

in
in

The output stream to use


Id of the element to open

Implements OutputFormatter.

5.80.2.4

template<class T > static void PlainXMLFormatter::writeAttr ( std::ostream & into, const std::string & attr, const T &
val ) [inline], [static]

writes an arbitrary attribute


Parameters
into
attr
val

in
in
in

5.80.2.5

The output stream to use


The attribute (name)
The attribute value

template<class T > static void PlainXMLFormatter::writeAttr ( std::ostream & into, const SumoXMLAttr attr, const
T & val ) [inline], [static]

writes a named attribute


Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.81 Point2D< coord_type > Class Template Reference

203

Parameters
into
attr
val

in
in
in

5.80.2.6

The output stream to use


The attribute (name)
The attribute value

bool PlainXMLFormatter::writeHeader ( std::ostream & into, const SumoXMLTag & rootElement )

Writes an XML header with optional configuration.


If something has been written (myXMLStack is not empty), nothing is written and false returned.
Parameters
into
rootElement

in
in

5.80.2.7

The output stream to use


The root element to use

void PlainXMLFormatter::writePreformattedTag ( std::ostream & into, const std::string & val ) [virtual]

writes a preformatted tag to the device but ensures that any pending tags are closed
Parameters
into
val

in
in

The output stream to use


The preformatted data

Implements OutputFormatter.

5.80.2.8

bool PlainXMLFormatter::writeXMLHeader ( std::ostream & into, const std::string & rootElement, const std::string &
attrs = "", const std::string & comment = "" ) [virtual]

Writes an XML header with optional configuration.


If something has been written (myXMLStack is not empty), nothing is written and false returned.
Parameters

in
in
in
in

into
rootElement
attrs
comment

The output stream to use


The root element to use
Additional attributes to save within the rootElement
Additional comment (saved in front the rootElement)

Todo Check which parameter is used herein


Describe what is saved
Implements OutputFormatter.
The documentation for this class was generated from the following file:
src/sumo/include/utils/iodevices/PlainXMLFormatter.h

5.81

Point2D< coord_type > Class Template Reference

Public Member Functions


Point2D (coord_type x0, coord_type y0)
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

204

Class Documentation

template<class point_type >


Point2D (const Point2D< point_type > &old)
template<class point_type >
Point2D< coord_type > & operator= (const Point2D< point_type > &old)
Point2D (const Point2D< coord_type > &old)
Point2D< coord_type > & operator= (const Point2D< coord_type > &old)
coord_type getX () const
coord_type getY () const
coord_type x () const
coord_type y () const
void setX (coord_type nx)
void setY (coord_type ny)
void set (coord_type nx, coord_type ny)
coord_type operator[ ] (int i) const
template<class point_type >
bool operator== (const Point2D< point_type > &old) const
template<class point_type >
bool operator!= (const Point2D< point_type > &old) const
template<class point_type >
Point2D< coord_type > & operator+= (const Point2D< point_type > &old)
template<class point_type >
Point2D< coord_type > & operator-= (const Point2D< point_type > &old)
void rotate (double angle)
NOTE: The angle is assumed to be in RADIANS.

void swap ()
double magnitude () const

Protected Attributes
coord_type _x
coord_type _y
The documentation for this class was generated from the following file:
src/sumo/include/foreign/eulerspiral/points.h

5.82

TraCIAPI::POIScope Class Reference

Scope for interaction with POIs.

#include <TraCIAPI.h>
Inheritance diagram for TraCIAPI::POIScope:

TraCIAPI::TraCIScopeWrapper
TraCIAPI::POIScope

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.83 TraCIAPI::PolygonScope Class Reference

205

Public Member Functions


POIScope (TraCIAPI &parent)
std::vector< std::string > getIDList () const
std::string getType (const std::string &poiID) const
TraCIPosition getPosition (const std::string &poiID) const
TraCIColor getColor (const std::string &poiID) const
void setType (const std::string &poiID, const std::string &setType) const
void setPosition (const std::string &poiID, SUMOReal x, SUMOReal y) const
void setColor (const std::string &poiID, const TraCIColor &c) const
void add (const std::string &poiID, SUMOReal x, SUMOReal y, const TraCIColor &c, const std::string &type,
int layer) const
void remove (const std::string &poiID, int layer=0) const

Protected Attributes
TraCIAPI & myParent
The parent TraCI client which offers the connection.

5.82.1

Detailed Description

Scope for interaction with POIs.


The documentation for this class was generated from the following files:
src/sumo/include/utils/traci/TraCIAPI.h
src/sumo/src/utils/traci/TraCIAPI.cpp

5.83

TraCIAPI::PolygonScope Class Reference

Scope for interaction with polygons.

#include <TraCIAPI.h>
Inheritance diagram for TraCIAPI::PolygonScope:

TraCIAPI::TraCIScopeWrapper
TraCIAPI::PolygonScope

Public Member Functions


PolygonScope (TraCIAPI &parent)
std::vector< std::string > getIDList () const
std::string getType (const std::string &polygonID) const
TraCIPositionVector getShape (const std::string &polygonID) const
TraCIColor getColor (const std::string &polygonID) const
void setType (const std::string &polygonID, const std::string &setType) const
void setShape (const std::string &polygonID, const TraCIPositionVector &shape) const
void setColor (const std::string &polygonID, const TraCIColor &c) const
void add (const std::string &polygonID, const TraCIPositionVector &shape, const TraCIColor &c, bool fill, const
std::string &type, int layer) const
void remove (const std::string &polygonID, int layer=0) const

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

206

Class Documentation

Protected Attributes
TraCIAPI & myParent
The parent TraCI client which offers the connection.

5.83.1

Detailed Description

Scope for interaction with polygons.


The documentation for this class was generated from the following files:
src/sumo/include/utils/traci/TraCIAPI.h
src/sumo/src/utils/traci/TraCIAPI.cpp

5.84

ProcessError Class Reference

ProcessError A general exception type that may be thrown when the process is no longer able to proceed due to
any reason.

#include <UtilExceptions.h>
Inheritance diagram for ProcessError:

runtime_error
ProcessError
InvalidArgument

IOError

Public Member Functions


ProcessError ()
constructor

ProcessError (const std::string &msg)


constructor

5.84.1

Detailed Description

ProcessError A general exception type that may be thrown when the process is no longer able to proceed due to
any reason.
The reason itself is mostly reported before throwing the exception
The documentation for this class was generated from the following file:
src/sumo/include/utils/common/UtilExceptions.h

5.85

Network::profileMemBuf Struct Reference

Inheritance diagram for Network::profileMemBuf:


Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.86 RandHelper Class Reference

207

streambuf
Network::profileMemBuf

Public Member Functions


profileMemBuf (char begin, char end)
The documentation for this struct was generated from the following file:
src/pnp2/include/pnp2/NetworkProfile.hpp

5.86

RandHelper Class Reference

Utility functions for using a global, resetable random number generator.

#include <RandHelper.h>

Static Public Member Functions


static void insertRandOptions ()
Initialises the given options container with random number options.

static void initRandGlobal (MTRand which=0)


Reads the given random number options and initialises the random number generator in accordance.

static SUMOReal rand ()


Returns a random real number in [0, 1)

static SUMOReal rand (SUMOReal maxV)


Returns a random real number in [0, maxV)

static SUMOReal rand (SUMOReal minV, SUMOReal maxV)


Returns a random real number in [minV, maxV)

static size_t rand (size_t maxV)


Returns a random integer in [0, maxV-1].

static int rand (int maxV)


Returns a random integer in [0, maxV-1].

static int rand (int minV, int maxV)


Returns a random integer in [minV, maxV-1].

static SUMOReal randNorm (SUMOReal mean, SUMOReal variance, MTRand rng=0)


Access to a random number from a normal distribution.

template<class T >
static T getRandomFrom (const std::vector< T > &v)
Returns a random element from the given vector.

Static Protected Attributes


static MTRand myRandomNumberGenerator
the random number generator to use

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

208

Class Documentation

5.86.1

Detailed Description

Utility functions for using a global, resetable random number generator.


The documentation for this class was generated from the following files:
src/sumo/include/utils/common/RandHelper.h
src/sumo/src/utils/common/RandHelper.cpp

RandomDistributor< T > Class Template Reference

5.87

Represents a generic random distribution.

#include <RandomDistributor.h>

Public Member Functions


RandomDistributor ()
Constructor for an empty distribution.

RandomDistributor ()
Destructor.

bool add (SUMOReal prob, T val, bool checkDuplicates=true)


Adds a value with an assigned probability to the distribution.

T get (MTRand which=0) const


Draw a sample of the distribution.

SUMOReal getOverallProb () const


Return the sum of the probabilites assigned to the members.

void clear ()
Clears the distribution.

const std::vector< T > & getVals () const


Returns the members of the distribution.

const std::vector< SUMOReal > & getProbs () const


Returns the probabilities assigned to the members of the distribution.

5.87.1

Detailed Description

template<class T>class RandomDistributor< T >


Represents a generic random distribution.
This class allows to create random distributions by assigning arbitrary (non-negative) probabilities to its elements.
The random number generator used is specified in RandHelper.
See Also
RandHelper

5.87.2

Constructor & Destructor Documentation

5.87.2.1

template<class T > RandomDistributor< T >::RandomDistributor ( ) [inline]

Constructor for an empty distribution.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.87 RandomDistributor< T > Class Template Reference

209

Parameters
maximumSize

in

The maximum size to maintain older entrys will be removed when adding more
than the maximumSize

5.87.3

Member Function Documentation

5.87.3.1

template<class T > bool RandomDistributor< T >::add ( SUMOReal prob, T val, bool checkDuplicates = true
) [inline]

Adds a value with an assigned probability to the distribution.


If the value is already member of the distribution and checkDuplicates is true (the default) the given probability is
added to the current. The probability has to be non-negative but values larger than one are allowed (and scaled
accordingly when an element is drawn).
Parameters
prob
val

in
in

The probability assigned to the value


The value to add to the distribution

Returns
true if a new value was added, false if just the probability of an existing one was updated

5.87.3.2

template<class T > T RandomDistributor< T >::get ( MTRand which = 0 ) const [inline]

Draw a sample of the distribution.


A random sample is drawn according to the assigned probabilities.
Parameters
which

in

The random number generator to use; the static one will be used if 0 is passed

Returns
the drawn member

5.87.3.3

template<class T > SUMOReal RandomDistributor< T >::getOverallProb ( ) const [inline]

Return the sum of the probabilites assigned to the members.


This should be zero if and only if the distribution is empty.
Returns
the total probability

5.87.3.4

template<class T > const std::vector<SUMOReal>& RandomDistributor< T >::getProbs ( ) const


[inline]

Returns the probabilities assigned to the members of the distribution.


See getVals for the corresponding members.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

210

Class Documentation

Returns
the probabilities assigned to the distribution

See Also
RandomDistributor::getVals

5.87.3.5

template<class T > const std::vector<T>& RandomDistributor< T >::getVals ( ) const [inline]

Returns the members of the distribution.


See getProbs for the corresponding probabilities.
Returns
the members of the distribution
See Also
RandomDistributor::getProbs
The documentation for this class was generated from the following file:
src/sumo/include/utils/common/RandomDistributor.h

5.88

Network::receiver Class Reference

Allows for the reception of data through a (possibly fixed-size) buffer at a configurable rate that can vary as a function
of time.

#include <receiver.hpp>

Public Member Functions

int init (int argc, char argv, std::string prof_str, uint64_t buff_capacity_bits=0, bool enable_oob=false)
void add_sender (uint64_t id, std::string profile)
void add_sender (std::string profileName)
void set_duration (double dur)
void set_output_filename (std::string filename)
void set_recv_done_callback (boost::function< void()> func)
void set_enable_sendback (bool sendback)
void update_sender_stream (uint64_t uuid, ros::Time t, uint64_t new_size)
ros::Time get_end_time () const
int init_oob ()
int oob_send (std::vector< uint64_t > &send_uuids, bool val)
void buffer_recv_threadfunc (void)
void record ()
int unlimit_ddos (void)
int limit_ddos (ros::Time now, double timeWindow)

Public Attributes
message_buffer< Network::Message > buffer
Network::NetworkProfile profile
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.89 Network::ResourceEntry Class Reference

5.88.1

211

Detailed Description

Allows for the reception of data through a (possibly fixed-size) buffer at a configurable rate that can vary as a function
of time.
Optionally enables out-of-band (oob) communication to senders to shut them off if the buffer is filling up too fast.
The receiver also records the reception of data (size, time) into memory for later dump to disk.
The documentation for this class was generated from the following file:
src/pnp2/include/pnp2/receiver.hpp

5.89

Network::ResourceEntry Class Reference

Holds the information about an interval of time starting at time, with constant bandwidth and max_bandwidth.

#include <NetworkProfile.hpp>

Public Member Functions


std::string toString ()

Public Attributes
double time
units: sec

uint64_t bandwidth
units: bits / sec

uint64_t max_bandwidth
units: bits / sec

uint64_t data
units: bits

double latency
units: sec

5.89.1

Detailed Description

Holds the information about an interval of time starting at time, with constant bandwidth and max_bandwidth.
Data and latency are linearly interpolated between time and the start time of the next ResourceEntry. Data is
interpolated according to bandwidth of this ResourceEntry, while latency is interpolated according to the latency
value of the next ResourceEntry.
The documentation for this class was generated from the following file:
src/pnp2/include/pnp2/NetworkProfile.hpp

5.90

RGBColor Class Reference

The definition of a color in the RGB-space with an alpha channel.

#include <RGBColor.h>
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

212

Class Documentation

Public Member Functions


RGBColor ()
Constructor.

RGBColor (unsigned char red, unsigned char green, unsigned char blue, unsigned char alpha=255)
Constructor.

RGBColor (const RGBColor &col)


Copy constructor.

RGBColor ()
Destructor.

unsigned char red () const


Returns the red-amount of the color.

unsigned char green () const


Returns the green-amount of the color.

unsigned char blue () const


Returns the blue-amount of the color.

unsigned char alpha () const


Returns the alpha-amount of the color.

void set (unsigned char r, unsigned char g, unsigned char b, unsigned char a)
assigns new values

bool operator== (const RGBColor &c) const


bool operator!= (const RGBColor &c) const
RGBColor changedBrightness (int change, int toChange=3) const
Returns a new color with altered brightness.

Static Public Member Functions


static RGBColor parseColor (std::string coldef)
Parses a color information.

static RGBColor parseColorReporting (const std::string &coldef, const std::string &objecttype, const char
objectid, bool report, bool &ok)
Parses a color information.

static RGBColor interpolate (const RGBColor &minColor, const RGBColor &maxColor, SUMOReal weight)
Interpolates between two colors.

static RGBColor fromHSV (SUMOReal h, SUMOReal s, SUMOReal v)


Converts the given hsv-triplet to rgb.

Static Public Attributes

static const RGBColor RED = RGBColor(255, 0, 0, 255)


static const RGBColor GREEN = RGBColor(0, 255, 0, 255)
static const RGBColor BLUE = RGBColor(0, 0, 255, 255)
static const RGBColor YELLOW = RGBColor(255, 255, 0, 255)
static const RGBColor CYAN = RGBColor(0, 255, 255, 255)
static const RGBColor MAGENTA = RGBColor(255, 0, 255, 255)
static const RGBColor ORANGE = RGBColor(255, 128, 0, 255)
static const RGBColor WHITE = RGBColor(255, 255, 255, 255)
static const RGBColor BLACK = RGBColor(0, 0, 0, 255)
static const RGBColor GREY = RGBColor(128, 128, 128, 255)
static const RGBColor DEFAULT_COLOR = RGBColor::YELLOW
The default color (for vehicle types and vehicles)

static const std::string DEFAULT_COLOR_STRING = toString(RGBColor::DEFAULT_COLOR)


The string description of the default color.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.90 RGBColor Class Reference

213

Friends
std::ostream & operator<< (std::ostream &os, const RGBColor &col)
Writes the color to the given stream.

5.90.1

Detailed Description

The definition of a color in the RGB-space with an alpha channel.


The cube is meant to lie between (0, 0, 0) and (255, 255, 255)

5.90.2

Constructor & Destructor Documentation

5.90.2.1

RGBColor::RGBColor ( unsigned char red, unsigned char green, unsigned char blue, unsigned char alpha = 255 )

Constructor.
Parameters
red
green
blue

in
in
in

The red components value


The green components value
The blue components value

5.90.3

Member Function Documentation

5.90.3.1

unsigned char RGBColor::alpha ( ) const [inline]

Returns the alpha-amount of the color.


Returns
The alpha components value

5.90.3.2

unsigned char RGBColor::blue ( ) const [inline]

Returns the blue-amount of the color.


Returns
The blue components value

5.90.3.3 RGBColor RGBColor::changedBrightness ( int change, int toChange = 3 ) const


Returns a new color with altered brightness.
Parameters

in
in

change
change

The absolute change applied to all channels (within bounds)


The number of colors to change

Returns
The new color

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

214

Class Documentation

5.90.3.4 RGBColor RGBColor::fromHSV ( SUMOReal h, SUMOReal s, SUMOReal v ) [static]


Converts the given hsv-triplet to rgb.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.90 RGBColor Class Reference

215

Parameters
h
s
v

in
in
in

Hue (0-360)
Saturation (0-1)
Value (0-1)

Returns
The color as RGB

Author
Alvy Ray Smith (http://www.alvyray.com/default.htm)

5.90.3.5

unsigned char RGBColor::green ( ) const [inline]

Returns the green-amount of the color.


Returns
The green components value

5.90.3.6 RGBColor RGBColor::interpolate ( const RGBColor & minColor, const RGBColor & maxColor, SUMOReal
weight ) [static]
Interpolates between two colors.
The interpolated color is calculated as a weighted average of the RGB values of minColor and maxColor, giving
weight to maxColor and 1-weight to minColor.
Parameters

in
in
in

minColor
maxColor
weight

The color to interpolate from


The color to interpolate to
The weight of the first color

Returns
The interpolated color

5.90.3.7 RGBColor RGBColor::parseColor ( std::string coldef ) [static]


Parses a color information.
It is assumed that the color is stored as "<RED>,<GREEN>,<BLUE>" and each color is represented as a SUMOReal. Alternatively the color can be stored as "<RED>,<GREEN>,<BLUE>,<ALPHA>" and each color is
represented as an unsigned byte.
Parameters

in

coldef

The color definition to parse

Returns
The parsed color

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

216

Class Documentation

Exceptions
EmptyData
NumberFormatException

If the definition has less than three entries


If one of the components is not numeric

5.90.3.8 RGBColor RGBColor::parseColorReporting ( const std::string & coldef, const std::string & objecttype, const char
objectid, bool report, bool & ok ) [static]
Parses a color information.
It is assumed that the color is stored as "<RED>,<GREEN>,<BLUE>" and each color is represented as a SUMOReal. Alternatively the color can be stored as "<RED>,<GREEN>,<BLUE>,<ALPHA>" and each color is
represented as an unsigned byte.
Parameters

in
in
in
in
in,out

coldef
objecttype
objectid
report
ok

The color definition to parse


The type of the currently parsed object
The id of the currently parsed object
Whether errors shall be reported
Whether parsing was successful

Returns
The parsed color
Exceptions
EmptyData
NumberFormatException

5.90.3.9

If the definition has less than three entries


If one of the components is not numeric

unsigned char RGBColor::red ( ) const [inline]

Returns the red-amount of the color.


Returns
The red components value

5.90.3.10

void RGBColor::set ( unsigned char r, unsigned char g, unsigned char b, unsigned char a )

assigns new values


Parameters

in
in
in
in

r
g
b
a

The red components value


The green components value
The blue components value
The alpha components value

5.90.4

Friends And Related Function Documentation

5.90.4.1

std::ostream& operator<< ( std::ostream & os, const RGBColor & col ) [friend]

Writes the color to the given stream.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.91 TraCIAPI::RouteScope Class Reference


Parameters
os
col

out
in

The stream to write to


The color to write

Returns
The stream

The documentation for this class was generated from the following files:
src/sumo/include/utils/common/RGBColor.h
src/sumo/src/utils/common/RGBColor.cpp

5.91

TraCIAPI::RouteScope Class Reference

Scope for interaction with routes.

#include <TraCIAPI.h>
Inheritance diagram for TraCIAPI::RouteScope:

TraCIAPI::TraCIScopeWrapper
TraCIAPI::RouteScope

Public Member Functions


RouteScope (TraCIAPI &parent)
std::vector< std::string > getIDList () const
std::vector< std::string > getEdges (const std::string &routeID) const
void add (const std::string &routeID, const std::vector< std::string > &edges) const

Protected Attributes
TraCIAPI & myParent
The parent TraCI client which offers the connection.

5.91.1

Detailed Description

Scope for interaction with routes.


The documentation for this class was generated from the following files:
src/sumo/include/utils/traci/TraCIAPI.h
src/sumo/src/utils/traci/TraCIAPI.cpp
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

217

218

Class Documentation

5.92

SAXWeightsHandler Class Reference

An XML-handler for network weights.

#include <SAXWeightsHandler.h>
Inheritance diagram for SAXWeightsHandler:

DefaultHandler
GenericSAXHandler
SUMOSAXHandler
SAXWeightsHandler

Classes
class EdgeFloatTimeLineRetriever
Interface for a class which obtains read weights for named edges.

class ToRetrieveDefinition
Complete definition about what shall be retrieved and where to store it.

Public Member Functions


SAXWeightsHandler (const std::vector< ToRetrieveDefinition > &defs, const std::string &file)
Constructor.

SAXWeightsHandler (ToRetrieveDefinition def, const std::string &file)


Constructor.

SAXWeightsHandler ()
Destructor.

void startElement (const XMLCh const uri, const XMLCh const localname, const XMLCh const qname,
const XERCES_CPP_NAMESPACE::Attributes &attrs)
The inherited method called when a new tag opens.

void characters (const XMLCh const chars, const XERCES3_SIZE_t length)


The inherited method called when characters occured.

void endElement (const XMLCh const uri, const XMLCh const localname, const XMLCh const qname)
The inherited method called when a tag is being closed.

void registerParent (const int tag, GenericSAXHandler handler)


Assigning a parent handler which is enabled when the specified tag is closed.

void setFileName (const std::string &name)


Sets the current file name.

const std::string & getFileName () const


returns the current file name

SAX ErrorHandler callbacks


void warning (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
Handler for XML-warnings.

void error (const XERCES_CPP_NAMESPACE::SAXParseException &exception)


Handler for XML-errors.

void fatalError (const XERCES_CPP_NAMESPACE::SAXParseException &exception)


Handler for XML-errors.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.92 SAXWeightsHandler Class Reference

219

Protected Member Functions


std::string buildErrorMessage (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
Builds an error message.

virtual void myCharacters (int element, const std::string &chars)


Callback method for characters to implement by derived classes.

inherited from GenericSAXHandler


void myStartElement (int element, const SUMOSAXAttributes &attrs)
Called on the opening of a tag;.

void myEndElement (int elemente)


Called when a closing tag occurs.

5.92.1

Detailed Description

An XML-handler for network weights.


As network weights are used both in the simulation and the routers, a base class for loading them was built.
Instances of this class should be supplied with at least one definition about what shall be retrieved (ToRetrieveDefinition, defined as inner class) which also contains the information about the retriever (EdgeFloatTimeLineRetriever, defined as inner class).
The ToRetrieveDefinition names the attribute which the SAXWeightsHandler shall parse and reporte. Within the
parsed xml-file these attributes may be embedded in "lane" or "edge" elements, one for each edge or for each lane
(see below). These elements should be embedded in interval-tags which specify the time the weight is valid at.
The boolean "edgeBased" tells SAXWeightsHandler whether the weights are supplied on edge- or on lane-basis
(whether it shall parse the "edge" or the "lane" elements).
Examples for files the SAXWeightsHandler can handle are the edgedump and the lanedump generated by the
simulation.
The EdgeFloatTimeLineRetriever to which read values will be reported should have the method "addEdgeWeight"
implemented. It wil be supplied with the current edge name, the interval the weight is valid for and the value.

5.92.2

Constructor & Destructor Documentation

5.92.2.1

SAXWeightsHandler::SAXWeightsHandler ( const std::vector< ToRetrieveDefinition > & defs, const std::string


& file )

Constructor.
Gets a list of retriever definitions. Please note that the retrievers are not deleted!

5.92.2.2

SAXWeightsHandler::SAXWeightsHandler ( ToRetrieveDefinition def, const std::string & file )

Constructor.
Gets a single definition. Please note that the retrievers are not deleted!

5.92.3

Member Function Documentation

5.92.3.1

std::string GenericSAXHandler::buildErrorMessage ( const XERCES_CPP_NAMESPACE::SAXParseException &


exception ) [protected], [inherited]

Builds an error message.


The error message includes the file name and the line/column information as supported by the given SAXParseException
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

220

Class Documentation

Parameters
exception

in

The name of the currently processed file

Returns
A string describing the given exception

5.92.3.2

void GenericSAXHandler::characters ( const XMLCh const chars, const XERCES3_SIZE_t length )

[inherited]
The inherited method called when characters occured.
The retrieved characters are converted into a string and appended into a private buffer. They are reported as soon
as the element ends.
Todo recheck/describe what happens with characters when a new element is opened
describe characters processing in the class head

5.92.3.3

void GenericSAXHandler::endElement ( const XMLCh const uri, const XMLCh const localname, const XMLCh

const qname ) [inherited]


The inherited method called when a tag is being closed.
This method calls the user-implemented methods myCharacters with the previously collected and converted characters.
Then, myEndElement is called, supplying it the qname converted to its enum- and string-representations.
Todo recheck/describe encoding of the string-representation
do not generate and report the string-representation

5.92.3.4

void GenericSAXHandler::error ( const XERCES_CPP_NAMESPACE::SAXParseException & exception )

[inherited]
Handler for XML-errors.
The message is built using buildErrorMessage and thrown within a ProcessError.
Parameters
exception

in

The occured exception to process

Exceptions
ProcessError

5.92.3.5

On any call

void GenericSAXHandler::fatalError ( const XERCES_CPP_NAMESPACE::SAXParseException & exception )

[inherited]
Handler for XML-errors.
The message is built using buildErrorMessage and thrown within a ProcessError.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.92 SAXWeightsHandler Class Reference

221

Exceptions
ProcessError

On any call

Parameters
exception

in

5.92.3.6

The occured exception to process

const std::string& GenericSAXHandler::getFileName ( ) const [inherited]

returns the current file name


Returns
The name of the currently processed file

5.92.3.7

virtual void GenericSAXHandler::myCharacters ( int element, const std::string & chars ) [protected],

[virtual], [inherited]
Callback method for characters to implement by derived classes.
Called by "endElement" (see there).
Parameters
element
chars

in
in

5.92.3.8

The opened element, given as a int


The complete embedded character string ProcessError These method may
throw a ProcessError if something fails

void SAXWeightsHandler::myEndElement ( int elemente ) [protected], [virtual]

Called when a closing tag occurs.


Parameters
element

in

ID of the currently opened element

Exceptions
ProcessError

If something fails

See Also
GenericSAXHandler::myEndElement
Reimplemented from GenericSAXHandler.

5.92.3.9

void SAXWeightsHandler::myStartElement ( int element, const SUMOSAXAttributes & attrs ) [protected],

[virtual]
Called on the opening of a tag;.
Parameters

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

222

Class Documentation
element
attrs

in
in

ID of the currently opened element


Attributes within the currently opened element

Exceptions
ProcessError

If something fails

See Also
GenericSAXHandler::myStartElement
Reimplemented from GenericSAXHandler.

5.92.3.10

void GenericSAXHandler::setFileName ( const std::string & name ) [inherited]

Sets the current file name.


Parameters
name

in

The name of the currently processed file

Todo Hmmm - this is as unsafe as having a direct access to the variable; recheck

void GenericSAXHandler::startElement ( const XMLCh const uri, const XMLCh const localname, const XMLCh
const qname, const XERCES_CPP_NAMESPACE::Attributes & attrs ) [inherited]

5.92.3.11

The inherited method called when a new tag opens.


The method parses the supplied XMLCh-qname using the internal name/enum-map to obtain the enum representation of the attribute name.
Then, "myStartElement" is called supplying the enumeration value, the string-representation of the name and the
attributes.
Todo recheck/describe encoding of the string-representation
do not generate and report the string-representation

5.92.3.12

void GenericSAXHandler::warning ( const XERCES_CPP_NAMESPACE::SAXParseException & exception )

[inherited]
Handler for XML-warnings.
The message is built using buildErrorMessage and reported to the warning-instance of the MsgHandler.
Parameters

in

exception

The occured exception to process

The documentation for this class was generated from the following file:
src/sumo/include/utils/xml/SAXWeightsHandler.h

5.93

AbstractMutex::ScopedLocker Class Reference

A mutex encapsulator which locks/unlocks the given mutex on construction/destruction, respectively.

#include <AbstractMutex.h>
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.94 Network::sender Class Reference

223

Public Member Functions


ScopedLocker (AbstractMutex &lock)
Constructor.

ScopedLocker ()
Destructor Unlocks the mutex.

5.93.1

Detailed Description

A mutex encapsulator which locks/unlocks the given mutex on construction/destruction, respectively.

5.93.2

Constructor & Destructor Documentation

5.93.2.1

AbstractMutex::ScopedLocker::ScopedLocker ( AbstractMutex & lock ) [inline]

Constructor.
Parameters

in

lock

The mutex to lock

Locks the mutex.


The documentation for this class was generated from the following file:
src/sumo/include/utils/common/AbstractMutex.h

5.94

Network::sender Class Reference

Allows for the sending of data (possibly through a buffer) at a configurable rate and with configurable push-back to
inform if the rate has been exceeded.

#include <sender.hpp>

Public Member Functions


int create_oob_mc_socket ()
int init (int argc, char argv, std::string prof_str, uint64_t u=-1, bool enable_oob=false)
void set_duration (double dur)
void set_output_filename (std::string filename)
void set_uuid (uint64_t u)
uint64_t get_uuid () const
ros::Time get_end_time () const
void record ()
template<typename T >
double send (NAMESPACE::Publisher pub, const T &msg)
void oob_recv_threadfunc ()

Public Attributes
std::vector< Network::Message > messages
Network::NetworkProfile profile
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

224

Class Documentation

5.94.1

Detailed Description

Allows for the sending of data (possibly through a buffer) at a configurable rate and with configurable push-back to
inform if the rate has been exceeded.
Can also optionally receive out-of-band (oob) push-backs from its associated receiver classes to disable sending
while they empty their receive buffers. The sender also records the sending of data (size, time) into memory for
later dump to disk.
The documentation for this class was generated from the following file:
src/pnp2/include/pnp2/sender.hpp

5.95

TraCIAPI::SimulationScope Class Reference

Scope for interaction with the simulation.

#include <TraCIAPI.h>
Inheritance diagram for TraCIAPI::SimulationScope:

TraCIAPI::TraCIScopeWrapper
TraCIAPI::SimulationScope

Public Member Functions


SimulationScope (TraCIAPI &parent)
SUMOTime getCurrentTime () const
unsigned int getLoadedNumber () const
std::vector< std::string > getLoadedIDList () const
unsigned int getDepartedNumber () const
std::vector< std::string > getDepartedIDList () const
unsigned int getArrivedNumber () const
std::vector< std::string > getArrivedIDList () const
unsigned int getStartingTeleportNumber () const
std::vector< std::string > getStartingTeleportIDList () const
unsigned int getEndingTeleportNumber () const
std::vector< std::string > getEndingTeleportIDList () const
SUMOTime getDeltaT () const
TraCIBoundary getNetBoundary () const
unsigned int getMinExpectedNumber () const

Protected Attributes
TraCIAPI & myParent
The parent TraCI client which offers the connection.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.96 tcpip::Socket Class Reference

5.95.1

Detailed Description

Scope for interaction with the simulation.


The documentation for this class was generated from the following files:
src/sumo/include/utils/traci/TraCIAPI.h
src/sumo/src/utils/traci/TraCIAPI.cpp

5.96

tcpip::Socket Class Reference

Public Member Functions


Socket (std::string host, int port)
Constructor that prepare to connect to host:port.

Socket (int port)


Constructor that prepare for accepting a connection on given port.

Socket ()
Destructor.

void connect () throw ( SocketException )


Connects to host_:port_.

void accept () throw ( SocketException )


Wait for a incoming connection to port_.

void send (const std::vector< unsigned char > &buffer) throw ( SocketException )
void sendExact (const Storage &) throw ( SocketException )
std::vector< unsigned char > receive (int bufSize=2048) throw ( SocketException )
Receive up to bufSize available bytes from Socket::socket_.
bool receiveExact (Storage &) throw ( SocketException )
Receive a complete TraCI message from Socket::socket_.

void close ()
int port ()
void set_blocking (bool) throw ( SocketException )
bool is_blocking () throw ()
bool has_client_connection () const
bool verbose ()
void set_verbose (bool newVerbose)

Protected Member Functions


void receiveComplete (unsigned char const buffer, std::size_t len) const
Receive len bytes from Socket::socket_.
size_t recvAndCheck (unsigned char const buffer, std::size_t len) const
Receive up to len available bytes from Socket::socket_.
void printBufferOnVerbose (const std::vector< unsigned char > buffer, const std::string &label) const
Print label and buffer to stderr if Socket::verbose_ is set.

Static Protected Attributes


static const int lengthLen
Length of the message length part of a TraCI message.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

225

226

Class Documentation

Friends
class Response
The documentation for this class was generated from the following file:
src/sumo/include/foreign/tcpip/socket.h

5.97

tcpip::SocketException Class Reference

Inheritance diagram for tcpip::SocketException:

exception
tcpip::SocketException

Public Member Functions


SocketException (std::string what) throw ()
virtual const char what () const throw ()
The documentation for this class was generated from the following file:
src/sumo/include/foreign/tcpip/socket.h

5.98

StaticCommand< T > Class Template Reference

A wrapper for a Command function.

#include <StaticCommand.h>
Inheritance diagram for StaticCommand< T >:

Command

StaticCommand< T >

Public Types
typedef SUMOTime( Operation )(SUMOTime)
Type of the function to execute.

Public Member Functions


StaticCommand (Operation operation)
Constructor.

StaticCommand ()
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.98 StaticCommand< T > Class Template Reference

227

Destructor.

void deschedule ()
Marks this Command as being descheduled.

Derived from Command


SUMOTime execute (SUMOTime currentTime)
Executes the command.

5.98.1

Detailed Description

template<class T>class StaticCommand< T >


A wrapper for a Command function.
See Also
Design Patterns, Gamma et al.
Command
MSEventControl

5.98.2

Constructor & Destructor Documentation

5.98.2.1

template<class T > StaticCommand< T >::StaticCommand ( Operation operation ) [inline]

Constructor.
Parameters
receiver
operation

in
in

Pointer to object of type T that will receive a call to one of its methods.
The objects method that will be called on execute()

5.98.3

Member Function Documentation

5.98.3.1

template<class T > void StaticCommand< T >::deschedule ( ) [inline]

Marks this Command as being descheduled.


A simple boolean marker ("myAmDescheduledByParent") is set which prevents this command from being executed.

5.98.3.2

template<class T > SUMOTime StaticCommand< T >::execute ( SUMOTime currentTime ) [inline],


[virtual]

Executes the command.


If the command is not descheduled, the stored method of the stored instance is called.
Parameters

in

currentTime

The current simulation time

Returns
The time after which the command shall be executed again, 0 if this command shall be descheduled.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

228

Class Documentation

Exceptions
ProcessError

Derived actions may throw this exception

Implements Command.
The documentation for this class was generated from the following file:
src/sumo/include/utils/common/StaticCommand.h

5.99

tcpip::Storage Class Reference

Public Types
typedef std::vector< unsigned
char > StorageType

Public Member Functions


Storage ()
Standard Constructor.

Storage (const unsigned char[ ], int length=-1)


Constructor, that fills the storage with an char array. If length is -1, the whole array is handed over.

virtual bool valid_pos ()


virtual unsigned int position () const
void reset ()
std::string hexDump () const

virtual unsigned char readChar () throw (std::invalid_argument)


virtual void writeChar (unsigned char) throw ()
virtual int readByte () throw (std::invalid_argument)
virtual void writeByte (int) throw (std::invalid_argument)
virtual int readUnsignedByte () throw (std::invalid_argument)
virtual void writeUnsignedByte (int) throw (std::invalid_argument)
virtual std::string readString () throw (std::invalid_argument)
virtual void writeString (const std::string &s) throw ()
virtual std::vector< std::string > readStringList () throw (std::invalid_argument)
virtual void writeStringList (const std::vector< std::string > &s) throw ()
virtual int readShort () throw (std::invalid_argument)
virtual void writeShort (int) throw (std::invalid_argument)
virtual int readInt () throw (std::invalid_argument)
virtual void writeInt (int) throw ()
virtual float readFloat () throw (std::invalid_argument)
virtual void writeFloat (float) throw ()
virtual double readDouble () throw (std::invalid_argument)
virtual void writeDouble (double) throw ()
virtual void writePacket (unsigned char packet, int length)
virtual void writePacket (const std::vector< unsigned char > &packet)
virtual void writeStorage (tcpip::Storage &store)
StorageType::size_type size () const
StorageType::const_iterator begin () const
StorageType::const_iterator end () const

Dump storage content as series of hex values.

The documentation for this class was generated from the following file:
src/sumo/include/foreign/tcpip/storage.h
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.100 Named::StoringVisitor Class Reference

5.100

229

Named::StoringVisitor Class Reference

Allows to store the object; used as context while traveling the rtree in TraCI.

#include <Named.h>

Public Member Functions


StoringVisitor (std::set< std::string > &ids)
Contructor.

StoringVisitor ()
Destructor.

void add (const Named const o) const


Adds the given object to the container.

Public Attributes
std::set< std::string > & myIDs
The container.

5.100.1

Detailed Description

Allows to store the object; used as context while traveling the rtree in TraCI.
The documentation for this class was generated from the following file:
src/sumo/include/utils/common/Named.h

5.101

TraCIServerAPI_Lane::StoringVisitor Class Reference

Allows to store the object; used as context while traveling the rtree in TraCI.

#include <TraCIServerAPI_Lane.h>

Public Member Functions


StoringVisitor (std::set< std::string > &ids, const PositionVector &shape, const SUMOReal range, const int
domain)
Constructor.

StoringVisitor ()
Destructor.

void add (const MSLane const l) const


Adds the given object to the container.

Public Attributes
std::set< std::string > & myIDs
The container.

const PositionVector & myShape


const SUMOReal myRange
const int myDomain
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

230

Class Documentation

5.101.1

Detailed Description

Allows to store the object; used as context while traveling the rtree in TraCI.
The documentation for this class was generated from the following file:
src/sumo/include/traci-server/TraCIServerAPI_Lane.h

5.102

StringBijection< T > Class Template Reference

Template container for maintaining a bidirectional map between strings and something else It is not always a bijection since it allows for duplicate entries on both sides if either checkDuplicates is set to false in the constructor or
the insert function or if the addAlias function is used.

#include <StringBijection.h>

Classes
struct Entry

Public Member Functions


StringBijection (Entry entries[ ], T terminatorKey, bool checkDuplicates=true)
void insert (const std::string str, const T key, bool checkDuplicates=true)
void addAlias (const std::string str, const T key)
void remove (const std::string str, const T key)
T get (const std::string &str) const
const std::string & getString (const T key) const
bool hasString (const std::string &str) const
bool has (const T key) const
size_t size () const
std::vector< std::string > getStrings () const
void addKeysInto (std::vector< T > &list) const

5.102.1

Detailed Description

template<class T>class StringBijection< T >


Template container for maintaining a bidirectional map between strings and something else It is not always a bijection since it allows for duplicate entries on both sides if either checkDuplicates is set to false in the constructor or
the insert function or if the addAlias function is used.
The documentation for this class was generated from the following file:
src/sumo/include/utils/common/StringBijection.h

5.103

StringTokenizer Class Reference

StringTokenizer A class similar to the StringTokenizer from Java.

#include <StringTokenizer.h>
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.103 StringTokenizer Class Reference

231

Public Member Functions


StringTokenizer ()
default constructor

StringTokenizer (std::string tosplit)


constructor same as StringTokenizer(tosplit, StringTokenizer.WHITECHARS) tosplit is the string to split into substrings.

StringTokenizer (std::string tosplit, std::string token, bool splitAtAllChars=false)


constructor the first string will be split at the second strings occurences.

StringTokenizer (std::string tosplit, int special)


constructor When StringTokenizer.NEWLINE is used as second parameter, the string will be split at all occurences of
a newline character (0x0d / 0x0a) When StringTokenizer.WHITECHARS is used as second parameter, the string will
be split at all characters below 0x20 (SPACE) All other ints specified as second parameter are casted int o a char at
which the string will be splitted.

StringTokenizer ()
destructor

void reinit ()
reinitialises the internal iterator

bool hasNext ()
returns the information whether further substrings exist

std::string next ()
returns the next substring when it exists.

size_t size () const


returns the number of existing substrings

std::string front ()
returns the first substring without moving the iterator

std::string get (size_t pos) const


returns the item at the given position

std::vector< std::string > getVector ()

Static Public Attributes


static const int NEWLINE = -256
identifier for splitting the given string at all newline characters

static const int WHITECHARS = -257


identifier for splitting the given string at all whitespace characters

static const int SPACE = 32


the ascii index of the highest whitespace character

5.103.1

Detailed Description

StringTokenizer A class similar to the StringTokenizer from Java.


It splits a string at the given string or character (or one of the special cases NEWLINE or WHITECHAR) and allows
to iterate over the so generated substrings.
The normal usage is like this:

StringTokenizer st(CString("This is a line"), );


while(st.hasNext())
cout << st.next() << endl;
This would generate the output:
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

232

Class Documentation

This
is
a
line
There is something to know about the behaviour: When using WHITECHAR, a list of whitechars occuring in the
string to split is regarded as a single divider. All other parameter will use multiple occurences of operators as a list
of single divider and the string between them will have a length of zero.

5.103.2

Constructor & Destructor Documentation

5.103.2.1

StringTokenizer::StringTokenizer ( std::string tosplit )

constructor same as StringTokenizer(tosplit, StringTokenizer.WHITECHARS) tosplit is the string to split into substrings.
If the string between two split positions is empty, it will not be returned.

5.103.2.2

StringTokenizer::StringTokenizer ( std::string tosplit, std::string token, bool splitAtAllChars = false )

constructor the first string will be split at the second strings occurences.
If the optional third parameter is true, the string will be split whenever a char from the second string occurs. If the
string between two split positions is empty, it will nevertheless be returned.

5.103.2.3

StringTokenizer::StringTokenizer ( std::string tosplit, int special )

constructor When StringTokenizer.NEWLINE is used as second parameter, the string will be split at all occurences
of a newline character (0x0d / 0x0a) When StringTokenizer.WHITECHARS is used as second parameter, the string
will be split at all characters below 0x20 (SPACE) All other ints specified as second parameter are casted int o a
char at which the string will be splitted.

5.103.3

Member Function Documentation

5.103.3.1

std::string StringTokenizer::next ( )

returns the next substring when it exists.


Otherwise the behaviour is undefined
The documentation for this class was generated from the following files:
src/sumo/include/utils/common/StringTokenizer.h
src/sumo/src/utils/common/StringTokenizer.cpp

5.104

StringUtils Class Reference

Some static methods for string processing.

#include <StringUtils.h>

Static Public Member Functions


static std::string prune (const std::string &str)
Removes trailing and leading whitechars.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.105 SUMO_CLIENT Class Reference

static std::string to_lower_case (std::string str)


Transfers the content to lower case.

static std::string latin1_to_utf8 (std::string str)


Transfers from Latin 1 (ISO-8859-1) to UTF-8.

static std::string convertUmlaute (std::string str)


Converts german "Umlaute" to their latin-version.

static std::string replace (std::string str, const char what, const char by)
Replaces all occurences of the second string by the third string within the first string.

static std::string toTimeString (int time)


Builds a time string (hh:mm:ss) from the given seconds.

static bool startsWith (const std::string &str, const std::string prefix)


Checks whether a given string starts with the prefix.

static bool endsWith (const std::string &str, const std::string suffix)


Checks whether a given string ends with the suffix.

static std::string escapeXML (const std::string &orig)


Replaces the standard escapes by their XML entities.

Static Public Attributes


static std::string emptyString
An empty string.

5.104.1

Detailed Description

Some static methods for string processing.

5.104.2

Member Function Documentation

5.104.2.1

std::string StringUtils::escapeXML ( const std::string & orig ) [static]

Replaces the standard escapes by their XML entities.


The strings &, <, >, ", and are replaced by &, <, >, ", and
Parameters

in

orig

The original string

Returns
the string with the escaped sequences
The documentation for this class was generated from the following files:
src/sumo/include/utils/common/StringUtils.h
src/sumo/src/utils/common/StringUtils.cpp

5.105

SUMO_CLIENT Class Reference

Inheritance diagram for SUMO_CLIENT:


Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

233

234

Class Documentation

TraCIAPI

SUMO_CLIENT

Public Types
Structures definitions
typedef std::vector
< TraCIPosition > TraCIPositionVector

Public Member Functions

SUMO_CLIENT (std::string outputFileName="tlc.out")


bool create_connection (int port, std::string host="localhost")
void close_connection ()
void commandSimulationStep (SUMOTime time)

Connection handling
void connect (const std::string &host, int port)
Connects to the specified SUMO server.

void close ()
Closes the connection.

Atomar getter

SUMOTime getSUMOTime (int cmd, int var, const std::string &id, tcpip::Storage add=0)
int getUnsignedByte (int cmd, int var, const std::string &id, tcpip::Storage add=0)
int getByte (int cmd, int var, const std::string &id, tcpip::Storage add=0)
int getInt (int cmd, int var, const std::string &id, tcpip::Storage add=0)
SUMOReal getFloat (int cmd, int var, const std::string &id, tcpip::Storage add=0)
SUMOReal getDouble (int cmd, int var, const std::string &id, tcpip::Storage add=0)
TraCIBoundary getBoundingBox (int cmd, int var, const std::string &id, tcpip::Storage add=0)
TraCIPositionVector getPolygon (int cmd, int var, const std::string &id, tcpip::Storage add=0)
TraCIPosition getPosition (int cmd, int var, const std::string &id, tcpip::Storage add=0)
std::string getString (int cmd, int var, const std::string &id, tcpip::Storage add=0)
std::vector< std::string > getStringVector (int cmd, int var, const std::string &id, tcpip::Storage add=0)
TraCIColor getColor (int cmd, int var, const std::string &id, tcpip::Storage add=0)

Public Attributes
EdgeScope edge
Scope for interaction with edges.

GUIScope gui
Scope for interaction with the gui.

InductionLoopScope inductionloop
Scope for interaction with inductive loops.

JunctionScope junction
Scope for interaction with junctions.

LaneScope lane
Scope for interaction with lanes.

MeMeScope multientryexit
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.105 SUMO_CLIENT Class Reference

235

Scope for interaction with multi-entry/-exit detectors.

POIScope poi
Scope for interaction with POIs.

PolygonScope polygon
Scope for interaction with polygons.

RouteScope route
Scope for interaction with routes.

SimulationScope simulation
Scope for interaction with the simulation.

TrafficLightScope trafficlights
Scope for interaction with traffic lights.

VehicleTypeScope vehicletype
Scope for interaction with vehicle types.

Protected Member Functions


void commandClose ()
void commandSubscribeObjectVariable (int domID, const std::string &objID, int beginTime, int endTime, int
varNo, std::ifstream &defFile)
void commandSubscribeContextVariable (int domID, const std::string &objID, int beginTime, int endTime,
int domain, SUMOReal range, int varNo, std::ifstream &defFile)
Command sending methods
void send_commandSimulationStep (SUMOTime time) const
Sends a SimulationStep command.

void send_commandClose () const


Sends a Close command.

void send_commandGetVariable (int domID, int varID, const std::string &objID, tcpip::Storage add=0)
const
Sends a GetVariable request.

void send_commandSetValue (int domID, int varID, const std::string &objID, tcpip::Storage &content) const
Sends a SetVariable request.

void send_commandSubscribeObjectVariable (int domID, const std::string &objID, int beginTime, int endTime, const std::vector< int > &vars) const
Sends a SubscribeVariable request.

void send_commandSubscribeObjectContext (int domID, const std::string &objID, int beginTime, int endTime, int domain, SUMOReal range, const std::vector< int > &vars) const
Sends a SubscribeContext request.

void check_resultState (tcpip::Storage &inMsg, int command, bool ignoreCommandId=false, std::string


acknowledgement=0) const
Validates the result state of a command.

void check_commandGetResult (tcpip::Storage &inMsg, int command, int expectedType=-1, bool ignoreCommandId=false) const
void processGET (tcpip::Storage &inMsg, int command, int expectedType, bool ignoreCommandId=false)
const

Protected Attributes
tcpip::Socket mySocket
The socket.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

236

Class Documentation

5.105.1

Member Function Documentation

5.105.1.1

void TraCIAPI::check_resultState ( tcpip::Storage & inMsg, int command, bool ignoreCommandId = false,
std::string acknowledgement = 0 ) const [protected], [inherited]

Validates the result state of a command.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.105 SUMO_CLIENT Class Reference

237

Parameters
inMsg
command
ignoreCommandId
acknowledgement

in
in
in
in

5.105.1.2

The buffer to read the message from


The original command id
Whether the returning command id shall be validated
Pointer to an existing string into which the acknowledgement message shall
be inserted

void TraCIAPI::connect ( const std::string & host, int port ) [inherited]

Connects to the specified SUMO server.


Parameters
host
port

in
in

The name of the host to connect to


The port to connect to

Exceptions
tcpip::SocketException

5.105.1.3

if the connection fails

void TraCIAPI::send_commandGetVariable ( int domID, int varID, const std::string & objID, tcpip::Storage add =

0 ) const [protected], [inherited]


Sends a GetVariable request.
Parameters
domID
varID
objID
add

in
in
in
in

5.105.1.4

The domain of the variable


The variable to retrieve
The object to retrieve the variable from
Optional additional parameter

void TraCIAPI::send_commandSetValue ( int domID, int varID, const std::string & objID, tcpip::Storage & content
) const [protected], [inherited]

Sends a SetVariable request.


Parameters

in
in
in
in

5.105.1.5

domID
varID
objID
content

The domain of the variable


The variable to set
The object to change
The value of the variable

void TraCIAPI::send_commandSubscribeObjectContext ( int domID, const std::string & objID, int beginTime,
int endTime, int domain, SUMOReal range, const std::vector< int > & vars ) const [protected],

[inherited]
Sends a SubscribeContext request.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

238

Class Documentation

Parameters
domID
objID
beginTime
endTime
domain
range
vars

in
in
in
in
in
in
in

5.105.1.6

The domain of the variable


The object to subscribe the variables from
The begin time step of subscriptions
The end time step of subscriptions
The domain of the objects which values shall be returned
The range around the obj to investigate
The variables to subscribe

void TraCIAPI::send_commandSubscribeObjectVariable ( int domID, const std::string & objID, int beginTime, int
endTime, const std::vector< int > & vars ) const [protected], [inherited]

Sends a SubscribeVariable request.


Parameters

in
in
in
in
in

domID
objID
beginTime
endTime
vars

The domain of the variable


The object to subscribe the variables from
The begin time step of subscriptions
The end time step of subscriptions
The variables to subscribe

The documentation for this class was generated from the following files:
src/sumo/include/sumo/sumo_client.hpp
src/sumo/src/sumo/sumo_client.cpp

5.106

sumo_intf Class Reference

Component Message and Service Headers.

#include <sumo_intf.hpp>
Inheritance diagram for sumo_intf:

Component
sumo_intf

Public Member Functions


sumo_intf (ComponentConfig &_config, int argc, char argv)
sumo_intf Constructor.

void init_timer_operation (const NAMESPACE::TimerEvent &event)


sumo_intf Initializer This operation is executed immediately after startup.

void sumo_step_timer_operation (const NAMESPACE::TimerEvent &event)


sumo_step_timer_operation;

bool tlc_get_ryg_state_server_operation (const tlc_package::tlc_get_ryg_state::Request &req, tlc_package::tlc_get_ryg_state::Response &res)


tlc_get_ryg_state_server_operation;

bool tlc_set_ryg_state_server_operation (const tlc_package::tlc_set_ryg_state::Request &req, tlc_package::tlc_set_ryg_state::Response &res)


Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.106 sumo_intf Class Reference

239

tlc_set_ryg_state_server_operation;

bool e3_get_vehicle_number_server_operation (const tlc_package::e3_get_vehicle_number::Request &req,


tlc_package::e3_get_vehicle_number::Response &res)
e3_get_vehicle_number_server_operation;

void startUp ()
Component startup function.

sumo_intf ()
sumo_intf Destructor

virtual void component_sync_operation (const std_msgs::Bool::ConstPtr &received_data)


Component Synchronization This operation establishing a sync point with other components.

void process_queue ()
Component Message Queue handler.

Protected Attributes

ComponentConfig config
int node_argc
char node_argv
NAMESPACE::Publisher comp_sync_pub
NAMESPACE::Subscriber comp_sync_sub
NAMESPACE::Timer init_timer
NAMESPACE::CallbackQueue comp_queue
std::unique_ptr< Logger > logger

5.106.1

Detailed Description

Component Message and Service Headers.


Forward declarations sumo_intf class

5.106.2

Constructor & Destructor Documentation

5.106.2.1

sumo_intf::sumo_intf ( ComponentConfig & _config, int argc, char argv ) [inline]

sumo_intf Constructor.
Parameters
_config
argc
argv

in
in

5.106.3
5.106.3.1

Component configuration parsed from deployment XML


command-line argument count
command-line arguments of the actor process

Member Function Documentation


void Component::component_sync_operation ( const std_msgs::Bool::ConstPtr & received_data ) [virtual],

[inherited]
Component Synchronization This operation establishing a sync point with other components.
Parameters

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

240

Class Documentation

received_data

in

5.106.3.2

Notification message from other components

bool sumo_intf::e3_get_vehicle_number_server_operation ( const tlc_package::e3_get_vehicle_number::Request &


req, tlc_package::e3_get_vehicle_number::Response & res )

e3_get_vehicle_number_server_operation;
This operation is executed every time the e3_get_vehicle_number_server operation request is serviced
Parameters
req
res

in
out

5.106.3.3

request received from the client


response sent back to the client

void sumo_intf::init_timer_operation ( const NAMESPACE::TimerEvent & event ) [virtual]

sumo_intf Initializer This operation is executed immediately after startup.


Parameters
event

in

a oneshot timer event

See Also
startUp()
Reimplemented from Component.

5.106.3.4

void sumo_intf::startUp ( ) [virtual]

Component startup function.


This function configures all the component ports and timers
Implements Component.

5.106.3.5

void sumo_intf::sumo_step_timer_operation ( const NAMESPACE::TimerEvent & event )

sumo_step_timer_operation;
This operation is executed every time the sumo_step_timer operation request is serviced
Parameters

in

5.106.3.6

event

a timer event

bool sumo_intf::tlc_get_ryg_state_server_operation ( const tlc_package::tlc_get_ryg_state::Request & req,


tlc_package::tlc_get_ryg_state::Response & res )

tlc_get_ryg_state_server_operation;
This operation is executed every time the tlc_get_ryg_state_server operation request is serviced

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.106 sumo_intf Class Reference

241

Parameters
req
res

in
out

5.106.3.7

request received from the client


response sent back to the client

bool sumo_intf::tlc_set_ryg_state_server_operation ( const tlc_package::tlc_set_ryg_state::Request & req,


tlc_package::tlc_set_ryg_state::Response & res )

tlc_set_ryg_state_server_operation;
This operation is executed every time the tlc_set_ryg_state_server operation request is serviced
Parameters
req
res

in
out

request received from the client


response sent back to the client

5.106.4

Member Data Documentation

5.106.4.1

NAMESPACE::CallbackQueue Component::comp_queue [protected], [inherited]

Component Message Queue

5.106.4.2

NAMESPACE::Publisher Component::comp_sync_pub [protected], [inherited]

Synchronization publisher

5.106.4.3

NAMESPACE::Subscriber Component::comp_sync_sub [protected], [inherited]

Synchronization subscriber

5.106.4.4 ComponentConfig Component::config [protected], [inherited]


Component Configuration

5.106.4.5

NAMESPACE::Timer Component::init_timer [protected], [inherited]

Initialization timer

5.106.4.6

std::unique_ptr<Logger> Component::logger [protected], [inherited]

Component logger object

5.106.4.7

int Component::node_argc [protected], [inherited]

argc received by the actor process

5.106.4.8

char Component::node_argv [protected], [inherited]

argv received by the actor process


The documentation for this class was generated from the following files:
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

242

Class Documentation

src/tlc_package/include/tlc_package/sumo_intf.hpp
src/tlc_package/src/tlc_package/sumo_intf.cpp

5.107

SUMORouteHandler Class Reference

Parser for routes during their loading.

#include <SUMORouteHandler.h>
Inheritance diagram for SUMORouteHandler:

DefaultHandler

GenericSAXHandler

SUMOSAXHandler

SUMORouteHandler

Public Member Functions


SUMORouteHandler (const std::string &file)
standard constructor

virtual SUMORouteHandler ()
standard destructor

SUMOTime getLastDepart () const


Returns the last loaded depart time.

SUMOTime getFirstDepart () const


returns the first departure time that was ever read

void startElement (const XMLCh const uri, const XMLCh const localname, const XMLCh const qname,
const XERCES_CPP_NAMESPACE::Attributes &attrs)
The inherited method called when a new tag opens.

void characters (const XMLCh const chars, const XERCES3_SIZE_t length)


The inherited method called when characters occured.

void endElement (const XMLCh const uri, const XMLCh const localname, const XMLCh const qname)
The inherited method called when a tag is being closed.

void registerParent (const int tag, GenericSAXHandler handler)


Assigning a parent handler which is enabled when the specified tag is closed.

void setFileName (const std::string &name)


Sets the current file name.

const std::string & getFileName () const


returns the current file name

SAX ErrorHandler callbacks


void warning (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
Handler for XML-warnings.

void error (const XERCES_CPP_NAMESPACE::SAXParseException &exception)


Handler for XML-errors.

void fatalError (const XERCES_CPP_NAMESPACE::SAXParseException &exception)


Handler for XML-errors.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.107 SUMORouteHandler Class Reference

243

Static Public Member Functions


static bool checkStopPos (SUMOReal &startPos, SUMOReal &endPos, const SUMOReal laneLength, const
SUMOReal minLength, const bool friendlyPos)
check start and end position of a stop

Protected Member Functions


virtual void openVehicleTypeDistribution (const SUMOSAXAttributes &attrs)=0
opens a type distribution for reading

virtual void closeVehicleTypeDistribution ()=0


closes (ends) the building of a distribution

virtual void openRoute (const SUMOSAXAttributes &attrs)=0


opens a route for reading

virtual void closeRoute (const bool mayBeDisconnected=false)=0


closes (ends) the building of a route.

virtual void openRouteDistribution (const SUMOSAXAttributes &attrs)=0


opens a route distribution for reading

virtual void closeRouteDistribution ()=0


closes (ends) the building of a distribution

virtual void closeVehicle ()=0


Ends the processing of a vehicle.

virtual void closePerson ()=0


Ends the processing of a person.

virtual void closeContainer ()=0


Ends the processing of a container.

virtual void closeFlow ()=0


Ends the processing of a flow.

virtual void addStop (const SUMOSAXAttributes &attrs)=0


Processing of a stop.

bool checkLastDepart ()
Checks whether the route file is sorted by departure time if needed.

void registerLastDepart ()
save last depart (only to be used if vehicle is not discarded)

void addParam (const SUMOSAXAttributes &attrs)


assign arbitrary vehicle parameters

bool parseStop (SUMOVehicleParameter::Stop &stop, const SUMOSAXAttributes &attrs, std::string errorSuffix, MsgHandler const errorOutput)
parses attributes common to all stops

std::string buildErrorMessage (const XERCES_CPP_NAMESPACE::SAXParseException &exception)


Builds an error message.

virtual void myCharacters (int element, const std::string &chars)


Callback method for characters to implement by derived classes.

inherited from GenericSAXHandler


virtual void myStartElement (int element, const SUMOSAXAttributes &attrs)
Called on the opening of a tag;.

virtual void myEndElement (int element)


Called when a closing tag occurs.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

244

Class Documentation

Protected Attributes
SUMOVehicleParameter myVehicleParameter
Parameter of the current vehicle, trip, person, container or flow.

SUMOTime myLastDepart
The insertion time of the vehicle read last.

std::string myActiveRouteID
The id of the current route.

std::string myActiveRouteRefID
The id of the route the current route references to.

SUMOReal myActiveRouteProbability
The probability of the current route.

const RGBColor myActiveRouteColor


The currently parsed routes color.

SUMOReal myCurrentCosts
The currently parsed route costs.

std::vector
< SUMOVehicleParameter::Stop > myActiveRouteStops
List of the stops on the parsed route.

SUMOVTypeParameter myCurrentVType
The currently parsed vehicle type.

IDSupplier myIdSupplier
generates numerical ids

SUMOTime myBeginDefault
The default value for flow begins.

SUMOTime myEndDefault
The default value for flow ends.

SUMOTime myFirstDepart
the first read departure time

int myInsertStopEdgesAt
where stop edges can be inserted into the current route (-1 means no insertion)

5.107.1

Detailed Description

Parser for routes during their loading.


SUMORouteHandler is the abstract super class for routers and simulation loading routes.

5.107.2

Member Function Documentation

5.107.2.1

std::string GenericSAXHandler::buildErrorMessage ( const XERCES_CPP_NAMESPACE::SAXParseException &


exception ) [protected], [inherited]

Builds an error message.


The error message includes the file name and the line/column information as supported by the given SAXParseException
Parameters

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.107 SUMORouteHandler Class Reference

exception

in

245

The name of the currently processed file

Returns
A string describing the given exception

5.107.2.2

void GenericSAXHandler::characters ( const XMLCh const chars, const XERCES3_SIZE_t length )

[inherited]
The inherited method called when characters occured.
The retrieved characters are converted into a string and appended into a private buffer. They are reported as soon
as the element ends.
Todo recheck/describe what happens with characters when a new element is opened
describe characters processing in the class head

5.107.2.3

virtual void SUMORouteHandler::closeRoute ( const bool mayBeDisconnected = false ) [protected],

[pure virtual]
closes (ends) the building of a route.
Afterwards no edges may be added to it; this method may throw exceptions when a) the route is empty or b) another
route with the same id already exists

5.107.2.4

void GenericSAXHandler::endElement ( const XMLCh const uri, const XMLCh const localname, const XMLCh

const qname ) [inherited]


The inherited method called when a tag is being closed.
This method calls the user-implemented methods myCharacters with the previously collected and converted characters.
Then, myEndElement is called, supplying it the qname converted to its enum- and string-representations.
Todo recheck/describe encoding of the string-representation
do not generate and report the string-representation

5.107.2.5

void GenericSAXHandler::error ( const XERCES_CPP_NAMESPACE::SAXParseException & exception )

[inherited]
Handler for XML-errors.
The message is built using buildErrorMessage and thrown within a ProcessError.
Parameters

in

exception

The occured exception to process

Exceptions

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

246

Class Documentation

ProcessError

5.107.2.6

On any call

void GenericSAXHandler::fatalError ( const XERCES_CPP_NAMESPACE::SAXParseException & exception )

[inherited]
Handler for XML-errors.
The message is built using buildErrorMessage and thrown within a ProcessError.
Exceptions
ProcessError

On any call

Parameters
exception

in

5.107.2.7

The occured exception to process

const std::string& GenericSAXHandler::getFileName ( ) const [inherited]

returns the current file name


Returns
The name of the currently processed file

5.107.2.8

virtual void GenericSAXHandler::myCharacters ( int element, const std::string & chars ) [protected],

[virtual], [inherited]
Callback method for characters to implement by derived classes.
Called by "endElement" (see there).
Parameters
element
chars

in
in

5.107.2.9

The opened element, given as a int


The complete embedded character string ProcessError These method may
throw a ProcessError if something fails

virtual void SUMORouteHandler::myEndElement ( int element ) [protected], [virtual]

Called when a closing tag occurs.


Parameters

in

element

ID of the currently opened element

Exceptions
ProcessError

If something fails

See Also
GenericSAXHandler::myEndElement
Reimplemented from GenericSAXHandler.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.107 SUMORouteHandler Class Reference

5.107.2.10

virtual void SUMORouteHandler::myStartElement ( int element, const SUMOSAXAttributes & attrs )

[protected], [virtual]
Called on the opening of a tag;.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

247

248

Class Documentation

Parameters
element
attrs

in
in

ID of the currently opened element


Attributes within the currently opened element

Exceptions
ProcessError

If something fails

See Also
GenericSAXHandler::myStartElement
Reimplemented from GenericSAXHandler.

5.107.2.11

void GenericSAXHandler::setFileName ( const std::string & name ) [inherited]

Sets the current file name.


Parameters
name

in

The name of the currently processed file

Todo Hmmm - this is as unsafe as having a direct access to the variable; recheck

void GenericSAXHandler::startElement ( const XMLCh const uri, const XMLCh const localname, const XMLCh
const qname, const XERCES_CPP_NAMESPACE::Attributes & attrs ) [inherited]

5.107.2.12

The inherited method called when a new tag opens.


The method parses the supplied XMLCh-qname using the internal name/enum-map to obtain the enum representation of the attribute name.
Then, "myStartElement" is called supplying the enumeration value, the string-representation of the name and the
attributes.
Todo recheck/describe encoding of the string-representation
do not generate and report the string-representation

5.107.2.13

void GenericSAXHandler::warning ( const XERCES_CPP_NAMESPACE::SAXParseException & exception )

[inherited]
Handler for XML-warnings.
The message is built using buildErrorMessage and reported to the warning-instance of the MsgHandler.
Parameters

in

exception

The occured exception to process

The documentation for this class was generated from the following file:
src/sumo/include/utils/xml/SUMORouteHandler.h

5.108

SUMORouteLoader Class Reference


Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.109 SUMORouteLoaderControl Class Reference

249

Public Member Functions


SUMORouteLoader (SUMORouteHandler handler)
constructor

SUMORouteLoader ()
destructor

SUMOTime loadUntil (SUMOTime time)


loads vehicles until a vehicle is read that starts after the specified time

bool moreAvailable () const


returns the information whether new data is available

SUMOTime getFirstDepart () const


returns the first departure time that was ever read

The documentation for this class was generated from the following file:
src/sumo/include/utils/xml/SUMORouteLoader.h

5.109

SUMORouteLoaderControl Class Reference

SUMORouteLoaderControl This controls is initialised with the list of route loaders and uses them to load routes step
wise.

#include <SUMORouteLoaderControl.h>

Public Member Functions


SUMORouteLoaderControl (SUMOTime inAdvanceStepNo)
constructor

SUMORouteLoaderControl ()
destructor

void add (SUMORouteLoader loader)


add another loader

void loadNext (SUMOTime step)


loads the next routes up to and including the given time step

SUMOTime getFirstLoadTime () const


returns the timestamp of the first loaded vehicle or flow

bool haveAllLoaded () const


returns whether loading is completed

5.109.1

Detailed Description

SUMORouteLoaderControl This controls is initialised with the list of route loaders and uses them to load routes step
wise.
The parameter myInAdvanceStepNo holds the number of time steps to read the routes in forward. If it is 0 (default),
all routes will be read at once.
The documentation for this class was generated from the following file:
src/sumo/include/utils/xml/SUMORouteLoaderControl.h
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

250

Class Documentation

5.110

SUMOSAXAttributes Class Reference

Encapsulated SAX-Attributes.

#include <SUMOSAXAttributes.h>
Inheritance diagram for SUMOSAXAttributes:

SUMOSAXAttributes
SUMOSAXAttributesImpl_Binary

SUMOSAXAttributesImpl_Xerces

Public Member Functions


SUMOSAXAttributes (const std::string &objectType)
virtual SUMOSAXAttributes ()
Destructor.

template<typename T >
T get (int attr, const char objectid, bool &ok, bool report=true) const
Tries to read given attribute assuming it is an int.

template<typename T >
T getOpt (int attr, const char objectid, bool &ok, T defaultValue, bool report=true) const
Tries to read given attribute assuming it is an int.

SUMOTime getSUMOTimeReporting (int attr, const char objectid, bool &ok, bool report=true) const
Tries to read given attribute assuming it is a SUMOTime.

SUMOTime getOptSUMOTimeReporting (int attr, const char objectid, bool &ok, SUMOTime defaultValue,
bool report=true) const
Tries to read given attribute assuming it is a SUMOTime.

virtual methods for retrieving attribute values


static const std::string ENCODING
The encoding of parsed strings.

virtual bool hasAttribute (int id) const =0


Returns the information whether the named (by its enum-value) attribute is within the current list.

virtual bool hasAttribute (const std::string &id) const =0


Returns the information whether the named attribute is within the current list.

virtual bool getBool (int id) const =0


Returns the bool-value of the named (by its enum-value) attribute.

virtual int getInt (int id) const =0


Returns the int-value of the named (by its enum-value) attribute.

virtual SUMOLong getLong (int id) const =0


Returns the long-value of the named (by its enum-value) attribute.

virtual std::string getString (int id) const =0


Returns the string-value of the named (by its enum-value) attribute.

virtual std::string getStringSecure (int id, const std::string &def) const =0


Returns the string-value of the named (by its enum-value) attribute.

virtual SUMOReal getFloat (int id) const =0


Returns the SUMOReal-value of the named (by its enum-value) attribute.

virtual SUMOReal getFloat (const std::string &id) const =0


Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.110 SUMOSAXAttributes Class Reference

251

Returns the SUMOReal-value of the named attribute.

virtual std::string getStringSecure (const std::string &id, const std::string &def) const =0
Returns the string-value of the named (by its enum-value) attribute.

virtual SumoXMLEdgeFunc getEdgeFunc (bool &ok) const =0


Returns the value of the named attribute.

virtual SumoXMLNodeType getNodeType (bool &ok) const =0


Returns the value of the named attribute.

virtual RGBColor getColor () const =0


Returns the value of the named attribute.

virtual PositionVector getShape (int attr) const =0


Tries to read given attribute assuming it is a PositionVector.

virtual Boundary getBoundary (int attr) const =0


Tries to read given attribute assuming it is a Boundary.

virtual std::vector< std::string > getStringVector (int attr) const =0


Tries to read given attribute assuming it is a string vector.

virtual std::string getName (int attr) const =0


Converts the given attribute id into a man readable string.

virtual void serialize (std::ostream &os) const =0


Prints all attribute names and values into the given stream.

const std::string & getObjectType () const


return the objecttype to which these attributes belong

std::ostream & operator<< (std::ostream &os, const SUMOSAXAttributes &src)


static void parseStringVector (const std::string &def, std::vector< std::string > &into)
Splits the given string.

static void parseStringSet (const std::string &def, std::set< std::string > &into)
Splits the given string, stores it in a set.

template<typename T >
T getInternal (const int attr) const
void emitUngivenError (const std::string &attrname, const char objectid) const
void emitEmptyError (const std::string &attrname, const char objectid) const
void emitFormatError (const std::string &attrname, const std::string &type, const char objectid) const

5.110.1

Detailed Description

Encapsulated SAX-Attributes.
This class is an interface for using encapsulated SAX-attributes. Encapsulation is done to allow a common acces
without the need to import all the Xerces-definitions.

5.110.2

Member Function Documentation

5.110.2.1

template<typename T > T SUMOSAXAttributes::get ( int attr, const char objectid, bool & ok, bool report = true
) const

Tries to read given attribute assuming it is an int.


If an error occurs (the attribute is not there, it is not numeric), "ok" is set to false. If report is true an error message
is written to MsgHandler::getErrorInstance.
If the value could be read, "ok" is not changed, and the value is returned.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

252

Class Documentation

Parameters
attr
objectid
ok
report

in
in
out
in

The id of the attribute to read


The name of the parsed object; used for error message generation
Whether the value could be read
Whether errors shall be written to msg handlers error instance

Returns
The read value if given and correct; -1 if an error occured

5.110.2.2

virtual bool SUMOSAXAttributes::getBool ( int id ) const [pure virtual]

Returns the bool-value of the named (by its enum-value) attribute.


Tries to retrieve the attribute from the the attribute list. The retrieved attribute (which may be 0) is then parsed using
TplConvert<XMLCh>::_2bool. If the attribute is empty or ==0, TplConvert<XMLCh>::_2bool throws an EmptyData-exception which is passed. If the value can not be parsed to a bool, TplConvert<XMLCh>::_2bool throws a
BoolFormatException-exception which is passed.
Parameters
id

in

The id of the attribute to return the value of

Returns
The attributes value as a bool, if it could be read and parsed
Exceptions
EmptyData
BoolFormatException

If the attribute is not known or the attribute value is an empty string


If the attribute value can not be parsed to a bool

Implemented in SUMOSAXAttributesImpl_Binary, and SUMOSAXAttributesImpl_Xerces.

5.110.2.3

virtual Boundary SUMOSAXAttributes::getBoundary ( int attr ) const [pure virtual]

Tries to read given attribute assuming it is a Boundary.


Parameters

in

attr

The id of the attribute to read

Returns
The read value if given and not empty; empty Boundary if an error occured
Implemented in SUMOSAXAttributesImpl_Binary, and SUMOSAXAttributesImpl_Xerces.

5.110.2.4

virtual RGBColor SUMOSAXAttributes::getColor ( ) const [pure virtual]

Returns the value of the named attribute.


Tries to retrieve the attribute from the the attribute list.
Returns
The attributes value as a RGBColor, if it could be read and parsed
Implemented in SUMOSAXAttributesImpl_Binary, and SUMOSAXAttributesImpl_Xerces.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.110 SUMOSAXAttributes Class Reference

5.110.2.5

253

virtual SumoXMLEdgeFunc SUMOSAXAttributes::getEdgeFunc ( bool & ok ) const [pure virtual]

Returns the value of the named attribute.


Tries to retrieve the attribute from the the attribute list.
Returns
The attributes value as a string, if it could be read and parsed
Implemented in SUMOSAXAttributesImpl_Binary, and SUMOSAXAttributesImpl_Xerces.

5.110.2.6

virtual SUMOReal SUMOSAXAttributes::getFloat ( int id ) const [pure virtual]

Returns the SUMOReal-value of the named (by its enum-value) attribute.


Tries to retrieve the attribute from the the attribute list. The retrieved attribute (which may be 0) is then parsed
using TplConvert<XMLCh>::_2SUMOReal. If the attribute is empty or ==0, TplConvert<XMLCh>::_2SUMOReal
throws an EmptyData-exception which is passed. If the value can not be parsed to a SUMOReal, TplConvert<XMLCh>::_2SUMOReal throws a NumberFormatException-exception which is passed.
Parameters
id

in

The id of the attribute to return the value of

Returns
The attributes value as a float, if it could be read and parsed
Exceptions
EmptyData
NumberFormatException

If the attribute is not known or the attribute value is an empty string


If the attribute value can not be parsed to an SUMOReal

Implemented in SUMOSAXAttributesImpl_Binary, and SUMOSAXAttributesImpl_Xerces.

5.110.2.7

virtual SUMOReal SUMOSAXAttributes::getFloat ( const std::string & id ) const [pure virtual]

Returns the SUMOReal-value of the named attribute.


Tries to retrieve the attribute from the the attribute list. The retrieved attribute (which may be 0) is then parsed
using TplConvert<XMLCh>::_2SUMOReal. If the attribute is empty or ==0, TplConvert<XMLCh>::_2SUMOReal
throws an EmptyData-exception which is passed. If the value can not be parsed to a SUMOReal, TplConvert<XMLCh>::_2SUMOReal throws a NumberFormatException-exception which is passed.
Parameters
id

in

The name of the attribute to return the value of

Returns
The attributes value as a float, if it could be read and parsed
Exceptions
EmptyData

If the attribute is not known or the attribute value is an empty string

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

254

Class Documentation

NumberFormatException

If the attribute value can not be parsed to an SUMOReal

Implemented in SUMOSAXAttributesImpl_Binary, and SUMOSAXAttributesImpl_Xerces.

5.110.2.8

virtual int SUMOSAXAttributes::getInt ( int id ) const [pure virtual]

Returns the int-value of the named (by its enum-value) attribute.


Tries to retrieve the attribute from the the attribute list. The retrieved attribute (which may be 0) is then parsed
using TplConvert<XMLCh>::_2int. If the attribute is empty or ==0, TplConvert<XMLCh>::_2int throws an EmptyData-exception which is passed. If the value can not be parsed to an int, TplConvert<XMLCh>::_2int throws a
NumberFormatException-exception which is passed.
Parameters
id

in

The id of the attribute to return the value of

Returns
The attributes value as an int, if it could be read and parsed
Exceptions
EmptyData
NumberFormatException

If the attribute is not known or the attribute value is an empty string


If the attribute value can not be parsed to an int

Implemented in SUMOSAXAttributesImpl_Binary, and SUMOSAXAttributesImpl_Xerces.

5.110.2.9

virtual SUMOLong SUMOSAXAttributes::getLong ( int id ) const [pure virtual]

Returns the long-value of the named (by its enum-value) attribute.


Tries to retrieve the attribute from the the attribute list. The retrieved attribute (which may be 0) is then parsed using
TplConvert<XMLCh>::_2long. If the attribute is empty or ==0, TplConvert<XMLCh>::_2long throws an EmptyData-exception which is passed. If the value can not be parsed to a long, TplConvert<XMLCh>::_2long throws a
NumberFormatException-exception which is passed.
Parameters
id

in

The id of the attribute to return the value of

Returns
The attributes value as an int, if it could be read and parsed
Exceptions
EmptyData
NumberFormatException

If the attribute is not known or the attribute value is an empty string


If the attribute value can not be parsed to an int

Implemented in SUMOSAXAttributesImpl_Binary, and SUMOSAXAttributesImpl_Xerces.

5.110.2.10

virtual std::string SUMOSAXAttributes::getName ( int attr ) const [pure virtual]

Converts the given attribute id into a man readable string.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.110 SUMOSAXAttributes Class Reference

255

Parameters

in

attr

The id of the attribute to return the name of

Returns
The name of the described attribute
Implemented in SUMOSAXAttributesImpl_Binary, and SUMOSAXAttributesImpl_Xerces.

5.110.2.11

virtual SumoXMLNodeType SUMOSAXAttributes::getNodeType ( bool & ok ) const [pure virtual]

Returns the value of the named attribute.


Tries to retrieve the attribute from the the attribute list.
Returns
The attributes value as a string, if it could be read and parsed
Implemented in SUMOSAXAttributesImpl_Binary, and SUMOSAXAttributesImpl_Xerces.

5.110.2.12

template<typename T > T SUMOSAXAttributes::getOpt ( int attr, const char objectid, bool & ok, T defaultValue,
bool report = true ) const

Tries to read given attribute assuming it is an int.


If the attribute is not existing in the current element, the default value is returned. If an error occurs on parsing (the
attribute is empty, it is not numeric), "ok" is set to false. If report is true an error message is written to MsgHandler::getErrorInstance.
If the value could be read, "ok" is not changed, and the value is returned.
Parameters

in
in
out
in
in

attr
objectid
ok
defaultValue
report

The id of the attribute to read


The name of the parsed object; used for error message generation
Whether the value could be read
The value to return if the attribute is not within the element
Whether errors shall be written to msg handlers error instance

Returns
The read value if given and correct; the default value if the attribute does not exist; -1 if an error occured

5.110.2.13

SUMOTime SUMOSAXAttributes::getOptSUMOTimeReporting ( int attr, const char objectid, bool & ok,
SUMOTime defaultValue, bool report = true ) const

Tries to read given attribute assuming it is a SUMOTime.


If the attribute is not existing in the current element, the default value is returned. If an error occurs on parsing (the
attribute is empty, it is not numeric), "ok" is set to false. If report is true an error message is written to MsgHandler::getErrorInstance.
Otherwise, "ok" is not changed.
In dependence to the used time representation, either get<int> or get<SUMOReal> is used.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

256

Class Documentation

Parameters

in
in
out
in
in

attr
objectid
ok
defaultValue
report

The id of the attribute to read


The name of the parsed object; used for error message generation
Whether the value could be read
The value to return if the attribute is not within the element
Whether errors shall be written to msg handlers error instance

Returns
The read value if given and correct; the default value if the attribute does not exist; -1 if an error occured

5.110.2.14

virtual PositionVector SUMOSAXAttributes::getShape ( int attr ) const [pure virtual]

Tries to read given attribute assuming it is a PositionVector.


Parameters
attr

in

The id of the attribute to read

Returns
The read value if given and not empty; empty position vector if an error occured
Implemented in SUMOSAXAttributesImpl_Binary, and SUMOSAXAttributesImpl_Xerces.

5.110.2.15

virtual std::string SUMOSAXAttributes::getString ( int id ) const [pure virtual]

Returns the string-value of the named (by its enum-value) attribute.


Tries to retrieve the attribute from the the attribute list. The retrieved attribute (which may be 0) is then parsed using
TplConvert<XMLCh>::_2str. If the attribute is ==0, TplConvert<XMLCh>::_2str throws an EmptyData-exception
which is passed.
Parameters
id

in

The id of the attribute to return the value of

Returns
The attributes value as a string, if it could be read and parsed
Exceptions
EmptyData

If the attribute is not known or the attribute value is an empty string

Implemented in SUMOSAXAttributesImpl_Binary, and SUMOSAXAttributesImpl_Xerces.

5.110.2.16

virtual std::string SUMOSAXAttributes::getStringSecure ( int id, const std::string & def ) const [pure

virtual]
Returns the string-value of the named (by its enum-value) attribute.
Tries to retrieve the attribute from the the attribute list. The retrieved attribute (which may be 0) is then parsed using
TplConvert<XMLCh>::_2strSec. If the attribute is ==0, TplConvert<XMLCh>::_2strSec returns the default value.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.110 SUMOSAXAttributes Class Reference

257

Parameters
id
def

in
in

The id of the attribute to return the value of


The default value to return if the attribute is not in attributes

Returns
The attributes value as a string, if it could be read and parsed
Exceptions
EmptyData

If the attribute is not known or the attribute value is an empty string

Implemented in SUMOSAXAttributesImpl_Binary, and SUMOSAXAttributesImpl_Xerces.

5.110.2.17

virtual std::string SUMOSAXAttributes::getStringSecure ( const std::string & id, const std::string & def ) const

[pure virtual]
Returns the string-value of the named (by its enum-value) attribute.
Tries to retrieve the attribute from the the attribute list. If the attribute is ==0, TplConvert<XMLCh>::_2strSec
returns the default value.
Parameters
id
def

in
in

The name of the attribute to return the value of


The default value to return if the attribute is not in attributes

Returns
The attributes value as a string, if it could be read and parsed
Implemented in SUMOSAXAttributesImpl_Binary, and SUMOSAXAttributesImpl_Xerces.

5.110.2.18

virtual std::vector<std::string> SUMOSAXAttributes::getStringVector ( int attr ) const [pure virtual]

Tries to read given attribute assuming it is a string vector.


Parameters
attr

in

The id of the attribute to read

Returns
The read value if given and not empty; empty vector if an error occured
Implemented in SUMOSAXAttributesImpl_Binary, and SUMOSAXAttributesImpl_Xerces.

5.110.2.19

SUMOTime SUMOSAXAttributes::getSUMOTimeReporting ( int attr, const char objectid, bool & ok, bool report =

true ) const
Tries to read given attribute assuming it is a SUMOTime.
If an error occurs (the attribute is not there, it is not numeric), "ok" is set to false and an error message is written to
MsgHandler::getErrorInstance.
Otherwise, "ok" is not changed.
In dependence to the used time representation, either get<int> or get<SUMOReal> is used.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

258

Class Documentation

Parameters
attr
objectid
ok
report

in
in
out
in

The id of the attribute to read


The name of the parsed object; used for error message generation
Whether the value could be read
Whether errors shall be written to msg handlers error instance

Returns
The read value if given and correct; -1 if an error occured

5.110.2.20

virtual bool SUMOSAXAttributes::hasAttribute ( int id ) const [pure virtual]

Returns the information whether the named (by its enum-value) attribute is within the current list.
Parameters
id

in

The id of the attribute to search for

Returns
Whether the attribute is within the attributes
Implemented in SUMOSAXAttributesImpl_Binary, and SUMOSAXAttributesImpl_Xerces.

5.110.2.21

virtual bool SUMOSAXAttributes::hasAttribute ( const std::string & id ) const [pure virtual]

Returns the information whether the named attribute is within the current list.
Parameters
id

in

The name of the attribute to search for

Returns
Whether the named attribute is within the attributes
Implemented in SUMOSAXAttributesImpl_Binary, and SUMOSAXAttributesImpl_Xerces.

5.110.2.22

static void SUMOSAXAttributes::parseStringSet ( const std::string & def, std::set< std::string > & into )

[static]
Splits the given string, stores it in a set.
Spaces, ",", and ";" are assumed to be separator characters. Though, in the case a "," or a ";" occurs, a warning is
generated (once).
Parameters
def
into

in
out

5.110.2.23

The string to split


The set to fill

static void SUMOSAXAttributes::parseStringVector ( const std::string & def, std::vector< std::string > & into )

[static]
Splits the given string.
Spaces, ",", and ";" are assumed to be separator characters. Though, in the case a "," or a ";" occurs, a warning is
generated (once).
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.111 SUMOSAXAttributesImpl_Binary Class Reference

259

Parameters
def
into

in
out

5.110.2.24

The string to split


The vector to fill

virtual void SUMOSAXAttributes::serialize ( std::ostream & os ) const [pure virtual]

Prints all attribute names and values into the given stream.
Parameters
os

in

The stream to use

Implemented in SUMOSAXAttributesImpl_Binary, and SUMOSAXAttributesImpl_Xerces.


The documentation for this class was generated from the following file:
src/sumo/include/utils/xml/SUMOSAXAttributes.h

5.111

SUMOSAXAttributesImpl_Binary Class Reference

Encapsulated Xerces-SAX-attributes.

#include <SUMOSAXAttributesImpl_Binary.h>
Inheritance diagram for SUMOSAXAttributesImpl_Binary:

SUMOSAXAttributes
SUMOSAXAttributesImpl_Binary

Public Member Functions


SUMOSAXAttributesImpl_Binary (const std::map< int, std::string > &predefinedTagsMML, const std::string
&objectType, BinaryInputDevice in)
Constructor.

virtual SUMOSAXAttributesImpl_Binary ()
Destructor.

template<typename T >
T get (int attr, const char objectid, bool &ok, bool report=true) const
Tries to read given attribute assuming it is an int.

template<typename T >
T getOpt (int attr, const char objectid, bool &ok, T defaultValue, bool report=true) const
Tries to read given attribute assuming it is an int.

SUMOTime getSUMOTimeReporting (int attr, const char objectid, bool &ok, bool report=true) const
Tries to read given attribute assuming it is a SUMOTime.

SUMOTime getOptSUMOTimeReporting (int attr, const char objectid, bool &ok, SUMOTime defaultValue,
bool report=true) const
Tries to read given attribute assuming it is a SUMOTime.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

260

Class Documentation

virtual methods for retrieving attribute values


const std::string & getObjectType () const
return the objecttype to which these attributes belong

static const std::string ENCODING


The encoding of parsed strings.

static void parseStringVector (const std::string &def, std::vector< std::string > &into)
Splits the given string.

static void parseStringSet (const std::string &def, std::set< std::string > &into)
Splits the given string, stores it in a set.

template<typename T >
T getInternal (const int attr) const
void emitUngivenError (const std::string &attrname, const char objectid) const
void emitEmptyError (const std::string &attrname, const char objectid) const
void emitFormatError (const std::string &attrname, const std::string &type, const char objectid) const

methods for retrieving attribute values


bool hasAttribute (int id) const
Returns the information whether the named (by its enum-value) attribute is within the current list.

bool getBool (int id) const


Returns the bool-value of the named (by its enum-value) attribute.

int getInt (int id) const


Returns the int-value of the named (by its enum-value) attribute.

SUMOLong getLong (int id) const


Returns the long-value of the named (by its enum-value) attribute.

std::string getString (int id) const


Returns the string-value of the named (by its enum-value) attribute.

std::string getStringSecure (int id, const std::string &def) const


Returns the string-value of the named (by its enum-value) attribute.

SUMOReal getFloat (int id) const


Returns the SUMOReal-value of the named (by its enum-value) attribute.

bool hasAttribute (const std::string &id) const


Returns the information whether the named attribute is within the current list.

SUMOReal getFloat (const std::string &id) const


Returns the SUMOReal-value of the named attribute.

std::string getStringSecure (const std::string &id, const std::string &def) const


Returns the string-value of the named (by its enum-value) attribute.

SumoXMLEdgeFunc getEdgeFunc (bool &ok) const


Returns the value of the named attribute.

SumoXMLNodeType getNodeType (bool &ok) const


Returns the value of the named attribute.

RGBColor getColor () const


Returns the value of the named attribute.

PositionVector getShape (int attr) const


Tries to read given attribute assuming it is a PositionVector.

Boundary getBoundary (int attr) const


Tries to read given attribute assuming it is a Boundary.

std::vector< std::string > getStringVector (int attr) const


Tries to read given attribute assuming it is a string vector.

std::string getName (int attr) const


Converts the given attribute id into a man readable string.

void serialize (std::ostream &os) const


Prints all attribute names and values into the given stream.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.111 SUMOSAXAttributesImpl_Binary Class Reference

5.111.1

261

Detailed Description

Encapsulated Xerces-SAX-attributes.
See Also
SUMOSAXAttributes

5.111.2

Constructor & Destructor Documentation

5.111.2.1

SUMOSAXAttributesImpl_Binary::SUMOSAXAttributesImpl_Binary ( const std::map< int, std::string > &


predefinedTagsMML, const std::string & objectType, BinaryInputDevice in )

Constructor.
Parameters
attrs
predefinedTags
predefinedTagsMML

in
in
in

The encapsulated xerces-attributes


Map of attribute ids to their xerces-representation
Map of attribute ids to their (readable) string-representation

5.111.3

Member Function Documentation

5.111.3.1

template<typename T > T SUMOSAXAttributes::get ( int attr, const char objectid, bool & ok, bool report = true
) const [inherited]

Tries to read given attribute assuming it is an int.


If an error occurs (the attribute is not there, it is not numeric), "ok" is set to false. If report is true an error message
is written to MsgHandler::getErrorInstance.
If the value could be read, "ok" is not changed, and the value is returned.
Parameters

in
in
out
in

attr
objectid
ok
report

The id of the attribute to read


The name of the parsed object; used for error message generation
Whether the value could be read
Whether errors shall be written to msg handlers error instance

Returns
The read value if given and correct; -1 if an error occured

5.111.3.2

bool SUMOSAXAttributesImpl_Binary::getBool ( int id ) const [virtual]

Returns the bool-value of the named (by its enum-value) attribute.


Tries to retrieve the attribute from the the attribute list. The retrieved attribute (which may be 0) is then parsed using
TplConvert<XMLCh>::_2bool. If the attribute is empty or ==0, TplConvert<XMLCh>::_2bool throws an EmptyData-exception which is passed. If the value can not be parsed to a bool, TplConvert<XMLCh>::_2bool throws a
BoolFormatException-exception which is passed.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

262

Class Documentation

Parameters
id

in

The id of the attribute to return the value of

Returns
The attributes value as a bool, if it could be read and parsed
Exceptions
EmptyData
BoolFormatException

If the attribute is not known or the attribute value is an empty string


If the attribute value can not be parsed to a bool

Implements SUMOSAXAttributes.

5.111.3.3

Boundary SUMOSAXAttributesImpl_Binary::getBoundary ( int attr ) const [virtual]

Tries to read given attribute assuming it is a Boundary.


Parameters

in

attr

The id of the attribute to read

Returns
The read value if given and not empty; "" if an error occured
Implements SUMOSAXAttributes.

5.111.3.4 RGBColor SUMOSAXAttributesImpl_Binary::getColor ( ) const [virtual]


Returns the value of the named attribute.
Tries to retrieve the attribute from the the attribute list.
Returns
The attributes value as a RGBColor, if it could be read and parsed
Implements SUMOSAXAttributes.

5.111.3.5 SumoXMLEdgeFunc SUMOSAXAttributesImpl_Binary::getEdgeFunc ( bool & ok ) const [virtual]


Returns the value of the named attribute.
Tries to retrieve the attribute from the the attribute list.
Returns
The attributes value as a string, if it could be read and parsed
Implements SUMOSAXAttributes.

5.111.3.6

SUMOReal SUMOSAXAttributesImpl_Binary::getFloat ( int id ) const [virtual]

Returns the SUMOReal-value of the named (by its enum-value) attribute.


Tries to retrieve the attribute from the the attribute list. The retrieved attribute (which may be 0) is then parsed
using TplConvert<XMLCh>::_2SUMOReal. If the attribute is empty or ==0, TplConvert<XMLCh>::_2SUMOReal
throws an EmptyData-exception which is passed. If the value can not be parsed to a SUMOReal, TplConvert<XMLCh>::_2SUMOReal throws a NumberFormatException-exception which is passed.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.111 SUMOSAXAttributesImpl_Binary Class Reference

263

Parameters
id

in

The id of the attribute to return the value of

Returns
The attributes value as a float, if it could be read and parsed
Exceptions
EmptyData
NumberFormatException

If the attribute is not known or the attribute value is an empty string


If the attribute value can not be parsed to an SUMOReal

Implements SUMOSAXAttributes.

5.111.3.7

SUMOReal SUMOSAXAttributesImpl_Binary::getFloat ( const std::string & id ) const [virtual]

Returns the SUMOReal-value of the named attribute.


Tries to retrieve the attribute from the the attribute list. The retrieved attribute (which may be 0) is then parsed
using TplConvert<XMLCh>::_2SUMOReal. If the attribute is empty or ==0, TplConvert<XMLCh>::_2SUMOReal
throws an EmptyData-exception which is passed. If the value can not be parsed to a SUMOReal, TplConvert<XMLCh>::_2SUMOReal throws a NumberFormatException-exception which is passed.
Parameters
id

in

The name of the attribute to return the value of

Returns
The attributes value as a float, if it could be read and parsed
Exceptions
EmptyData
NumberFormatException

If the attribute is not known or the attribute value is an empty string


If the attribute value can not be parsed to an SUMOReal

Implements SUMOSAXAttributes.

5.111.3.8

int SUMOSAXAttributesImpl_Binary::getInt ( int id ) const [virtual]

Returns the int-value of the named (by its enum-value) attribute.


Tries to retrieve the attribute from the the attribute list. The retrieved attribute (which may be 0) is then parsed
using TplConvert<XMLCh>::_2int. If the attribute is empty or ==0, TplConvert<XMLCh>::_2int throws an EmptyData-exception which is passed. If the value can not be parsed to an int, TplConvert<XMLCh>::_2int throws a
NumberFormatException-exception which is passed.
Parameters

in

id

The id of the attribute to return the value of

Returns
The attributes value as an int, if it could be read and parsed

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

264

Class Documentation

Exceptions
EmptyData
NumberFormatException

If the attribute is not known or the attribute value is an empty string


If the attribute value can not be parsed to an int

Implements SUMOSAXAttributes.

5.111.3.9

SUMOLong SUMOSAXAttributesImpl_Binary::getLong ( int id ) const [virtual]

Returns the long-value of the named (by its enum-value) attribute.


Tries to retrieve the attribute from the the attribute list. The retrieved attribute (which may be 0) is then parsed using
TplConvert<XMLCh>::_2long. If the attribute is empty or ==0, TplConvert<XMLCh>::_2long throws an EmptyData-exception which is passed. If the value can not be parsed to a long, TplConvert<XMLCh>::_2long throws a
NumberFormatException-exception which is passed.
Parameters
id

in

The id of the attribute to return the value of

Returns
The attributes value as an int, if it could be read and parsed
Exceptions
EmptyData
NumberFormatException

If the attribute is not known or the attribute value is an empty string


If the attribute value can not be parsed to an int

Implements SUMOSAXAttributes.

5.111.3.10

std::string SUMOSAXAttributesImpl_Binary::getName ( int attr ) const [virtual]

Converts the given attribute id into a man readable string.


Returns a "?" if the attribute is not known.
Parameters

in

attr

The id of the attribute to return the name of

Returns
The name of the described attribute
Implements SUMOSAXAttributes.

5.111.3.11 SumoXMLNodeType SUMOSAXAttributesImpl_Binary::getNodeType ( bool & ok ) const [virtual]


Returns the value of the named attribute.
Tries to retrieve the attribute from the the attribute list.
Returns
The attributes value as a string, if it could be read and parsed
Implements SUMOSAXAttributes.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.111 SUMOSAXAttributesImpl_Binary Class Reference

5.111.3.12

265

template<typename T > T SUMOSAXAttributes::getOpt ( int attr, const char objectid, bool & ok, T defaultValue,
bool report = true ) const [inherited]

Tries to read given attribute assuming it is an int.


If the attribute is not existing in the current element, the default value is returned. If an error occurs on parsing (the
attribute is empty, it is not numeric), "ok" is set to false. If report is true an error message is written to MsgHandler::getErrorInstance.
If the value could be read, "ok" is not changed, and the value is returned.
Parameters

in
in
out
in
in

attr
objectid
ok
defaultValue
report

The id of the attribute to read


The name of the parsed object; used for error message generation
Whether the value could be read
The value to return if the attribute is not within the element
Whether errors shall be written to msg handlers error instance

Returns
The read value if given and correct; the default value if the attribute does not exist; -1 if an error occured

5.111.3.13

SUMOTime SUMOSAXAttributes::getOptSUMOTimeReporting ( int attr, const char objectid, bool & ok,
SUMOTime defaultValue, bool report = true ) const [inherited]

Tries to read given attribute assuming it is a SUMOTime.


If the attribute is not existing in the current element, the default value is returned. If an error occurs on parsing (the
attribute is empty, it is not numeric), "ok" is set to false. If report is true an error message is written to MsgHandler::getErrorInstance.
Otherwise, "ok" is not changed.
In dependence to the used time representation, either get<int> or get<SUMOReal> is used.
Parameters

in
in
out
in
in

attr
objectid
ok
defaultValue
report

The id of the attribute to read


The name of the parsed object; used for error message generation
Whether the value could be read
The value to return if the attribute is not within the element
Whether errors shall be written to msg handlers error instance

Returns
The read value if given and correct; the default value if the attribute does not exist; -1 if an error occured

5.111.3.14

PositionVector SUMOSAXAttributesImpl_Binary::getShape ( int attr ) const [virtual]

Tries to read given attribute assuming it is a PositionVector.


Parameters

in

attr

The id of the attribute to read

Returns
The read value if given and not empty; "" if an error occured
Implements SUMOSAXAttributes.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

266

Class Documentation

5.111.3.15

std::string SUMOSAXAttributesImpl_Binary::getString ( int id ) const [virtual]

Returns the string-value of the named (by its enum-value) attribute.


Tries to retrieve the attribute from the the attribute list. The retrieved attribute (which may be 0) is then parsed using
TplConvert<XMLCh>::_2str. If the attribute is ==0, TplConvert<XMLCh>::_2str throws an EmptyData-exception
which is passed.
Parameters
id

in

The id of the attribute to return the value of

Returns
The attributes value as a string, if it could be read and parsed
Exceptions
EmptyData

If the attribute is not known or the attribute value is an empty string

Implements SUMOSAXAttributes.

5.111.3.16

std::string SUMOSAXAttributesImpl_Binary::getStringSecure ( int id, const std::string & def ) const

[virtual]
Returns the string-value of the named (by its enum-value) attribute.
Tries to retrieve the attribute from the the attribute list. The retrieved attribute (which may be 0) is then parsed using
TplConvert<XMLCh>::_2strSec. If the attribute is ==0, TplConvert<XMLCh>::_2strSec returns the default value.
Parameters
id
def

in
in

The id of the attribute to return the value of


The default value to return if the attribute is not in attributes

Returns
The attributes value as a string, if it could be read and parsed
Exceptions
EmptyData

If the attribute is not known or the attribute value is an empty string

Implements SUMOSAXAttributes.

5.111.3.17

std::string SUMOSAXAttributesImpl_Binary::getStringSecure ( const std::string & id, const std::string & def ) const

[virtual]
Returns the string-value of the named (by its enum-value) attribute.
Tries to retrieve the attribute from the the attribute list. If the attribute is ==0, TplConvert<XMLCh>::_2strSec
returns the default value.
Parameters

in
in

id
def

The name of the attribute to return the value of


The default value to return if the attribute is not in attributes

Returns
The attributes value as a string, if it could be read and parsed
Implements SUMOSAXAttributes.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.111 SUMOSAXAttributesImpl_Binary Class Reference

5.111.3.18

267

std::vector<std::string> SUMOSAXAttributesImpl_Binary::getStringVector ( int attr ) const [virtual]

Tries to read given attribute assuming it is a string vector.


Parameters

in

attr

The id of the attribute to read

Returns
The read value if given and not empty; empty vector if an error occured
Implements SUMOSAXAttributes.

5.111.3.19

SUMOTime SUMOSAXAttributes::getSUMOTimeReporting ( int attr, const char objectid, bool & ok, bool report =

true ) const [inherited]


Tries to read given attribute assuming it is a SUMOTime.
If an error occurs (the attribute is not there, it is not numeric), "ok" is set to false and an error message is written to
MsgHandler::getErrorInstance.
Otherwise, "ok" is not changed.
In dependence to the used time representation, either get<int> or get<SUMOReal> is used.
Parameters

in
in
out
in

attr
objectid
ok
report

The id of the attribute to read


The name of the parsed object; used for error message generation
Whether the value could be read
Whether errors shall be written to msg handlers error instance

Returns
The read value if given and correct; -1 if an error occured

5.111.3.20

bool SUMOSAXAttributesImpl_Binary::hasAttribute ( int id ) const [virtual]

Returns the information whether the named (by its enum-value) attribute is within the current list.
Parameters

in

id

The id of the searched attribute

Returns
Whether the attribute is within the attributes
Implements SUMOSAXAttributes.

5.111.3.21

static void SUMOSAXAttributes::parseStringSet ( const std::string & def, std::set< std::string > & into )

[static], [inherited]
Splits the given string, stores it in a set.
Spaces, ",", and ";" are assumed to be separator characters. Though, in the case a "," or a ";" occurs, a warning is
generated (once).

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

268

Class Documentation

Parameters
def
into

in
out

The string to split


The set to fill

static void SUMOSAXAttributes::parseStringVector ( const std::string & def, std::vector< std::string > & into )

5.111.3.22

[static], [inherited]
Splits the given string.
Spaces, ",", and ";" are assumed to be separator characters. Though, in the case a "," or a ";" occurs, a warning is
generated (once).
Parameters
def
into

in
out

5.111.3.23

The string to split


The vector to fill

void SUMOSAXAttributesImpl_Binary::serialize ( std::ostream & os ) const [virtual]

Prints all attribute names and values into the given stream.
Parameters
os

in

The stream to use

Implements SUMOSAXAttributes.
The documentation for this class was generated from the following file:
src/sumo/include/utils/xml/SUMOSAXAttributesImpl_Binary.h

5.112

SUMOSAXAttributesImpl_Xerces Class Reference

Encapsulated Xerces-SAX-attributes.

#include <SUMOSAXAttributesImpl_Xerces.h>
Inheritance diagram for SUMOSAXAttributesImpl_Xerces:

SUMOSAXAttributes
SUMOSAXAttributesImpl_Xerces

Public Member Functions


SUMOSAXAttributesImpl_Xerces (const XERCES_CPP_NAMESPACE::Attributes &attrs, const std::map<
int, XMLCh > &predefinedTags, const std::map< int, std::string > &predefinedTagsMML, const std::string
&objectType)
Constructor.

virtual SUMOSAXAttributesImpl_Xerces ()
Destructor.

template<typename T >
T get (int attr, const char objectid, bool &ok, bool report=true) const
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.112 SUMOSAXAttributesImpl_Xerces Class Reference

269

Tries to read given attribute assuming it is an int.

template<typename T >
T getOpt (int attr, const char objectid, bool &ok, T defaultValue, bool report=true) const
Tries to read given attribute assuming it is an int.

SUMOTime getSUMOTimeReporting (int attr, const char objectid, bool &ok, bool report=true) const
Tries to read given attribute assuming it is a SUMOTime.

SUMOTime getOptSUMOTimeReporting (int attr, const char objectid, bool &ok, SUMOTime defaultValue,
bool report=true) const
Tries to read given attribute assuming it is a SUMOTime.

virtual methods for retrieving attribute values


const std::string & getObjectType () const
return the objecttype to which these attributes belong

static const std::string ENCODING


The encoding of parsed strings.

static void parseStringVector (const std::string &def, std::vector< std::string > &into)
Splits the given string.

static void parseStringSet (const std::string &def, std::set< std::string > &into)
Splits the given string, stores it in a set.

template<typename T >
T getInternal (const int attr) const
void emitUngivenError (const std::string &attrname, const char objectid) const
void emitEmptyError (const std::string &attrname, const char objectid) const
void emitFormatError (const std::string &attrname, const std::string &type, const char objectid) const

methods for retrieving attribute values


bool hasAttribute (int id) const
Returns the information whether the named (by its enum-value) attribute is within the current list.

bool getBool (int id) const


Returns the bool-value of the named (by its enum-value) attribute.

int getInt (int id) const


Returns the int-value of the named (by its enum-value) attribute.

SUMOLong getLong (int id) const


Returns the long-value of the named (by its enum-value) attribute.

std::string getString (int id) const


Returns the string-value of the named (by its enum-value) attribute.

std::string getStringSecure (int id, const std::string &def) const


Returns the string-value of the named (by its enum-value) attribute.

SUMOReal getFloat (int id) const


Returns the SUMOReal-value of the named (by its enum-value) attribute.

bool hasAttribute (const std::string &id) const


Returns the information whether the named attribute is within the current list.

SUMOReal getFloat (const std::string &id) const


Returns the SUMOReal-value of the named attribute.

std::string getStringSecure (const std::string &id, const std::string &def) const


Returns the string-value of the named (by its enum-value) attribute.

SumoXMLEdgeFunc getEdgeFunc (bool &ok) const


Returns the value of the named attribute.

SumoXMLNodeType getNodeType (bool &ok) const


Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

270

Class Documentation

Returns the value of the named attribute.

RGBColor getColor () const


Returns the value of the named attribute.

PositionVector getShape (int attr) const


Tries to read given attribute assuming it is a PositionVector.

Boundary getBoundary (int attr) const


Tries to read given attribute assuming it is a Boundary.

std::vector< std::string > getStringVector (int attr) const


Tries to read given attribute assuming it is a string vector.

std::string getName (int attr) const


Converts the given attribute id into a man readable string.

void serialize (std::ostream &os) const


Prints all attribute names and values into the given stream.

5.112.1

Detailed Description

Encapsulated Xerces-SAX-attributes.
See Also
SUMOSAXAttributes

5.112.2

Constructor & Destructor Documentation

5.112.2.1

SUMOSAXAttributesImpl_Xerces::SUMOSAXAttributesImpl_Xerces ( const XERCES_CPP_NAMESPACE::Attributes &


attrs, const std::map< int, XMLCh > & predefinedTags, const std::map< int, std::string > & predefinedTagsMML,
const std::string & objectType )

Constructor.
Parameters
attrs
predefinedTags
predefinedTagsMML

in
in
in

The encapsulated xerces-attributes


Map of attribute ids to their xerces-representation
Map of attribute ids to their (readable) string-representation

5.112.3

Member Function Documentation

5.112.3.1

template<typename T > T SUMOSAXAttributes::get ( int attr, const char objectid, bool & ok, bool report = true
) const [inherited]

Tries to read given attribute assuming it is an int.


If an error occurs (the attribute is not there, it is not numeric), "ok" is set to false. If report is true an error message
is written to MsgHandler::getErrorInstance.
If the value could be read, "ok" is not changed, and the value is returned.
Parameters

in

attr

The id of the attribute to read

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.112 SUMOSAXAttributesImpl_Xerces Class Reference


objectid
ok
report

in
out
in

271

The name of the parsed object; used for error message generation
Whether the value could be read
Whether errors shall be written to msg handlers error instance

Returns
The read value if given and correct; -1 if an error occured

5.112.3.2

bool SUMOSAXAttributesImpl_Xerces::getBool ( int id ) const [virtual]

Returns the bool-value of the named (by its enum-value) attribute.


Tries to retrieve the attribute from the the attribute list. The retrieved attribute (which may be 0) is then parsed using
TplConvert<XMLCh>::_2bool. If the attribute is empty or ==0, TplConvert<XMLCh>::_2bool throws an EmptyData-exception which is passed. If the value can not be parsed to a bool, TplConvert<XMLCh>::_2bool throws a
BoolFormatException-exception which is passed.
Parameters
id

in

The id of the attribute to return the value of

Returns
The attributes value as a bool, if it could be read and parsed
Exceptions
EmptyData
BoolFormatException

If the attribute is not known or the attribute value is an empty string


If the attribute value can not be parsed to a bool

Implements SUMOSAXAttributes.

5.112.3.3

Boundary SUMOSAXAttributesImpl_Xerces::getBoundary ( int attr ) const [virtual]

Tries to read given attribute assuming it is a Boundary.


Parameters

in

attr

The id of the attribute to read

Returns
The read value if given and not empty; "" if an error occured
Implements SUMOSAXAttributes.

5.112.3.4 RGBColor SUMOSAXAttributesImpl_Xerces::getColor ( ) const [virtual]


Returns the value of the named attribute.
Tries to retrieve the attribute from the the attribute list.
Returns
The attributes value as a RGBColor, if it could be read and parsed
Implements SUMOSAXAttributes.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

272

Class Documentation

5.112.3.5 SumoXMLEdgeFunc SUMOSAXAttributesImpl_Xerces::getEdgeFunc ( bool & ok ) const [virtual]


Returns the value of the named attribute.
Tries to retrieve the attribute from the the attribute list.
Returns
The attributes value as a SumoXMLEdgeFunc, if it could be read and parsed
Implements SUMOSAXAttributes.

5.112.3.6

SUMOReal SUMOSAXAttributesImpl_Xerces::getFloat ( int id ) const [virtual]

Returns the SUMOReal-value of the named (by its enum-value) attribute.


Tries to retrieve the attribute from the the attribute list. The retrieved attribute (which may be 0) is then parsed
using TplConvert<XMLCh>::_2SUMOReal. If the attribute is empty or ==0, TplConvert<XMLCh>::_2SUMOReal
throws an EmptyData-exception which is passed. If the value can not be parsed to a SUMOReal, TplConvert<XMLCh>::_2SUMOReal throws a NumberFormatException-exception which is passed.
Parameters
id

in

The id of the attribute to return the value of

Returns
The attributes value as a float, if it could be read and parsed
Exceptions
EmptyData
NumberFormatException

If the attribute is not known or the attribute value is an empty string


If the attribute value can not be parsed to an SUMOReal

Implements SUMOSAXAttributes.

5.112.3.7

SUMOReal SUMOSAXAttributesImpl_Xerces::getFloat ( const std::string & id ) const [virtual]

Returns the SUMOReal-value of the named attribute.


Tries to retrieve the attribute from the the attribute list. The retrieved attribute (which may be 0) is then parsed
using TplConvert<XMLCh>::_2SUMOReal. If the attribute is empty or ==0, TplConvert<XMLCh>::_2SUMOReal
throws an EmptyData-exception which is passed. If the value can not be parsed to a SUMOReal, TplConvert<XMLCh>::_2SUMOReal throws a NumberFormatException-exception which is passed.
Parameters

in

id

The name of the attribute to return the value of

Returns
The attributes value as a float, if it could be read and parsed
Exceptions
EmptyData
NumberFormatException

If the attribute is not known or the attribute value is an empty string


If the attribute value can not be parsed to an SUMOReal

Implements SUMOSAXAttributes.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.112 SUMOSAXAttributesImpl_Xerces Class Reference

5.112.3.8

273

int SUMOSAXAttributesImpl_Xerces::getInt ( int id ) const [virtual]

Returns the int-value of the named (by its enum-value) attribute.


Tries to retrieve the attribute from the the attribute list. The retrieved attribute (which may be 0) is then parsed
using TplConvert<XMLCh>::_2int. If the attribute is empty or ==0, TplConvert<XMLCh>::_2int throws an EmptyData-exception which is passed. If the value can not be parsed to an int, TplConvert<XMLCh>::_2int throws a
NumberFormatException-exception which is passed.
Parameters
id

in

The id of the attribute to return the value of

Returns
The attributes value as an int, if it could be read and parsed
Exceptions
EmptyData
NumberFormatException

If the attribute is not known or the attribute value is an empty string


If the attribute value can not be parsed to an int

Implements SUMOSAXAttributes.

5.112.3.9

SUMOLong SUMOSAXAttributesImpl_Xerces::getLong ( int id ) const [virtual]

Returns the long-value of the named (by its enum-value) attribute.


Tries to retrieve the attribute from the the attribute list. The retrieved attribute (which may be 0) is then parsed using
TplConvert<XMLCh>::_2long. If the attribute is empty or ==0, TplConvert<XMLCh>::_2long throws an EmptyData-exception which is passed. If the value can not be parsed to a long, TplConvert<XMLCh>::_2long throws a
NumberFormatException-exception which is passed.
Parameters
id

in

The id of the attribute to return the value of

Returns
The attributes value as an int, if it could be read and parsed
Exceptions
EmptyData
NumberFormatException

If the attribute is not known or the attribute value is an empty string


If the attribute value can not be parsed to an int

Implements SUMOSAXAttributes.

5.112.3.10

std::string SUMOSAXAttributesImpl_Xerces::getName ( int attr ) const [virtual]

Converts the given attribute id into a man readable string.


Returns a "?" if the attribute is not known.
Parameters

in

attr

The id of the attribute to return the name of

Returns
The name of the described attribute
Implements SUMOSAXAttributes.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

274

Class Documentation

5.112.3.11 SumoXMLNodeType SUMOSAXAttributesImpl_Xerces::getNodeType ( bool & ok ) const [virtual]


Returns the value of the named attribute.
Tries to retrieve the attribute from the the attribute list.
Returns
The attributes value as a SumoXMLNodeType, if it could be read and parsed
Implements SUMOSAXAttributes.

5.112.3.12

template<typename T > T SUMOSAXAttributes::getOpt ( int attr, const char objectid, bool & ok, T defaultValue,
bool report = true ) const [inherited]

Tries to read given attribute assuming it is an int.


If the attribute is not existing in the current element, the default value is returned. If an error occurs on parsing (the
attribute is empty, it is not numeric), "ok" is set to false. If report is true an error message is written to MsgHandler::getErrorInstance.
If the value could be read, "ok" is not changed, and the value is returned.
Parameters

in
in
out
in
in

attr
objectid
ok
defaultValue
report

The id of the attribute to read


The name of the parsed object; used for error message generation
Whether the value could be read
The value to return if the attribute is not within the element
Whether errors shall be written to msg handlers error instance

Returns
The read value if given and correct; the default value if the attribute does not exist; -1 if an error occured

5.112.3.13

SUMOTime SUMOSAXAttributes::getOptSUMOTimeReporting ( int attr, const char objectid, bool & ok,
SUMOTime defaultValue, bool report = true ) const [inherited]

Tries to read given attribute assuming it is a SUMOTime.


If the attribute is not existing in the current element, the default value is returned. If an error occurs on parsing (the
attribute is empty, it is not numeric), "ok" is set to false. If report is true an error message is written to MsgHandler::getErrorInstance.
Otherwise, "ok" is not changed.
In dependence to the used time representation, either get<int> or get<SUMOReal> is used.
Parameters

in
in
out
in
in

attr
objectid
ok
defaultValue
report

The id of the attribute to read


The name of the parsed object; used for error message generation
Whether the value could be read
The value to return if the attribute is not within the element
Whether errors shall be written to msg handlers error instance

Returns
The read value if given and correct; the default value if the attribute does not exist; -1 if an error occured

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.112 SUMOSAXAttributesImpl_Xerces Class Reference

5.112.3.14

PositionVector SUMOSAXAttributesImpl_Xerces::getShape ( int attr ) const [virtual]

Tries to read given attribute assuming it is a PositionVector.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

275

276

Class Documentation

Parameters
attr

in

The id of the attribute to read

Returns
The read value if given and not empty; "" if an error occured
Implements SUMOSAXAttributes.

5.112.3.15

std::string SUMOSAXAttributesImpl_Xerces::getString ( int id ) const [virtual]

Returns the string-value of the named (by its enum-value) attribute.


Tries to retrieve the attribute from the the attribute list. The retrieved attribute (which may be 0) is then parsed using
TplConvert<XMLCh>::_2str. If the attribute is ==0, TplConvert<XMLCh>::_2str throws an EmptyData-exception
which is passed.
Parameters
id

in

The id of the attribute to return the value of

Returns
The attributes value as a string, if it could be read and parsed
Exceptions
EmptyData

If the attribute is not known or the attribute value is an empty string

Implements SUMOSAXAttributes.

5.112.3.16

std::string SUMOSAXAttributesImpl_Xerces::getStringSecure ( int id, const std::string & def ) const

[virtual]
Returns the string-value of the named (by its enum-value) attribute.
Tries to retrieve the attribute from the the attribute list. The retrieved attribute (which may be 0) is then parsed using
TplConvert<XMLCh>::_2strSec. If the attribute is ==0, TplConvert<XMLCh>::_2strSec returns the default value.
Parameters
id
def

in
in

The id of the attribute to return the value of


The default value to return if the attribute is not in attributes

Returns
The attributes value as a string, if it could be read and parsed
Exceptions
EmptyData

If the attribute is not known or the attribute value is an empty string

Implements SUMOSAXAttributes.

5.112.3.17

std::string SUMOSAXAttributesImpl_Xerces::getStringSecure ( const std::string & id, const std::string & def ) const

[virtual]
Returns the string-value of the named (by its enum-value) attribute.
Tries to retrieve the attribute from the the attribute list. If the attribute is ==0, TplConvert<XMLCh>::_2strSec
returns the default value.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.112 SUMOSAXAttributesImpl_Xerces Class Reference

277

Parameters

in
in

id
def

The name of the attribute to return the value of


The default value to return if the attribute is not in attributes

Returns
The attributes value as a string, if it could be read and parsed
Implements SUMOSAXAttributes.

5.112.3.18

std::vector<std::string> SUMOSAXAttributesImpl_Xerces::getStringVector ( int attr ) const [virtual]

Tries to read given attribute assuming it is a string vector.


Parameters

in

attr

The id of the attribute to read

Returns
The read value if given and not empty; empty vector if an error occured
Implements SUMOSAXAttributes.

5.112.3.19

SUMOTime SUMOSAXAttributes::getSUMOTimeReporting ( int attr, const char objectid, bool & ok, bool report =

true ) const [inherited]


Tries to read given attribute assuming it is a SUMOTime.
If an error occurs (the attribute is not there, it is not numeric), "ok" is set to false and an error message is written to
MsgHandler::getErrorInstance.
Otherwise, "ok" is not changed.
In dependence to the used time representation, either get<int> or get<SUMOReal> is used.
Parameters

in
in
out
in

attr
objectid
ok
report

The id of the attribute to read


The name of the parsed object; used for error message generation
Whether the value could be read
Whether errors shall be written to msg handlers error instance

Returns
The read value if given and correct; -1 if an error occured

5.112.3.20

bool SUMOSAXAttributesImpl_Xerces::hasAttribute ( int id ) const [virtual]

Returns the information whether the named (by its enum-value) attribute is within the current list.
Parameters

in

id

The id of the searched attribute

Returns
Whether the attribute is within the attributes
Implements SUMOSAXAttributes.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

278

Class Documentation

static void SUMOSAXAttributes::parseStringSet ( const std::string & def, std::set< std::string > & into )

5.112.3.21

[static], [inherited]
Splits the given string, stores it in a set.
Spaces, ",", and ";" are assumed to be separator characters. Though, in the case a "," or a ";" occurs, a warning is
generated (once).
Parameters
def
into

in
out

The string to split


The set to fill

static void SUMOSAXAttributes::parseStringVector ( const std::string & def, std::vector< std::string > & into )

5.112.3.22

[static], [inherited]
Splits the given string.
Spaces, ",", and ";" are assumed to be separator characters. Though, in the case a "," or a ";" occurs, a warning is
generated (once).
Parameters
def
into

in
out

5.112.3.23

The string to split


The vector to fill

void SUMOSAXAttributesImpl_Xerces::serialize ( std::ostream & os ) const [virtual]

Prints all attribute names and values into the given stream.
Parameters

in

os

The stream to use

Implements SUMOSAXAttributes.
The documentation for this class was generated from the following file:
src/sumo/include/utils/xml/SUMOSAXAttributesImpl_Xerces.h

5.113

SUMOSAXHandler Class Reference

SAX-handler base for SUMO-files.

#include <SUMOSAXHandler.h>
Inheritance diagram for SUMOSAXHandler:

DefaultHandler
GenericSAXHandler
SUMOSAXHandler
SAXWeightsHandler

SUMORouteHandler

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.113 SUMOSAXHandler Class Reference

279

Public Member Functions


SUMOSAXHandler (const std::string &file="")
Constructor.

virtual SUMOSAXHandler ()
Destructor.

void startElement (const XMLCh const uri, const XMLCh const localname, const XMLCh const qname,
const XERCES_CPP_NAMESPACE::Attributes &attrs)
The inherited method called when a new tag opens.

void characters (const XMLCh const chars, const XERCES3_SIZE_t length)


The inherited method called when characters occured.

void endElement (const XMLCh const uri, const XMLCh const localname, const XMLCh const qname)
The inherited method called when a tag is being closed.

void registerParent (const int tag, GenericSAXHandler handler)


Assigning a parent handler which is enabled when the specified tag is closed.

void setFileName (const std::string &name)


Sets the current file name.

const std::string & getFileName () const


returns the current file name

SAX ErrorHandler callbacks


void warning (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
Handler for XML-warnings.

void error (const XERCES_CPP_NAMESPACE::SAXParseException &exception)


Handler for XML-errors.

void fatalError (const XERCES_CPP_NAMESPACE::SAXParseException &exception)


Handler for XML-errors.

Protected Member Functions


std::string buildErrorMessage (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
Builds an error message.

virtual void myStartElement (int element, const SUMOSAXAttributes &attrs)


Callback method for an opening tag to implement by derived classes.

virtual void myCharacters (int element, const std::string &chars)


Callback method for characters to implement by derived classes.

virtual void myEndElement (int element)


Callback method for a closing tag to implement by derived classes.

5.113.1

Detailed Description

SAX-handler base for SUMO-files.


This class is a GenericSAXHandler which knows all tags SUMO uses, so all SUMO-XML - loading classes should
be derived from it.

5.113.2

Constructor & Destructor Documentation

5.113.2.1

SUMOSAXHandler::SUMOSAXHandler ( const std::string & file = "" )

Constructor.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

280

Class Documentation

Parameters
file

in

The name of the processed file

5.113.3

Member Function Documentation

5.113.3.1

std::string GenericSAXHandler::buildErrorMessage ( const XERCES_CPP_NAMESPACE::SAXParseException &


exception ) [protected], [inherited]

Builds an error message.


The error message includes the file name and the line/column information as supported by the given SAXParseException
Parameters
exception

in

The name of the currently processed file

Returns
A string describing the given exception

5.113.3.2

void GenericSAXHandler::characters ( const XMLCh const chars, const XERCES3_SIZE_t length )

[inherited]
The inherited method called when characters occured.
The retrieved characters are converted into a string and appended into a private buffer. They are reported as soon
as the element ends.
Todo recheck/describe what happens with characters when a new element is opened
describe characters processing in the class head

5.113.3.3

void GenericSAXHandler::endElement ( const XMLCh const uri, const XMLCh const localname, const XMLCh

const qname ) [inherited]


The inherited method called when a tag is being closed.
This method calls the user-implemented methods myCharacters with the previously collected and converted characters.
Then, myEndElement is called, supplying it the qname converted to its enum- and string-representations.
Todo recheck/describe encoding of the string-representation
do not generate and report the string-representation

5.113.3.4

void GenericSAXHandler::error ( const XERCES_CPP_NAMESPACE::SAXParseException & exception )

[inherited]
Handler for XML-errors.
The message is built using buildErrorMessage and thrown within a ProcessError.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.113 SUMOSAXHandler Class Reference

281

Parameters
exception

in

The occured exception to process

Exceptions
ProcessError

5.113.3.5

On any call

void GenericSAXHandler::fatalError ( const XERCES_CPP_NAMESPACE::SAXParseException & exception )

[inherited]
Handler for XML-errors.
The message is built using buildErrorMessage and thrown within a ProcessError.
Exceptions
ProcessError

On any call

Parameters
exception

in

5.113.3.6

The occured exception to process

const std::string& GenericSAXHandler::getFileName ( ) const [inherited]

returns the current file name


Returns
The name of the currently processed file

5.113.3.7

virtual void GenericSAXHandler::myCharacters ( int element, const std::string & chars ) [protected],

[virtual], [inherited]
Callback method for characters to implement by derived classes.
Called by "endElement" (see there).
Parameters
element
chars

in
in

5.113.3.8

The opened element, given as a int


The complete embedded character string ProcessError These method may
throw a ProcessError if something fails

virtual void GenericSAXHandler::myEndElement ( int element ) [protected], [virtual],

[inherited]
Callback method for a closing tag to implement by derived classes.
Called by "endElement" (see there).
Parameters

in

element

The closed element, given as a int ProcessError These method may throw a
ProcessError if something fails

Reimplemented in SAXWeightsHandler, and SUMORouteHandler.


Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

282

Class Documentation

5.113.3.9

virtual void GenericSAXHandler::myStartElement ( int element, const SUMOSAXAttributes & attrs )

[protected], [virtual], [inherited]


Callback method for an opening tag to implement by derived classes.
Called by "startElement" (see there).
Parameters
element
attrs

in
in

The element that contains the characters, given as a int


The SAX-attributes, wrapped as SUMOSAXAttributes ProcessError These
method may throw a ProcessError if something fails

Reimplemented in SAXWeightsHandler, and SUMORouteHandler.

5.113.3.10

void GenericSAXHandler::setFileName ( const std::string & name ) [inherited]

Sets the current file name.


Parameters
name

in

The name of the currently processed file

Todo Hmmm - this is as unsafe as having a direct access to the variable; recheck

void GenericSAXHandler::startElement ( const XMLCh const uri, const XMLCh const localname, const XMLCh
const qname, const XERCES_CPP_NAMESPACE::Attributes & attrs ) [inherited]

5.113.3.11

The inherited method called when a new tag opens.


The method parses the supplied XMLCh-qname using the internal name/enum-map to obtain the enum representation of the attribute name.
Then, "myStartElement" is called supplying the enumeration value, the string-representation of the name and the
attributes.
Todo recheck/describe encoding of the string-representation
do not generate and report the string-representation

5.113.3.12

void GenericSAXHandler::warning ( const XERCES_CPP_NAMESPACE::SAXParseException & exception )

[inherited]
Handler for XML-warnings.
The message is built using buildErrorMessage and reported to the warning-instance of the MsgHandler.
Parameters

in

exception

The occured exception to process

The documentation for this class was generated from the following file:
src/sumo/include/utils/xml/SUMOSAXHandler.h

5.114

SUMOSAXReader Class Reference

SAX-reader encapsulation containing binary reader.

#include <SUMOSAXReader.h>
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.115 SUMOVehicleParserHelper Class Reference

283

Public Member Functions


SUMOSAXReader (GenericSAXHandler &handler, const XERCES_CPP_NAMESPACE::SAX2XMLReader::ValSchemes validationScheme)
Constructor.

SUMOSAXReader ()
Destructor.

void setHandler (GenericSAXHandler &handler)


Sets the given handler as content and error handler for the reader.

void setValidation
Scheme)

(const

XERCES_CPP_NAMESPACE::SAX2XMLReader::ValSchemes

validation-

void parse (std::string systemID)


void parseString (std::string content)
bool parseFirst (std::string systemID)
bool parseNext ()

5.114.1

Detailed Description

SAX-reader encapsulation containing binary reader.


This class generates on demand either a SAX2XMLReader or parses the SUMO binary xml. The interface is
inspired by but not identical to SAX2XMLReader.

5.114.2

Constructor & Destructor Documentation

5.114.2.1

SUMOSAXReader::SUMOSAXReader ( GenericSAXHandler & handler, const


XERCES_CPP_NAMESPACE::SAX2XMLReader::ValSchemes validationScheme )

Constructor.
Parameters
file

in

The name of the processed file

5.114.3

Member Function Documentation

5.114.3.1

void SUMOSAXReader::setHandler ( GenericSAXHandler & handler )

Sets the given handler as content and error handler for the reader.
Parameters

in

handler

The handler to assign to the reader

The documentation for this class was generated from the following file:
src/sumo/include/utils/xml/SUMOSAXReader.h

5.115

SUMOVehicleParserHelper Class Reference

Helper methods for parsing vehicle attributes.

#include <SUMOVehicleParserHelper.h>
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

284

Class Documentation

Static Public Member Functions


static SUMOVehicleParameter parseFlowAttributes (const SUMOSAXAttributes &attrs, const SUMOTime
beginDefault, const SUMOTime endDefault)
Parses a flows attributes.

static SUMOVehicleParameter parseVehicleAttributes (const SUMOSAXAttributes &attrs, const bool


optionalID=false, const bool skipDepart=false, const bool isPerson=false)
Parses a vehicles attributes.

static SUMOVTypeParameter beginVTypeParsing (const SUMOSAXAttributes &attrs, const std::string &file)


Starts to parse a vehicle type.

static void parseVTypeEmbedded (SUMOVTypeParameter &into, int element, const SUMOSAXAttributes &attrs, bool fromVType=false)
Parses an element embedded in vtype definition.

static void closeVTypeParsing (SUMOVTypeParameter &vtype)


Closes parsing of the vehicle type.

static SUMOVehicleClass parseVehicleClass (const SUMOSAXAttributes &attrs, const std::string &id)


Parses the vehicle class.

static SUMOEmissionClass parseEmissionClass (const SUMOSAXAttributes &attrs, const std::string &id)


Parses the vehicle emission class.

static SUMOVehicleShape parseGuiShape (const SUMOSAXAttributes &attrs, const std::string &id)


Parses the vehicle class.

5.115.1

Detailed Description

Helper methods for parsing vehicle attributes.


This class supports helper methods for parsing a vehicles attributes.

5.115.2

Member Function Documentation

5.115.2.1

static SUMOVTypeParameter SUMOVehicleParserHelper::beginVTypeParsing ( const SUMOSAXAttributes &


attrs, const std::string & file ) [static]

Starts to parse a vehicle type.


Parameters
attr
file

in
in

The SAX-attributes to get vehicle parameter from


The name of the file being parsed (for resolving paths)

Exceptions
ProcessError

If an attributes value is invalid

See Also
SUMOVTypeParameter

Note
: the caller is responsible for deleting the returned pointer

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.115 SUMOVehicleParserHelper Class Reference

5.115.2.2

285

static void SUMOVehicleParserHelper::closeVTypeParsing ( SUMOVTypeParameter & vtype ) [inline],

[static]
Closes parsing of the vehicle type.
Returns
The resulting vehicle type parameter

See Also
SUMOVTypeParameter

5.115.2.3

static SUMOEmissionClass SUMOVehicleParserHelper::parseEmissionClass ( const SUMOSAXAttributes & attrs,


const std::string & id ) [static]

Parses the vehicle emission class.


When given, the vehicle emission class is parsed using getVehicleEmissionTypeID. Exceptions occuring within this
process are catched and reported.
If no vehicle class is available in the attributes, the default class (SVE_UNKNOWN) is returned.
Parameters
attrs
id

in
in

The attributes to read the class from


The id of the parsed element, for error message generation

Returns
The parsed vehicle emission class

See Also
SUMOEmissionClass
Todo Recheck how errors are handled and what happens if they occure

5.115.2.4

static SUMOVehicleParameter SUMOVehicleParserHelper::parseFlowAttributes ( const SUMOSAXAttributes &


attrs, const SUMOTime beginDefault, const SUMOTime endDefault ) [static]

Parses a flows attributes.


Parses all attributes stored in "SUMOVehicleParameter".
See Also
SUMOVehicleParameter
Parameters

in

attr

The SAX-attributes to get vehicle parameter from

Returns
The parsed attribute structure if no error occured, 0 otherwise

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

286

Class Documentation

Exceptions
ProcessError

If an attributes value is invalid

Note
: the caller is responsible for deleting the returned pointer

5.115.2.5

static SUMOVehicleShape SUMOVehicleParserHelper::parseGuiShape ( const SUMOSAXAttributes & attrs,


const std::string & id ) [static]

Parses the vehicle class.


When given, the vehicle class is parsed using getVehicleShapeID. Exceptions occuring within this process are
catched and reported.
If no vehicle class is available in the attributes, the default class (SVS_UNKNOWN) is returned.
Parameters
attrs
id

in
in

The attributes to read the class from


The id of the parsed element, for error message generation

Returns
The parsed vehicle shape

See Also
SUMOVehicleShape
Todo Recheck how errors are handled and what happens if they occure

5.115.2.6

static SUMOVehicleParameter SUMOVehicleParserHelper::parseVehicleAttributes ( const SUMOSAXAttributes


& attrs, const bool optionalID = false, const bool skipDepart = false, const bool isPerson = false )

[static]
Parses a vehicles attributes.
Parses all attributes stored in "SUMOVehicleParameter".
See Also
SUMOVehicleParameter
Parameters

in
in
in
in

attr
optionalID
skipDepart
isPerson

The SAX-attributes to get vehicle parameter from


Whether the id shall be skipped
Whether parsing the departure time shall be skipped
Whether a person is parsed

Returns
The parsed attribute structure if no error occured, 0 otherwise

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.115 SUMOVehicleParserHelper Class Reference

287

Exceptions
ProcessError

If an attributes value is invalid

Note
: the caller is responsible for deleting the returned pointer

5.115.2.7

static SUMOVehicleClass SUMOVehicleParserHelper::parseVehicleClass ( const SUMOSAXAttributes & attrs,


const std::string & id ) [static]

Parses the vehicle class.


When given, the vehicle class is parsed using getVehicleClassID. Exceptions occuring within this process are
catched and reported.
If no vehicle class is available in the attributes, the default class (SVC_IGNORING) is returned.
Parameters
attrs
id

in
in

The attributes to read the class from


The id of the parsed element, for error message generation

Returns
The parsed vehicle class

See Also
SUMOVehicleClass
Todo Recheck how errors are handled and what happens if they occure

5.115.2.8

static void SUMOVehicleParserHelper::parseVTypeEmbedded ( SUMOVTypeParameter & into, int element, const


SUMOSAXAttributes & attrs, bool fromVType = false ) [static]

Parses an element embedded in vtype definition.


Parameters

in
in
in

in,filled]
element
attr
fromVType

into The structure to fill with parsed values


The id of the currently parsed XML-element
The SAX-attributes to get vehicle parameter from
Whether the attributes are a part of the vtype-definition

Exceptions
ProcessError

If an attributes value is invalid

See Also
SUMOVTypeParameter
The documentation for this class was generated from the following file:
src/sumo/include/utils/xml/SUMOVehicleParserHelper.h
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

288

Class Documentation

5.116

SUMOXMLDefinitions Class Reference

class for maintaining associations between enums and xml-strings

#include <SUMOXMLDefinitions.h>

Static Public Member Functions


Helper functions for ID-string manipulations
static std::string getJunctionIDFromInternalEdge (const std::string internalEdge)
return the junction id when given an edge of type internal, crossing or WalkingArea

static std::string getEdgeIDFromLane (const std::string laneID)


return edge id when given the lane ID

Static Public Attributes


static StringBijection< int >
::Entry tags [ ]
The names of SUMO-XML elements (for passing to GenericSAXHandler)

static StringBijection< int >


::Entry attrs [ ]
The names of SUMO-XML attributes (for passing to GenericSAXHandler)

static StringBijection< int > Tags


The names of SUMO-XML elements for use in netbuild.

static StringBijection< int > Attrs


The names of SUMO-XML attributes for use in netbuild.

Special values of SUMO-XML attributes


static StringBijection
< SumoXMLNodeType > NodeTypes
static StringBijection
< SumoXMLEdgeFunc > EdgeFunctions
static StringBijection
< LaneSpreadFunction > LaneSpreadFunctions
static StringBijection< LinkState > LinkStates
static StringBijection
< LinkDirection > LinkDirections
static StringBijection
< TrafficLightType > TrafficLightTypes
static StringBijection
< LaneChangeModel > LaneChangeModels

5.116.1

Detailed Description

class for maintaining associations between enums and xml-strings


The documentation for this class was generated from the following file:
src/sumo/include/utils/xml/SUMOXMLDefinitions.h

5.117

SystemFrame Class Reference

A set of actions common to all applications.

#include <SystemFrame.h>
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.117 SystemFrame Class Reference

289

Static Public Member Functions


static void addConfigurationOptions (OptionsCont &oc)
Adds configuration options to the given container.

static void addReportOptions (OptionsCont &oc)


Adds reporting options to the given container.

static void close ()


Closes all of an applications subsystems.

5.117.1

Detailed Description

A set of actions common to all applications.


As almost all applications within the SUMO-package share the same initialisation procedure, it is encapsulated
within this class.
Only two things are done herein, so far. The first is to insert options into the given options container that are used
for dealing with the applications configuration.
Additionally, a closing method may be found, which closes all used subsystems.

5.117.2

Member Function Documentation

5.117.2.1

void SystemFrame::addConfigurationOptions ( OptionsCont & oc ) [static]

Adds configuration options to the given container.


Parameters
oc

in

The options container to add the options to

Todo let the container be retrieved

5.117.2.2

void SystemFrame::addReportOptions ( OptionsCont & oc ) [static]

Adds reporting options to the given container.


Parameters
oc

in

The options container to add the options to

Todo let the container be retrieved


!! check, describe

5.117.2.3

void SystemFrame::close ( ) [static]

Closes all of an applications subsystems.


Closes (in this order)
The xml subsystem
The options subsystem
The message subsystem

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

290

Class Documentation
See Also
XMLSubSys::close()
OptionsCont::clear()
MsgHandler::cleanupOnEnd()

The documentation for this class was generated from the following files:
src/sumo/include/utils/common/SystemFrame.h
src/sumo/src/utils/common/SystemFrame.cpp

5.118

SysUtils Class Reference

A few system-specific functions.

#include <SysUtils.h>

Static Public Member Functions


static long getCurrentMillis ()
Returns the current time in milliseconds.

static unsigned long runHiddenCommand (const std::string &cmd)


run a shell command without popping up any windows (particuarly on win32)

5.118.1

Detailed Description

A few system-specific functions.

5.118.2

Member Function Documentation

5.118.2.1

long SysUtils::getCurrentMillis ( ) [static]

Returns the current time in milliseconds.


Returns
Current time
The documentation for this class was generated from the following files:
src/sumo/include/utils/common/SysUtils.h
src/sumo/src/utils/common/SysUtils.cpp

5.119

tl_actuator Class Reference

Component Message and Service Headers.

#include <tl_actuator.hpp>
Inheritance diagram for tl_actuator:
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.119 tl_actuator Class Reference

291

Component
tl_actuator

Public Member Functions


tl_actuator (ComponentConfig &_config, int argc, char argv)
tl_actuator Constructor.

void init_timer_operation (const NAMESPACE::TimerEvent &event)


tl_actuator Initializer This operation is executed immediately after startup.

void ryg_control_sub_operation (const tlc_package::ryg_control::ConstPtr &received_data)


ryg_control_sub_operation;

void startUp ()
Component startup function.

tl_actuator ()
tl_actuator Destructor

virtual void component_sync_operation (const std_msgs::Bool::ConstPtr &received_data)


Component Synchronization This operation establishing a sync point with other components.

void process_queue ()
Component Message Queue handler.

Protected Attributes

ComponentConfig config
int node_argc
char node_argv
NAMESPACE::Publisher comp_sync_pub
NAMESPACE::Subscriber comp_sync_sub
NAMESPACE::Timer init_timer
NAMESPACE::CallbackQueue comp_queue
std::unique_ptr< Logger > logger

5.119.1

Detailed Description

Component Message and Service Headers.


Forward declarations tl_actuator class

5.119.2

Constructor & Destructor Documentation

5.119.2.1

tl_actuator::tl_actuator ( ComponentConfig & _config, int argc, char argv ) [inline]

tl_actuator Constructor.
Parameters

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

292

Class Documentation
_config
argc
argv

in
in

5.119.3
5.119.3.1

Component configuration parsed from deployment XML


command-line argument count
command-line arguments of the actor process

Member Function Documentation


void Component::component_sync_operation ( const std_msgs::Bool::ConstPtr & received_data ) [virtual],

[inherited]
Component Synchronization This operation establishing a sync point with other components.
Parameters
received_data

in

5.119.3.2

Notification message from other components

void tl_actuator::init_timer_operation ( const NAMESPACE::TimerEvent & event ) [virtual]

tl_actuator Initializer This operation is executed immediately after startup.


Parameters
event

in

a oneshot timer event

See Also
startUp()
Reimplemented from Component.

5.119.3.3

void tl_actuator::ryg_control_sub_operation ( const tlc_package::ryg_control::ConstPtr & received_data )

ryg_control_sub_operation;
This operation is executed every time the ryg_control_sub operation request is serviced
Parameters

in

5.119.3.4

received_data

message received by the component subscriber

void tl_actuator::startUp ( ) [virtual]

Component startup function.


This function configures all the component ports and timers
Implements Component.

5.119.4

Member Data Documentation

5.119.4.1

NAMESPACE::CallbackQueue Component::comp_queue [protected], [inherited]

Component Message Queue

5.119.4.2

NAMESPACE::Publisher Component::comp_sync_pub [protected], [inherited]

Synchronization publisher
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.120 tl_sensor Class Reference

5.119.4.3

293

NAMESPACE::Subscriber Component::comp_sync_sub [protected], [inherited]

Synchronization subscriber

5.119.4.4 ComponentConfig Component::config [protected], [inherited]


Component Configuration

5.119.4.5

NAMESPACE::Timer Component::init_timer [protected], [inherited]

Initialization timer

5.119.4.6

std::unique_ptr<Logger> Component::logger [protected], [inherited]

Component logger object

5.119.4.7

int Component::node_argc [protected], [inherited]

argc received by the actor process

5.119.4.8

char Component::node_argv [protected], [inherited]

argv received by the actor process


The documentation for this class was generated from the following files:
src/tlc_package/include/tlc_package/tl_actuator.hpp
src/tlc_package/src/tlc_package/tl_actuator.cpp

5.120

tl_sensor Class Reference

Component Message and Service Headers.

#include <tl_sensor.hpp>
Inheritance diagram for tl_sensor:

Component
tl_sensor

Public Member Functions


tl_sensor (ComponentConfig &_config, int argc, char argv)
tl_sensor Constructor.

void init_timer_operation (const NAMESPACE::TimerEvent &event)


tl_sensor Initializer This operation is executed immediately after startup.

void tl_update_timer_operation (const NAMESPACE::TimerEvent &event)


tl_update_timer_operation;

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

294

Class Documentation

void startUp ()
Component startup function.

tl_sensor ()
tl_sensor Destructor

virtual void component_sync_operation (const std_msgs::Bool::ConstPtr &received_data)


Component Synchronization This operation establishing a sync point with other components.

void process_queue ()
Component Message Queue handler.

Protected Attributes

ComponentConfig config
int node_argc
char node_argv
NAMESPACE::Publisher comp_sync_pub
NAMESPACE::Subscriber comp_sync_sub
NAMESPACE::Timer init_timer
NAMESPACE::CallbackQueue comp_queue
std::unique_ptr< Logger > logger

5.120.1

Detailed Description

Component Message and Service Headers.


Forward declarations tl_sensor class

5.120.2

Constructor & Destructor Documentation

5.120.2.1

tl_sensor::tl_sensor ( ComponentConfig & _config, int argc, char argv ) [inline]

tl_sensor Constructor.
Parameters
_config
argc
argv

in
in

5.120.3
5.120.3.1

Component configuration parsed from deployment XML


command-line argument count
command-line arguments of the actor process

Member Function Documentation


void Component::component_sync_operation ( const std_msgs::Bool::ConstPtr & received_data ) [virtual],

[inherited]
Component Synchronization This operation establishing a sync point with other components.
Parameters

in

5.120.3.2

received_data

Notification message from other components

void tl_sensor::init_timer_operation ( const NAMESPACE::TimerEvent & event ) [virtual]

tl_sensor Initializer This operation is executed immediately after startup.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.120 tl_sensor Class Reference

295

Parameters
event

in

a oneshot timer event

See Also
startUp()
Reimplemented from Component.

5.120.3.3

void tl_sensor::startUp ( ) [virtual]

Component startup function.


This function configures all the component ports and timers
Implements Component.

5.120.3.4

void tl_sensor::tl_update_timer_operation ( const NAMESPACE::TimerEvent & event )

tl_update_timer_operation;
This operation is executed every time the tl_update_timer operation request is serviced
Parameters
event

in

a timer event

5.120.4

Member Data Documentation

5.120.4.1

NAMESPACE::CallbackQueue Component::comp_queue [protected], [inherited]

Component Message Queue

5.120.4.2

NAMESPACE::Publisher Component::comp_sync_pub [protected], [inherited]

Synchronization publisher

5.120.4.3

NAMESPACE::Subscriber Component::comp_sync_sub [protected], [inherited]

Synchronization subscriber

5.120.4.4 ComponentConfig Component::config [protected], [inherited]


Component Configuration

5.120.4.5

NAMESPACE::Timer Component::init_timer [protected], [inherited]

Initialization timer

5.120.4.6

std::unique_ptr<Logger> Component::logger [protected], [inherited]

Component logger object


Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

296

Class Documentation

5.120.4.7

int Component::node_argc [protected], [inherited]

argc received by the actor process

5.120.4.8

char Component::node_argv [protected], [inherited]

argv received by the actor process


The documentation for this class was generated from the following files:
src/tlc_package/include/tlc_package/tl_sensor.hpp
src/tlc_package/src/tlc_package/tl_sensor.cpp

5.121

tl_sensor_stream_ddos Class Reference

Component Message and Service Headers.

#include <tl_sensor_stream_ddos.hpp>
Inheritance diagram for tl_sensor_stream_ddos:

Component
tl_sensor_stream_ddos

Public Member Functions


tl_sensor_stream_ddos (ComponentConfig &_config, int argc, char argv)
tl_sensor_stream_ddos Constructor.

void init_timer_operation (const NAMESPACE::TimerEvent &event)


tl_sensor_stream_ddos Initializer This operation is executed immediately after startup.

void startUp ()
Component startup function.

tl_sensor_stream_ddos ()
tl_sensor_stream_ddos Destructor

virtual void component_sync_operation (const std_msgs::Bool::ConstPtr &received_data)


Component Synchronization This operation establishing a sync point with other components.

void process_queue ()
Component Message Queue handler.

Protected Attributes

ComponentConfig config
int node_argc
char node_argv
NAMESPACE::Publisher comp_sync_pub
NAMESPACE::Subscriber comp_sync_sub
NAMESPACE::Timer init_timer
NAMESPACE::CallbackQueue comp_queue
std::unique_ptr< Logger > logger
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.121 tl_sensor_stream_ddos Class Reference

5.121.1

297

Detailed Description

Component Message and Service Headers.


Forward declarations tl_sensor_stream_ddos class

5.121.2
5.121.2.1

Constructor & Destructor Documentation


tl_sensor_stream_ddos::tl_sensor_stream_ddos ( ComponentConfig & _config, int argc, char argv )

[inline]
tl_sensor_stream_ddos Constructor.
Parameters
_config
argc
argv

in
in

5.121.3
5.121.3.1

Component configuration parsed from deployment XML


command-line argument count
command-line arguments of the actor process

Member Function Documentation


void Component::component_sync_operation ( const std_msgs::Bool::ConstPtr & received_data ) [virtual],

[inherited]
Component Synchronization This operation establishing a sync point with other components.
Parameters
received_data

in

5.121.3.2

Notification message from other components

void tl_sensor_stream_ddos::init_timer_operation ( const NAMESPACE::TimerEvent & event ) [virtual]

tl_sensor_stream_ddos Initializer This operation is executed immediately after startup.


Parameters
event

in

a oneshot timer event

See Also
startUp()
Reimplemented from Component.

5.121.3.3

void tl_sensor_stream_ddos::startUp ( ) [virtual]

Component startup function.


This function configures all the component ports and timers
Implements Component.

5.121.4

Member Data Documentation

5.121.4.1

NAMESPACE::CallbackQueue Component::comp_queue [protected], [inherited]

Component Message Queue


Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

298

Class Documentation

5.121.4.2

NAMESPACE::Publisher Component::comp_sync_pub [protected], [inherited]

Synchronization publisher

5.121.4.3

NAMESPACE::Subscriber Component::comp_sync_sub [protected], [inherited]

Synchronization subscriber

5.121.4.4 ComponentConfig Component::config [protected], [inherited]


Component Configuration

5.121.4.5

NAMESPACE::Timer Component::init_timer [protected], [inherited]

Initialization timer

5.121.4.6

std::unique_ptr<Logger> Component::logger [protected], [inherited]

Component logger object

5.121.4.7

int Component::node_argc [protected], [inherited]

argc received by the actor process

5.121.4.8

char Component::node_argv [protected], [inherited]

argv received by the actor process


The documentation for this class was generated from the following files:
src/tlc_package/include/tlc_package/tl_sensor_stream_ddos.hpp
src/tlc_package/src/tlc_package/tl_sensor_stream_ddos.cpp

5.122

SAXWeightsHandler::ToRetrieveDefinition Class Reference

Complete definition about what shall be retrieved and where to store it.

#include <SAXWeightsHandler.h>

Public Member Functions


ToRetrieveDefinition (const std::string &attributeName, bool edgeBased, EdgeFloatTimeLineRetriever &destination)
Constructor.

ToRetrieveDefinition ()
Destructor.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.123 TplConvert Class Reference

299

Public Attributes
std::string myAttributeName
The attribute name that shall be parsed.

bool myAmEdgeBased
Information whether edge values shall be used (lane value if false)

EdgeFloatTimeLineRetriever & myDestination


The class that shall be called when new data is avaiable.

SUMOReal myAggValue
aggregated value over the lanes read within the current edge

size_t myNoLanes
The number of lanes read for the current edge.

bool myHadAttribute
Information whether the attribute has been found for the current edge.

5.122.1

Detailed Description

Complete definition about what shall be retrieved and where to store it.
The documentation for this class was generated from the following file:
src/sumo/include/utils/xml/SAXWeightsHandler.h

5.123

TplConvert Class Reference

TplConvert Some methods that convert 0-terminated char-arrays of any type into other values (numerical/boolean)
or into std::strings.

#include <TplConvert.h>

Static Public Member Functions


template<class E >
static std::string _2str (const E const data)
converts a 0-terminated char-type array into std::string throws an EmptyData - exception if the given pointer is 0

static std::string _2str (const char const data)


converts a 0-terminated char array into std::string throws an EmptyData - exception if the given pointer is 0

template<class E >
static std::string _2str (const E const data, unsigned length)
converts a char-type array into std::string considering the given length throws an EmptyData - exception if the given
pointer is 0

static std::string _2str (const char const data, unsigned length)


converts a char array into std::string considering the given length throws an EmptyData - exception if the given pointer
is 0

template<class E >
static int _2int (const E const data)
converts a char-type array into the integer value described by it throws an EmptyData - exception if the given string is
empty throws a NumberFormatException - exception when the string does not contain an integer

template<class E >
static int _hex2int (const E const data)
converts a char-type array with a hex value into the integer value described by it throws an EmptyData - exception if
the given string is empty throws a NumberFormatException - exception when the string does not contain an integer

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

300

Class Documentation

template<class E >
static SUMOLong _2long (const E const data)
converts a char-type array into the long value described by it throws an EmptyData - exception if the given string is
empty throws a NumberFormatException - exception when the string does not contain a long

template<class E >
static SUMOLong _hex2long (const E const data)
converts a char-type array with a hex value into the long value described by it throws an EmptyData - exception if the
given string is empty throws a NumberFormatException - exception when the string does not contain a long

template<class E >
static SUMOReal _2SUMOReal (const E const data)
converts a char-type array into the SUMOReal value described by it throws an EmptyData - exception if the given
string is empty throws a NumberFormatException - exception when the string does not contain a SUMOReal

template<class E >
static bool _2bool (const E const data)
converts a 0-terminated char-type array into the boolean value described by it returns true if the data is one of the
following (case insensitive): 1, x, true, yes, on returns false if the data is one of the following (case insensitive):
0, -, false, no, off throws an EmptyData - exception if the given string is empty or 0 pointer throws a BoolFormatException in any other case

template<class E >
static std::string _2strSec (const E const data, const std::string &def)
converts a 0-terminated char-type array into std::string returns the default value if the data is empty

template<class E >
static int _2intSec (const E const data, int def)
converts a 0-terminated char-type array into the integer value described by it returns the default value if the data is
empty

template<class E >
static SUMOLong _2longSec (const E const data, long def)
converts a 0-terminated char-type array into the long value described by it returns the default value if the data is empty

template<class E >
static SUMOReal _2SUMORealSec (const E const data, SUMOReal def)
converts a 0-terminated char-type array into the SUMOReal value described by it returns the default value if the data
is empty

template<class E >
static bool _2boolSec (const E const data, bool def)
converts a 0-terminated char-type array into the SUMOReal value described by it returns true if the data is one of the
following (case insensitive): 1, x, true, yes, on returns false if the data is one of the following (case insensitive):
0, -, false, no, off returns the default value if the data is empty

template<class E >
static std::string _2strSec (const E const data, int length, const std::string &def)
converts a char-type array into std::string considering the given length returns the default value if the data is empty

template<class E >
static unsigned getLength (const E const data)
returns the length of the string (the position of the 0-character)

5.123.1

Detailed Description

TplConvert Some methods that convert 0-terminated char-arrays of any type into other values (numerical/boolean)
or into std::strings.
The documentation for this class was generated from the following file:
src/sumo/include/utils/common/TplConvert.h
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.124 TraCIAPI Class Reference

5.124

301

TraCIAPI Class Reference

C++ TraCI client API implementation.

#include <TraCIAPI.h>
Inheritance diagram for TraCIAPI:

TraCIAPI

SUMO_CLIENT

Classes
class AreaScope
Scope for interaction with areal detectors.

class EdgeScope
Scope for interaction with edges.

class GUIScope
Scope for interaction with the gui.

class InductionLoopScope
Scope for interaction with inductive loops.

class JunctionScope
Scope for interaction with junctions.

class LaneScope
Scope for interaction with lanes.

class MeMeScope
Scope for interaction with multi entry/-exit detectors.

class POIScope
Scope for interaction with POIs.

class PolygonScope
Scope for interaction with polygons.

class RouteScope
Scope for interaction with routes.

class SimulationScope
Scope for interaction with the simulation.

struct TraCIBoundary
A 3D-bounding box.

struct TraCIColor
class TraCILink
class TraCILogic
class TraCIPhase
struct TraCIPosition
A 3D-position.

class TraCIScopeWrapper
An abstract interface for accessing type-dependent values.

class TrafficLightScope
Scope for interaction with traffic lights.

class VehicleTypeScope
Scope for interaction with vehicle types.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

302

Class Documentation

Public Types
Structures definitions
typedef std::vector
< TraCIPosition > TraCIPositionVector

Public Member Functions


TraCIAPI ()
Constructor.

TraCIAPI ()
Destructor.

Connection handling
void connect (const std::string &host, int port)
Connects to the specified SUMO server.

void close ()
Closes the connection.

Atomar getter

SUMOTime getSUMOTime (int cmd, int var, const std::string &id, tcpip::Storage add=0)
int getUnsignedByte (int cmd, int var, const std::string &id, tcpip::Storage add=0)
int getByte (int cmd, int var, const std::string &id, tcpip::Storage add=0)
int getInt (int cmd, int var, const std::string &id, tcpip::Storage add=0)
SUMOReal getFloat (int cmd, int var, const std::string &id, tcpip::Storage add=0)
SUMOReal getDouble (int cmd, int var, const std::string &id, tcpip::Storage add=0)
TraCIBoundary getBoundingBox (int cmd, int var, const std::string &id, tcpip::Storage add=0)
TraCIPositionVector getPolygon (int cmd, int var, const std::string &id, tcpip::Storage add=0)
TraCIPosition getPosition (int cmd, int var, const std::string &id, tcpip::Storage add=0)
std::string getString (int cmd, int var, const std::string &id, tcpip::Storage add=0)
std::vector< std::string > getStringVector (int cmd, int var, const std::string &id, tcpip::Storage add=0)
TraCIColor getColor (int cmd, int var, const std::string &id, tcpip::Storage add=0)

Public Attributes
EdgeScope edge
Scope for interaction with edges.

GUIScope gui
Scope for interaction with the gui.

InductionLoopScope inductionloop
Scope for interaction with inductive loops.

JunctionScope junction
Scope for interaction with junctions.

LaneScope lane
Scope for interaction with lanes.

MeMeScope multientryexit
Scope for interaction with multi-entry/-exit detectors.

POIScope poi
Scope for interaction with POIs.

PolygonScope polygon
Scope for interaction with polygons.

RouteScope route
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.124 TraCIAPI Class Reference

303

Scope for interaction with routes.

SimulationScope simulation
Scope for interaction with the simulation.

TrafficLightScope trafficlights
Scope for interaction with traffic lights.

VehicleTypeScope vehicletype
Scope for interaction with vehicle types.

Protected Member Functions


Command sending methods
void send_commandSimulationStep (SUMOTime time) const
Sends a SimulationStep command.

void send_commandClose () const


Sends a Close command.

void send_commandGetVariable (int domID, int varID, const std::string &objID, tcpip::Storage add=0)
const
Sends a GetVariable request.

void send_commandSetValue (int domID, int varID, const std::string &objID, tcpip::Storage &content) const
Sends a SetVariable request.

void send_commandSubscribeObjectVariable (int domID, const std::string &objID, int beginTime, int endTime, const std::vector< int > &vars) const
Sends a SubscribeVariable request.

void send_commandSubscribeObjectContext (int domID, const std::string &objID, int beginTime, int endTime, int domain, SUMOReal range, const std::vector< int > &vars) const
Sends a SubscribeContext request.

void check_resultState (tcpip::Storage &inMsg, int command, bool ignoreCommandId=false, std::string


acknowledgement=0) const
Validates the result state of a command.

void check_commandGetResult (tcpip::Storage &inMsg, int command, int expectedType=-1, bool ignoreCommandId=false) const
void processGET (tcpip::Storage &inMsg, int command, int expectedType, bool ignoreCommandId=false)
const

Protected Attributes
tcpip::Socket mySocket
The socket.

5.124.1

Detailed Description

C++ TraCI client API implementation.

5.124.2

Member Function Documentation

5.124.2.1

void TraCIAPI::check_resultState ( tcpip::Storage & inMsg, int command, bool ignoreCommandId = false,
std::string acknowledgement = 0 ) const [protected]

Validates the result state of a command.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

304

Class Documentation

Parameters
inMsg
command
ignoreCommandId
acknowledgement

in
in
in
in

5.124.2.2

The buffer to read the message from


The original command id
Whether the returning command id shall be validated
Pointer to an existing string into which the acknowledgement message shall
be inserted

void TraCIAPI::connect ( const std::string & host, int port )

Connects to the specified SUMO server.


Parameters
host
port

in
in

The name of the host to connect to


The port to connect to

Exceptions
tcpip::SocketException

5.124.2.3

if the connection fails

void TraCIAPI::send_commandGetVariable ( int domID, int varID, const std::string & objID, tcpip::Storage add =

0 ) const [protected]
Sends a GetVariable request.
Parameters
domID
varID
objID
add

in
in
in
in

5.124.2.4

The domain of the variable


The variable to retrieve
The object to retrieve the variable from
Optional additional parameter

void TraCIAPI::send_commandSetValue ( int domID, int varID, const std::string & objID, tcpip::Storage & content
) const [protected]

Sends a SetVariable request.


Parameters

in
in
in
in

5.124.2.5

domID
varID
objID
content

The domain of the variable


The variable to set
The object to change
The value of the variable

void TraCIAPI::send_commandSubscribeObjectContext ( int domID, const std::string & objID, int beginTime, int
endTime, int domain, SUMOReal range, const std::vector< int > & vars ) const [protected]

Sends a SubscribeContext request.


Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.125 TraCIAPI::TraCIBoundary Struct Reference

305

Parameters
domID
objID
beginTime
endTime
domain
range
vars

in
in
in
in
in
in
in

5.124.2.6

The domain of the variable


The object to subscribe the variables from
The begin time step of subscriptions
The end time step of subscriptions
The domain of the objects which values shall be returned
The range around the obj to investigate
The variables to subscribe

void TraCIAPI::send_commandSubscribeObjectVariable ( int domID, const std::string & objID, int beginTime, int
endTime, const std::vector< int > & vars ) const [protected]

Sends a SubscribeVariable request.


Parameters
domID
objID
beginTime
endTime
vars

in
in
in
in
in

The domain of the variable


The object to subscribe the variables from
The begin time step of subscriptions
The end time step of subscriptions
The variables to subscribe

The documentation for this class was generated from the following files:
src/sumo/include/utils/traci/TraCIAPI.h
src/sumo/src/utils/traci/TraCIAPI.cpp

5.125

TraCIAPI::TraCIBoundary Struct Reference

A 3D-bounding box.

#include <TraCIAPI.h>

Public Attributes
double xMin
double yMin
double zMin
double xMax
double yMax
double zMax

5.125.1

Detailed Description

A 3D-bounding box.
The documentation for this struct was generated from the following file:
src/sumo/include/utils/traci/TraCIAPI.h

5.126

TraCIAPI::TraCIColor Struct Reference

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

306

Class Documentation

Public Attributes

int r
int g
int b
int a

The documentation for this struct was generated from the following file:
src/sumo/include/utils/traci/TraCIAPI.h

5.127

TraCIException Class Reference

Inheritance diagram for TraCIException:

runtime_error
TraCIException

Public Member Functions


TraCIException (std::string what)
constructor

The documentation for this class was generated from the following file:
src/sumo/include/traci-server/TraCIException.h

5.128

TraCIAPI::TraCILink Class Reference

Public Member Functions


TraCILink (const std::string &_from, const std::string &_via, const std::string &_to)

Public Attributes
std::string from
std::string via
std::string to
The documentation for this class was generated from the following file:
src/sumo/include/utils/traci/TraCIAPI.h

5.129

TraCIAPI::TraCILogic Class Reference

Public Member Functions


TraCILogic (const std::string &_subID, int _type, const std::map< std::string, SUMOReal > &_subParameter,
unsigned int _currentPhaseIndex, const std::vector< TraCIPhase > &_phases)
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.130 TraCIAPI::TraCIPhase Class Reference

307

Public Attributes

std::string subID
int type
std::map< std::string, SUMOReal > subParameter
unsigned int currentPhaseIndex
std::vector< TraCIPhase > phases

The documentation for this class was generated from the following file:
src/sumo/include/utils/traci/TraCIAPI.h

5.130

TraCIAPI::TraCIPhase Class Reference

Public Member Functions


TraCIPhase (const SUMOTime _duration, const SUMOTime _duration1, const SUMOTime _duration2, const
std::string &_phase)

Public Attributes

SUMOTime duration
SUMOTime duration1
SUMOTime duration2
std::string phase

The documentation for this class was generated from the following file:
src/sumo/include/utils/traci/TraCIAPI.h

5.131

TraCIAPI::TraCIPosition Struct Reference

A 3D-position.

#include <TraCIAPI.h>

Public Attributes
double x
double y
double z

5.131.1

Detailed Description

A 3D-position.
A color.
The documentation for this struct was generated from the following file:
src/sumo/include/utils/traci/TraCIAPI.h
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

308

Class Documentation

5.132

TraCIPositionVector Struct Reference

A list of positions.

#include <TraCIAPI.h>

5.132.1

Detailed Description

A list of positions.
The documentation for this struct was generated from the following file:
src/sumo/include/utils/traci/TraCIAPI.h

5.133

TraCIAPI::TraCIScopeWrapper Class Reference

An abstract interface for accessing type-dependent values.

#include <TraCIAPI.h>
Inheritance diagram for TraCIAPI::TraCIScopeWrapper:
TraCIAPI::TraCIScopeWrapper
TraCIAPI::AreaScope
TraCIAPI::EdgeScope
TraCIAPI::GUIScope
TraCIAPI::InductionLoopScope
TraCIAPI::JunctionScope
TraCIAPI::LaneScope
TraCIAPI::MeMeScope
TraCIAPI::POIScope
TraCIAPI::PolygonScope
TraCIAPI::RouteScope
TraCIAPI::SimulationScope
TraCIAPI::TrafficLightScope
TraCIAPI::VehicleTypeScope

Public Member Functions


TraCIScopeWrapper (TraCIAPI &parent)
Constructor.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.134 TraCIServer Class Reference

309

virtual TraCIScopeWrapper ()
Destructor.

Protected Attributes
TraCIAPI & myParent
The parent TraCI client which offers the connection.

5.133.1

Detailed Description

An abstract interface for accessing type-dependent values.


Must be derived by interfaces which implement access methods to certain object types

5.133.2

Constructor & Destructor Documentation

5.133.2.1

TraCIAPI::TraCIScopeWrapper::TraCIScopeWrapper ( TraCIAPI & parent ) [inline]

Constructor.
Parameters
parent

in

The parent TraCI client which offers the connection

The documentation for this class was generated from the following file:
src/sumo/include/utils/traci/TraCIAPI.h

5.134

TraCIServer Class Reference

TraCI server used to control sumo by a remote TraCI client.

#include <TraCIServer.h>
Inheritance diagram for TraCIServer:

VehicleStateListener

TraCIServer

Public Types
typedef bool( CmdExecutor )(TraCIServer &server, tcpip::Storage &inputStorage, tcpip::Storage &outputStorage)
Definition of a method to be called for serving an associated commandID.

Public Member Functions


SUMOTime getTargetTime ()
void setVTDControlled (MSVehicle v, MSLane l, SUMOReal pos, int edgeOffset, ConstMSEdgeVector
route, SUMOTime t)
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

310

Class Documentation

void postProcessVTD ()
void vehicleStateChanged (const SUMOVehicle const vehicle, MSNet::VehicleState to)
const std::map
< MSNet::VehicleState,
std::vector< std::string > > & getVehicleStateChanges () const
void writeResponseWithLength (tcpip::Storage &outputStorage, tcpip::Storage &tempMsg)
void collectObjectsInRange (int domain, const PositionVector &shape, SUMOReal range, std::set< std::string > &into)
Writing Status Messages
void writeStatusCmd (int commandId, int status, const std::string &description, tcpip::Storage &outputStorage)
Writes a status command to the given storage.

void writeStatusCmd (int commandId, int status, const std::string &description)


Writes a status command to myOutputStorage.

bool writeErrorStatusCmd (int commandId, const std::string &description, tcpip::Storage &outputStorage)


Writes a status command to the given storage with status = RTYPE_ERR.

Helpers for reading and checking values


bool readTypeCheckingInt (tcpip::Storage &inputStorage, int &into)
Reads the value type and an int, verifying the type.

bool readTypeCheckingDouble (tcpip::Storage &inputStorage, double &into)


Reads the value type and a double, verifying the type.

bool readTypeCheckingString (tcpip::Storage &inputStorage, std::string &into)


Reads the value type and a string, verifying the type.

bool readTypeCheckingStringList (tcpip::Storage &inputStorage, std::vector< std::string > &into)


Reads the value type and a string list, verifying the type.

bool readTypeCheckingColor (tcpip::Storage &inputStorage, RGBColor &into)


Reads the value type and a color, verifying the type.

bool readTypeCheckingPosition2D (tcpip::Storage &inputStorage, Position &into)


Reads the value type and a 2D position, verifying the type.

bool readTypeCheckingBoundary (tcpip::Storage &inputStorage, Boundary &into)


Reads the value type and a 2D bounding box, verifying the type.

bool readTypeCheckingByte (tcpip::Storage &inputStorage, int &into)


Reads the value type and a byte, verifying the type.

bool readTypeCheckingUnsignedByte (tcpip::Storage &inputStorage, int &into)


Reads the value type and an unsigned byte, verifying the type.

bool readTypeCheckingPolygon (tcpip::Storage &inputStorage, PositionVector &into)


Reads the value type and a polygon, verifying the type.

Static Public Member Functions


static TraCIServer getInstance ()
static void processCommandsUntilSimStep (SUMOTime step)
process all commands until a simulation step is wanted

Initialisation and Shutdown


static void openSocket (const std::map< int, CmdExecutor > &execs)
Initialises the server.

static void close ()


request termination of connection

static bool wasClosed ()


check whether close was requested

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.134 TraCIServer Class Reference

5.134.1

Detailed Description

TraCI server used to control sumo by a remote TraCI client.

5.134.2

Member Function Documentation

5.134.2.1

static void TraCIServer::openSocket ( const std::map< int, CmdExecutor > & execs ) [static]

Initialises the server.


Parameters
execs

in

5.134.2.2

The (additional) command executors to use

bool TraCIServer::readTypeCheckingBoundary ( tcpip::Storage & inputStorage, Boundary & into )

Reads the value type and a 2D bounding box, verifying the type.
Parameters
in,changed]
into

out

inputStorage The storage to read from


Holder of the read value

Returns
Whether a 2D bounding box was given (by data type)

5.134.2.3

bool TraCIServer::readTypeCheckingByte ( tcpip::Storage & inputStorage, int & into )

Reads the value type and a byte, verifying the type.


Parameters
in,changed]
into

out

inputStorage The storage to read from


Holder of the read value

Returns
Whether a byte was given (by data type)

5.134.2.4

bool TraCIServer::readTypeCheckingColor ( tcpip::Storage & inputStorage, RGBColor & into )

Reads the value type and a color, verifying the type.


Parameters

out

in,changed]
into

inputStorage The storage to read from


Holder of the read value

Returns
Whether a color was given (by data type)

5.134.2.5

bool TraCIServer::readTypeCheckingDouble ( tcpip::Storage & inputStorage, double & into )

Reads the value type and a double, verifying the type.


Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

311

312

Class Documentation

Parameters
in,changed]
into

out

inputStorage The storage to read from


Holder of the read value

Returns
Whether a double value was given (by data type)

5.134.2.6

bool TraCIServer::readTypeCheckingInt ( tcpip::Storage & inputStorage, int & into )

Reads the value type and an int, verifying the type.


Parameters
in,changed]
into

out

inputStorage The storage to read from


Holder of the read value

Returns
Whether an integer value was given (by data type)

5.134.2.7

bool TraCIServer::readTypeCheckingPolygon ( tcpip::Storage & inputStorage, PositionVector & into )

Reads the value type and a polygon, verifying the type.


Parameters
in,changed]
into

out

inputStorage The storage to read from


Holder of the read value

Returns
Whether an unsigned byte was given (by data type)

5.134.2.8

bool TraCIServer::readTypeCheckingPosition2D ( tcpip::Storage & inputStorage, Position & into )

Reads the value type and a 2D position, verifying the type.


Parameters

out

in,changed]
into

inputStorage The storage to read from


Holder of the read value

Returns
Whether a 2D position was given (by data type)

5.134.2.9

bool TraCIServer::readTypeCheckingString ( tcpip::Storage & inputStorage, std::string & into )

Reads the value type and a string, verifying the type.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.134 TraCIServer Class Reference

313

Parameters

out

in,changed]
into

inputStorage The storage to read from


Holder of the read value

Returns
Whether a string value was given (by data type)

5.134.2.10

bool TraCIServer::readTypeCheckingStringList ( tcpip::Storage & inputStorage, std::vector< std::string > & into
)

Reads the value type and a string list, verifying the type.
Parameters

out

in,changed]
into

inputStorage The storage to read from


Holder of the read value

Returns
Whether a double value was given (by data type)

5.134.2.11

bool TraCIServer::readTypeCheckingUnsignedByte ( tcpip::Storage & inputStorage, int & into )

Reads the value type and an unsigned byte, verifying the type.
Parameters

out

in,changed]
into

inputStorage The storage to read from


Holder of the read value

Returns
Whether an unsigned byte was given (by data type)

5.134.2.12

static bool TraCIServer::wasClosed ( ) [static]

check whether close was requested


Returns
Whether the connection was closed

5.134.2.13

bool TraCIServer::writeErrorStatusCmd ( int commandId, const std::string & description, tcpip::Storage &
outputStorage )

Writes a status command to the given storage with status = RTYPE_ERR.


Parameters

in
in

commandId
description
in,filled]

The id of the command to respond to


The status description (error message, for example)
outputStorage The storage to write the status into

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

314

5.134.2.14

Class Documentation

void TraCIServer::writeStatusCmd ( int commandId, int status, const std::string & description, tcpip::Storage &
outputStorage )

Writes a status command to the given storage.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.135 TraCIServerAPI_AreaDetector Class Reference

315

Parameters
commandId
status
description
in,filled]

in
in
in

5.134.2.15

The id of the command to respond to


The status to send
The status description (error message, for example)
outputStorage The storage to write the status into

void TraCIServer::writeStatusCmd ( int commandId, int status, const std::string & description )

Writes a status command to myOutputStorage.


Parameters

in
in
in

commandId
status
description

The id of the command to respond to


The status to send
The status description (error message, for example)

The documentation for this class was generated from the following file:
src/sumo/include/traci-server/TraCIServer.h

5.135

TraCIServerAPI_AreaDetector Class Reference

APIs for getting/setting multi-entry/multi-exit detector values via TraCI.

#include <TraCIServerAPI_ArealDetector.h>

5.135.1

Detailed Description

APIs for getting/setting multi-entry/multi-exit detector values via TraCI.


The documentation for this class was generated from the following file:
src/sumo/include/traci-server/TraCIServerAPI_ArealDetector.h

5.136

TraCIServerAPI_ArealDetector Class Reference

Static Public Member Functions


static bool processGet (TraCIServer &server, tcpip::Storage &inputStorage, tcpip::Storage &outputStorage)
Processes a get value command (Command 0xa1: Get AreaDetector Variable)

5.136.1

Member Function Documentation

5.136.1.1

static bool TraCIServerAPI_ArealDetector::processGet ( TraCIServer & server, tcpip::Storage & inputStorage,


tcpip::Storage & outputStorage ) [static]

Processes a get value command (Command 0xa1: Get AreaDetector Variable)

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

316

Class Documentation

Parameters
server
inputStorage
outputStorage

in
in
out

The TraCI-server-instance which schedules this request


The storage to read the command from
The storage to write the result to

The documentation for this class was generated from the following file:
src/sumo/include/traci-server/TraCIServerAPI_ArealDetector.h

5.137

TraCIServerAPI_Edge Class Reference

APIs for getting/setting edge values via TraCI.

#include <TraCIServerAPI_Edge.h>

Static Public Member Functions


static bool processGet (TraCIServer &server, tcpip::Storage &inputStorage, tcpip::Storage &outputStorage)
Processes a get value command (Command 0xaa: Get Edge Variable)

static bool processSet (TraCIServer &server, tcpip::Storage &inputStorage, tcpip::Storage &outputStorage)


Processes a set value command (Command 0xca: Change Edge State)

static bool getShape (const std::string &id, PositionVector &shape)


Returns the named edges shape.

5.137.1

Detailed Description

APIs for getting/setting edge values via TraCI.

5.137.2

Member Function Documentation

5.137.2.1

static bool TraCIServerAPI_Edge::getShape ( const std::string & id, PositionVector & shape ) [static]

Returns the named edges shape.


Parameters

in
out

id
shape

The id of the searched edge


The shape, if the edge is known

Returns
Whether the edge is known

5.137.2.2

static bool TraCIServerAPI_Edge::processGet ( TraCIServer & server, tcpip::Storage & inputStorage,


tcpip::Storage & outputStorage ) [static]

Processes a get value command (Command 0xaa: Get Edge Variable)

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.138 TraCIServerAPI_InductionLoop Class Reference

317

Parameters
server
inputStorage
outputStorage

in
in
out

5.137.2.3

The TraCI-server-instance which schedules this request


The storage to read the command from
The storage to write the result to

static bool TraCIServerAPI_Edge::processSet ( TraCIServer & server, tcpip::Storage & inputStorage,


tcpip::Storage & outputStorage ) [static]

Processes a set value command (Command 0xca: Change Edge State)


Parameters
server
inputStorage
outputStorage

in
in
out

The TraCI-server-instance which schedules this request


The storage to read the command from
The storage to write the result to

The documentation for this class was generated from the following file:
src/sumo/include/traci-server/TraCIServerAPI_Edge.h

5.138

TraCIServerAPI_InductionLoop Class Reference

APIs for getting/setting induction loop values via TraCI.

#include <TraCIServerAPI_InductionLoop.h>

Static Public Member Functions


static bool processGet (TraCIServer &server, tcpip::Storage &inputStorage, tcpip::Storage &outputStorage)
Processes a get value command (Command 0xa0: Get Induction Loop Variable)

static bool getPosition (const std::string &id, Position &p)


Returns the named inductive loops position.

static NamedRTree getTree ()


Returns a tree filled with inductive loop instances.

5.138.1

Detailed Description

APIs for getting/setting induction loop values via TraCI.

5.138.2

Member Function Documentation

5.138.2.1

static bool TraCIServerAPI_InductionLoop::getPosition ( const std::string & id, Position & p ) [static]

Returns the named inductive loops position.


Parameters

in
out

id
p

The id of the searched inductive loop


The position, if the inductive loop is known

Returns
Whether the inductive loop is known (and on road)

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

318

Class Documentation

5.138.2.2

static NamedRTree TraCIServerAPI_InductionLoop::getTree ( ) [static]

Returns a tree filled with inductive loop instances.


Returns
The rtree of inductive loops

5.138.2.3

static bool TraCIServerAPI_InductionLoop::processGet ( TraCIServer & server, tcpip::Storage & inputStorage,


tcpip::Storage & outputStorage ) [static]

Processes a get value command (Command 0xa0: Get Induction Loop Variable)
Parameters
server
inputStorage
outputStorage

in
in
out

The TraCI-server-instance which schedules this request


The storage to read the command from
The storage to write the result to

The documentation for this class was generated from the following file:
src/sumo/include/traci-server/TraCIServerAPI_InductionLoop.h

5.139

TraCIServerAPI_Junction Class Reference

APIs for getting/setting junction values via TraCI.

#include <TraCIServerAPI_Junction.h>

Static Public Member Functions


static bool processGet (TraCIServer &server, tcpip::Storage &inputStorage, tcpip::Storage &outputStorage)
Processes a get value command (Command 0xa9: Get Junction Variable)

static bool getPosition (const std::string &id, Position &p)


Returns the named junctions position.

static NamedRTree getTree ()


Returns a tree filled with junction instances.

5.139.1

Detailed Description

APIs for getting/setting junction values via TraCI.

5.139.2

Member Function Documentation

5.139.2.1

static bool TraCIServerAPI_Junction::getPosition ( const std::string & id, Position & p ) [static]

Returns the named junctions position.


Parameters

in
out

id
p

The id of the searched junction


The position, if the junction is known

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.140 TraCIServerAPI_Lane Class Reference

319

Returns
Whether the junction is known (and on road)

5.139.2.2

static NamedRTree TraCIServerAPI_Junction::getTree ( ) [static]

Returns a tree filled with junction instances.


Returns
The rtree of junctions

5.139.2.3

static bool TraCIServerAPI_Junction::processGet ( TraCIServer & server, tcpip::Storage & inputStorage,


tcpip::Storage & outputStorage ) [static]

Processes a get value command (Command 0xa9: Get Junction Variable)


Parameters

in
in
out

server
inputStorage
outputStorage

The TraCI-server-instance which schedules this request


The storage to read the command from
The storage to write the result to

The documentation for this class was generated from the following file:
src/sumo/include/traci-server/TraCIServerAPI_Junction.h

5.140

TraCIServerAPI_Lane Class Reference

APIs for getting/setting lane values via TraCI.

#include <TraCIServerAPI_Lane.h>

Classes
class StoringVisitor
Allows to store the object; used as context while traveling the rtree in TraCI.

Static Public Member Functions


static bool processGet (TraCIServer &server, tcpip::Storage &inputStorage, tcpip::Storage &outputStorage)
Processes a get value command (Command 0xa3: Get Lane Variable)

static bool processSet (TraCIServer &server, tcpip::Storage &inputStorage, tcpip::Storage &outputStorage)


Processes a set value command (Command 0xc3: Change Lane State)

static bool getShape (const std::string &id, PositionVector &shape)


Returns the named lanes shape.

5.140.1

Detailed Description

APIs for getting/setting lane values via TraCI.


Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

320

Class Documentation

5.140.2

Member Function Documentation

5.140.2.1

static bool TraCIServerAPI_Lane::getShape ( const std::string & id, PositionVector & shape ) [static]

Returns the named lanes shape.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.141 TraCIServerAPI_MeMeDetector Class Reference

321

Parameters
id
shape

in
out

The id of the searched lane


The shape, if the lane is known

Returns
Whether the lane is known

5.140.2.2

static bool TraCIServerAPI_Lane::processGet ( TraCIServer & server, tcpip::Storage & inputStorage,


tcpip::Storage & outputStorage ) [static]

Processes a get value command (Command 0xa3: Get Lane Variable)


Parameters
server
inputStorage
outputStorage

in
in
out

5.140.2.3

The TraCI-server-instance which schedules this request


The storage to read the command from
The storage to write the result to

static bool TraCIServerAPI_Lane::processSet ( TraCIServer & server, tcpip::Storage & inputStorage,


tcpip::Storage & outputStorage ) [static]

Processes a set value command (Command 0xc3: Change Lane State)


Parameters

in
in
out

server
inputStorage
outputStorage

The TraCI-server-instance which schedules this request


The storage to read the command from
The storage to write the result to

The documentation for this class was generated from the following file:
src/sumo/include/traci-server/TraCIServerAPI_Lane.h

5.141

TraCIServerAPI_MeMeDetector Class Reference

APIs for getting/setting multi-entry/multi-exit detector values via TraCI.

#include <TraCIServerAPI_MeMeDetector.h>

Static Public Member Functions


static bool processGet (TraCIServer &server, tcpip::Storage &inputStorage, tcpip::Storage &outputStorage)
Processes a get value command (Command 0xa1: Get MeMeDetector Variable)

5.141.1

Detailed Description

APIs for getting/setting multi-entry/multi-exit detector values via TraCI.

5.141.2

Member Function Documentation

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

322

5.141.2.1

Class Documentation

static bool TraCIServerAPI_MeMeDetector::processGet ( TraCIServer & server, tcpip::Storage & inputStorage,


tcpip::Storage & outputStorage ) [static]

Processes a get value command (Command 0xa1: Get MeMeDetector Variable)

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.142 TraCIServerAPI_Person Class Reference

323

Parameters
server
inputStorage
outputStorage

in
in
out

The TraCI-server-instance which schedules this request


The storage to read the command from
The storage to write the result to

The documentation for this class was generated from the following file:
src/sumo/include/traci-server/TraCIServerAPI_MeMeDetector.h

5.142

TraCIServerAPI_Person Class Reference

APIs for getting/setting person values via TraCI.

#include <TraCIServerAPI_Person.h>

Static Public Member Functions


static bool processGet (TraCIServer &server, tcpip::Storage &inputStorage, tcpip::Storage &outputStorage)
Processes a get value command (Command 0xae: Get Person Variable)

static bool processSet (TraCIServer &server, tcpip::Storage &inputStorage, tcpip::Storage &outputStorage)


Processes a set value command (Command 0xce: Change Person State)

static bool getPosition (const std::string &id, Position &p)


Returns the named personss position.

5.142.1

Detailed Description

APIs for getting/setting person values via TraCI.

5.142.2

Member Function Documentation

5.142.2.1

static bool TraCIServerAPI_Person::getPosition ( const std::string & id, Position & p ) [static]

Returns the named personss position.


Parameters

in
out

id
p

The id of the searched person


The position, if the person is on the network

Returns
Whether the person is known

5.142.2.2

static bool TraCIServerAPI_Person::processGet ( TraCIServer & server, tcpip::Storage & inputStorage,


tcpip::Storage & outputStorage ) [static]

Processes a get value command (Command 0xae: Get Person Variable)

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

324

Class Documentation

Parameters
server
inputStorage
outputStorage

in
in
out

5.142.2.3

The TraCI-server-instance which schedules this request


The storage to read the command from
The storage to write the result to

static bool TraCIServerAPI_Person::processSet ( TraCIServer & server, tcpip::Storage & inputStorage,


tcpip::Storage & outputStorage ) [static]

Processes a set value command (Command 0xce: Change Person State)


Parameters
server
inputStorage
outputStorage

in
in
out

The TraCI-server-instance which schedules this request


The storage to read the command from
The storage to write the result to

The documentation for this class was generated from the following file:
src/sumo/include/traci-server/TraCIServerAPI_Person.h

5.143

TraCIServerAPI_POI Class Reference

APIs for getting/setting POI values via TraCI.

#include <TraCIServerAPI_POI.h>

Static Public Member Functions


static bool processGet (TraCIServer &server, tcpip::Storage &inputStorage, tcpip::Storage &outputStorage)
Processes a get value command (Command 0xa7: Get PoI Variable)

static bool processSet (TraCIServer &server, tcpip::Storage &inputStorage, tcpip::Storage &outputStorage)


Processes a set value command (Command 0xc7: Change PoI State)

static bool getPosition (const std::string &id, Position &p)


Returns the named PoIs position.

static NamedRTree getTree ()


Returns a tree filled with PoI instances.

5.143.1

Detailed Description

APIs for getting/setting POI values via TraCI.

5.143.2

Member Function Documentation

5.143.2.1

static bool TraCIServerAPI_POI::getPosition ( const std::string & id, Position & p ) [static]

Returns the named PoIs position.


Parameters

in
out

id
p

The id of the searched PoI


The position, if the PoI is known

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.144 TraCIServerAPI_Polygon Class Reference

325

Returns
Whether the PoI is known (and on road)

5.143.2.2

static NamedRTree TraCIServerAPI_POI::getTree ( ) [static]

Returns a tree filled with PoI instances.


Returns
The rtree of PoIs

5.143.2.3

static bool TraCIServerAPI_POI::processGet ( TraCIServer & server, tcpip::Storage & inputStorage,


tcpip::Storage & outputStorage ) [static]

Processes a get value command (Command 0xa7: Get PoI Variable)


Parameters
server
inputStorage
outputStorage

in
in
out

5.143.2.4

The TraCI-server-instance which schedules this request


The storage to read the command from
The storage to write the result to

static bool TraCIServerAPI_POI::processSet ( TraCIServer & server, tcpip::Storage & inputStorage,


tcpip::Storage & outputStorage ) [static]

Processes a set value command (Command 0xc7: Change PoI State)


Parameters

in
in
out

server
inputStorage
outputStorage

The TraCI-server-instance which schedules this request


The storage to read the command from
The storage to write the result to

The documentation for this class was generated from the following file:
src/sumo/include/traci-server/TraCIServerAPI_POI.h

5.144

TraCIServerAPI_Polygon Class Reference

APIs for getting/setting polygon values via TraCI.

#include <TraCIServerAPI_Polygon.h>

Static Public Member Functions


static bool processGet (TraCIServer &server, tcpip::Storage &inputStorage, tcpip::Storage &outputStorage)
Processes a get value command (Command 0xa8: Get Polygon Variable)

static bool processSet (TraCIServer &server, tcpip::Storage &inputStorage, tcpip::Storage &outputStorage)


Processes a set value command (Command 0xc8: Change Polygon State)

static bool getShape (const std::string &id, PositionVector &shape)


Returns the named polygonss shape.

static NamedRTree getTree ()


Returns a tree filled with polygon instances.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

326

Class Documentation

5.144.1

Detailed Description

APIs for getting/setting polygon values via TraCI.

5.144.2

Member Function Documentation

5.144.2.1

static bool TraCIServerAPI_Polygon::getShape ( const std::string & id, PositionVector & shape ) [static]

Returns the named polygonss shape.


Parameters
id
shape

in
out

The id of the searched polygon


The shape, if the polygon is known

Returns
Whether the polygon is known

5.144.2.2

static NamedRTree TraCIServerAPI_Polygon::getTree ( ) [static]

Returns a tree filled with polygon instances.


Returns
The rtree of polygons

5.144.2.3

static bool TraCIServerAPI_Polygon::processGet ( TraCIServer & server, tcpip::Storage & inputStorage,


tcpip::Storage & outputStorage ) [static]

Processes a get value command (Command 0xa8: Get Polygon Variable)


Parameters
server
inputStorage
outputStorage

in
in
out

5.144.2.4

The TraCI-server-instance which schedules this request


The storage to read the command from
The storage to write the result to

static bool TraCIServerAPI_Polygon::processSet ( TraCIServer & server, tcpip::Storage & inputStorage,


tcpip::Storage & outputStorage ) [static]

Processes a set value command (Command 0xc8: Change Polygon State)


Parameters

in
in
out

server
inputStorage
outputStorage

The TraCI-server-instance which schedules this request


The storage to read the command from
The storage to write the result to

The documentation for this class was generated from the following file:
src/sumo/include/traci-server/TraCIServerAPI_Polygon.h
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.145 TraCIServerAPI_Route Class Reference

5.145

327

TraCIServerAPI_Route Class Reference

APIs for getting/setting route values via TraCI.

#include <TraCIServerAPI_Route.h>

Static Public Member Functions


static bool processGet (TraCIServer &server, tcpip::Storage &inputStorage, tcpip::Storage &outputStorage)
Processes a get value command (Command 0xa6: Get Route Variable)

static bool processSet (TraCIServer &server, tcpip::Storage &inputStorage, tcpip::Storage &outputStorage)


Processes a set value command (Command 0xc6: Change Route State)

5.145.1

Detailed Description

APIs for getting/setting route values via TraCI.

5.145.2

Member Function Documentation

5.145.2.1

static bool TraCIServerAPI_Route::processGet ( TraCIServer & server, tcpip::Storage & inputStorage,


tcpip::Storage & outputStorage ) [static]

Processes a get value command (Command 0xa6: Get Route Variable)


Parameters
server
inputStorage
outputStorage

in
in
out

5.145.2.2

The TraCI-server-instance which schedules this request


The storage to read the command from
The storage to write the result to

static bool TraCIServerAPI_Route::processSet ( TraCIServer & server, tcpip::Storage & inputStorage,


tcpip::Storage & outputStorage ) [static]

Processes a set value command (Command 0xc6: Change Route State)


Parameters

in
in
out

server
inputStorage
outputStorage

The TraCI-server-instance which schedules this request


The storage to read the command from
The storage to write the result to

The documentation for this class was generated from the following file:
src/sumo/include/traci-server/TraCIServerAPI_Route.h

5.146

TraCIServerAPI_Simulation Class Reference

APIs for getting/setting simulation values via TraCI.

#include <TraCIServerAPI_Simulation.h>
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

328

Class Documentation

Static Public Member Functions


static bool processGet (TraCIServer &server, tcpip::Storage &inputStorage, tcpip::Storage &outputStorage)
Processes a get value command (Command 0xab: Get Simulation Variable)

static bool processSet (TraCIServer &server, tcpip::Storage &inputStorage, tcpip::Storage &outputStorage)


Processes a set value command (Command 0xcb: Set Simulation Variable)

static std::pair< MSLane


, SUMOReal > convertCartesianToRoadMap (Position pos)
Converts a cartesian position to the closest road map position.

static const MSLane getLaneChecking (std::string roadID, int laneIndex, SUMOReal pos)
Converts a road map position to a cartesian position.

static bool commandPositionConversion (TraCIServer &server, tcpip::Storage &inputStorage, tcpip::Storage &outputStorage, int commandId)
static bool commandDistanceRequest (TraCIServer &server, tcpip::Storage &inputStorage, tcpip::Storage
&outputStorage, int commandId)
static void writeVehicleStateNumber (TraCIServer &server, tcpip::Storage &outputStorage, MSNet::VehicleState state)
static void writeVehicleStateIDs (TraCIServer &server, tcpip::Storage &outputStorage, MSNet::VehicleState
state)

5.146.1

Detailed Description

APIs for getting/setting simulation values via TraCI.

5.146.2
5.146.2.1

Member Function Documentation


static std::pair<MSLane, SUMOReal> TraCIServerAPI_Simulation::convertCartesianToRoadMap ( Position pos )

[static]
Converts a cartesian position to the closest road map position.
Parameters
pos

cartesian position that is to be converted

Returns
the closest road map position to the cartesian position

5.146.2.2

static const MSLane TraCIServerAPI_Simulation::getLaneChecking ( std::string roadID, int laneIndex, SUMOReal


pos ) [static]

Converts a road map position to a cartesian position.


Parameters
pos

road map position that is to be convertes

Returns
closest 2D position

5.146.2.3

static bool TraCIServerAPI_Simulation::processGet ( TraCIServer & server, tcpip::Storage & inputStorage,


tcpip::Storage & outputStorage ) [static]

Processes a get value command (Command 0xab: Get Simulation Variable)


Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.147 TraCIServerAPI_TLS Class Reference

329

Parameters
server
inputStorage
outputStorage

in
in
out

5.146.2.4

The TraCI-server-instance which schedules this request


The storage to read the command from
The storage to write the result to

static bool TraCIServerAPI_Simulation::processSet ( TraCIServer & server, tcpip::Storage & inputStorage,


tcpip::Storage & outputStorage ) [static]

Processes a set value command (Command 0xcb: Set Simulation Variable)


Parameters
server
inputStorage
outputStorage

in
in
out

The TraCI-server-instance which schedules this request


The storage to read the command from
The storage to write the result to

The documentation for this class was generated from the following file:
src/sumo/include/traci-server/TraCIServerAPI_Simulation.h

5.147

TraCIServerAPI_TLS Class Reference

APIs for getting/setting traffic light values via TraCI.

#include <TraCIServerAPI_TLS.h>

Static Public Member Functions


static bool processGet (TraCIServer &server, tcpip::Storage &inputStorage, tcpip::Storage &outputStorage)
Processes a get value command (Command 0xa2: Get Traffic Lights Variable)

static bool processSet (TraCIServer &server, tcpip::Storage &inputStorage, tcpip::Storage &outputStorage)


Processes a set value command (Command 0xc2: Change Traffic Lights State)

5.147.1

Detailed Description

APIs for getting/setting traffic light values via TraCI.

5.147.2

Member Function Documentation

5.147.2.1

static bool TraCIServerAPI_TLS::processGet ( TraCIServer & server, tcpip::Storage & inputStorage,


tcpip::Storage & outputStorage ) [static]

Processes a get value command (Command 0xa2: Get Traffic Lights Variable)
Parameters

in
in
out

server
inputStorage
outputStorage

The TraCI-server-instance which schedules this request


The storage to read the command from
The storage to write the result to

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

330

5.147.2.2

Class Documentation

static bool TraCIServerAPI_TLS::processSet ( TraCIServer & server, tcpip::Storage & inputStorage,


tcpip::Storage & outputStorage ) [static]

Processes a set value command (Command 0xc2: Change Traffic Lights State)

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.148 TraCIServerAPI_Vehicle Class Reference

331

Parameters
server
inputStorage
outputStorage

in
in
out

The TraCI-server-instance which schedules this request


The storage to read the command from
The storage to write the result to

The documentation for this class was generated from the following file:
src/sumo/include/traci-server/TraCIServerAPI_TLS.h

5.148

TraCIServerAPI_Vehicle Class Reference

APIs for getting/setting vehicle values via TraCI.

#include <TraCIServerAPI_Vehicle.h>

Static Public Member Functions


static bool processGet (TraCIServer &server, tcpip::Storage &inputStorage, tcpip::Storage &outputStorage)
Processes a get value command (Command 0xa4: Get Vehicle Variable)

static bool processSet (TraCIServer &server, tcpip::Storage &inputStorage, tcpip::Storage &outputStorage)


Processes a set value command (Command 0xc4: Change Vehicle State)

static bool getPosition (const std::string &id, Position &p)


Returns the named vehicles position.

5.148.1

Detailed Description

APIs for getting/setting vehicle values via TraCI.

5.148.2

Member Function Documentation

5.148.2.1

static bool TraCIServerAPI_Vehicle::getPosition ( const std::string & id, Position & p ) [static]

Returns the named vehicles position.


Parameters

in
out

id
p

The id of the searched vehicle


The position, if the vehicle is on the network

Returns
Whether the vehicle is known (and on road)

5.148.2.2

static bool TraCIServerAPI_Vehicle::processGet ( TraCIServer & server, tcpip::Storage & inputStorage,


tcpip::Storage & outputStorage ) [static]

Processes a get value command (Command 0xa4: Get Vehicle Variable)

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

332

Class Documentation

Parameters
server
inputStorage
outputStorage

in
in
out

5.148.2.3

The TraCI-server-instance which schedules this request


The storage to read the command from
The storage to write the result to

static bool TraCIServerAPI_Vehicle::processSet ( TraCIServer & server, tcpip::Storage & inputStorage,


tcpip::Storage & outputStorage ) [static]

Processes a set value command (Command 0xc4: Change Vehicle State)


Parameters

in
in
out

server
inputStorage
outputStorage

The TraCI-server-instance which schedules this request


The storage to read the command from
The storage to write the result to

The documentation for this class was generated from the following file:
src/sumo/include/traci-server/TraCIServerAPI_Vehicle.h

5.149

TraCIServerAPI_VehicleType Class Reference

APIs for getting/setting vehicle type values via TraCI.

#include <TraCIServerAPI_VehicleType.h>

Static Public Member Functions


static bool processGet (TraCIServer &server, tcpip::Storage &inputStorage, tcpip::Storage &outputStorage)
Processes a get value command (Command 0xa5: Get Vehicle Type Variable)

static bool getVariable (const int variable, const MSVehicleType &v, tcpip::Storage &tempMsg)
Processes a value request for the given type.

static bool processSet (TraCIServer &server, tcpip::Storage &inputStorage, tcpip::Storage &outputStorage)


Processes a set value command (Command 0xc5: Change Vehicle Type State)

static bool setVariable (const int cmd, const int variable, MSVehicleType &v, TraCIServer &server, tcpip::Storage &inputStorage, tcpip::Storage &outputStorage)
Processes a set value for the given type.

5.149.1

Detailed Description

APIs for getting/setting vehicle type values via TraCI.

5.149.2

Member Function Documentation

5.149.2.1

static bool TraCIServerAPI_VehicleType::getVariable ( const int variable, const MSVehicleType & v, tcpip::Storage
& tempMsg ) [static]

Processes a value request for the given type.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.150 TraCIAPI::TrafficLightScope Class Reference

333

Parameters
variable
v
tempMsg

in
in
out

5.149.2.2

The type variable asked for


The vehicle type to get the value from
The storage to write the result to

static bool TraCIServerAPI_VehicleType::processGet ( TraCIServer & server, tcpip::Storage & inputStorage,


tcpip::Storage & outputStorage ) [static]

Processes a get value command (Command 0xa5: Get Vehicle Type Variable)
Parameters
server
inputStorage
outputStorage

in
in
out

5.149.2.3

The TraCI-server-instance which schedules this request


The storage to read the command from
The storage to write the result to

static bool TraCIServerAPI_VehicleType::processSet ( TraCIServer & server, tcpip::Storage & inputStorage,


tcpip::Storage & outputStorage ) [static]

Processes a set value command (Command 0xc5: Change Vehicle Type State)
Parameters

in
in
out

server
inputStorage
outputStorage

The TraCI-server-instance which schedules this request


The storage to read the command from
The storage to write the result to

The documentation for this class was generated from the following file:
src/sumo/include/traci-server/TraCIServerAPI_VehicleType.h

5.150

TraCIAPI::TrafficLightScope Class Reference

Scope for interaction with traffic lights.

#include <TraCIAPI.h>
Inheritance diagram for TraCIAPI::TrafficLightScope:

TraCIAPI::TraCIScopeWrapper
TraCIAPI::TrafficLightScope

Public Member Functions


TrafficLightScope (TraCIAPI &parent)
std::vector< std::string > getIDList () const
std::string getRedYellowGreenState (const std::string &tlsID) const
std::vector< TraCIAPI::TraCILogic > getCompleteRedYellowGreenDefinition (const std::string &tlsID)
const
std::vector< std::string > getControlledLanes (const std::string &tlsID) const
std::vector< TraCIAPI::TraCILink > getControlledLinks (const std::string &tlsID) const

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

334

Class Documentation

std::string getProgram (const std::string &tlsID) const


unsigned int getPhase (const std::string &tlsID) const
unsigned int getNextSwitch (const std::string &tlsID) const
void setRedYellowGreenState (const std::string &tlsID, const std::string &state) const
void setPhase (const std::string &tlsID, unsigned int index) const
void setProgram (const std::string &tlsID, const std::string &programID) const
void setPhaseDuration (const std::string &tlsID, unsigned int phaseDuration) const
void setCompleteRedYellowGreenDefinition (const std::string &tlsID, const TraCIAPI::TraCILogic &logic)
const

Protected Attributes
TraCIAPI & myParent
The parent TraCI client which offers the connection.

5.150.1

Detailed Description

Scope for interaction with traffic lights.


The documentation for this class was generated from the following files:
src/sumo/include/utils/traci/TraCIAPI.h
src/sumo/src/utils/traci/TraCIAPI.cpp

5.151

UnknownElement Class Reference

UnknownElement Thrown when a named element is tried to be accesed which is not known to the container.

#include <UtilExceptions.h>
Inheritance diagram for UnknownElement:

runtime_error

UnknownElement

Public Member Functions


UnknownElement ()
constructor

UnknownElement (const std::string &msg)


constructor

5.151.1

Detailed Description

UnknownElement Thrown when a named element is tried to be accesed which is not known to the container.
The documentation for this class was generated from the following file:
src/sumo/include/utils/common/UtilExceptions.h
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.152 ValueRetriever< T > Class Template Reference

5.152

335

ValueRetriever< T > Class Template Reference

Public Member Functions


virtual void addValue (T value)=0
The documentation for this class was generated from the following file:
src/sumo/include/utils/common/ValueRetriever.h

5.153

ValueSource< T > Class Template Reference

Public Member Functions


virtual T getValue () const =0
virtual ValueSource copy () const =0
virtual ValueSource< SUMOReal > makeSUMORealReturningCopy () const =0
The documentation for this class was generated from the following file:
src/sumo/include/utils/common/ValueSource.h

5.154

ValueTimeLine< T > Class Template Reference

A time line being a sorted container of non-overlapping time-ranges with assigned values.

#include <ValueTimeLine.h>

Public Member Functions


ValueTimeLine ()
Constructor.

ValueTimeLine ()
Destructor.

void add (SUMOReal begin, SUMOReal end, T value)


Adds a value for a time interval into the container.

T getValue (SUMOReal time) const


Returns the value for the given time.

bool describesTime (SUMOReal time) const


Returns whether a value for the given time is known.

SUMOReal getSplitTime (SUMOReal low, SUMOReal high) const


Returns the time point at which the value changes.

void fillGaps (T value, bool extendOverBoundaries=false)


Sets a default value for all unset intervals.

5.154.1

Detailed Description

template<typename T>class ValueTimeLine< T >


A time line being a sorted container of non-overlapping time-ranges with assigned values.
The container is sorted by the first value of the time-range while being filled. Every new inserted time range may
overwrite or split one or multiple earlier intervals.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

336

Class Documentation

5.154.2

Member Function Documentation

5.154.2.1

template<typename T > void ValueTimeLine< T >::add ( SUMOReal begin, SUMOReal end, T value )
[inline]

Adds a value for a time interval into the container.


Make sure that begin >= 0 and begin < end.
Parameters
begin
end
value

in
in
in

5.154.2.2

the start time of the time range (inclusive)


the end time of the time range (exclusive)
the value to store

template<typename T > bool ValueTimeLine< T >::describesTime ( SUMOReal time ) const [inline]

Returns whether a value for the given time is known.


This method implements the bounds checking. It returns true if and only if an explicit value was set for the given
time using add. Default values stemming from fillGaps are not considered valid.
Parameters
the

in

time for which the value should be retrieved

Returns
whether a valid value was set

5.154.2.3

template<typename T > void ValueTimeLine< T >::fillGaps ( T value, bool extendOverBoundaries = false )


[inline]

Sets a default value for all unset intervals.


Parameters
value
extendOverBoundaries

in
in

5.154.2.4

the value to store


whether the first/last value should be valid for later / earlier times as well

template<typename T > SUMOReal ValueTimeLine< T >::getSplitTime ( SUMOReal low, SUMOReal high )


const [inline]

Returns the time point at which the value changes.


If the two input parameters lie in two consecutive time intervals, this method returns the point at which the interval
changes. In any other case -1 is returned.
Parameters

in
in

low
high

the time in the first interval


the time in the second interval

Returns
the split point

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.155 VectorHelper< T > Class Template Reference

5.154.2.5

337

template<typename T > T ValueTimeLine< T >::getValue ( SUMOReal time ) const [inline]

Returns the value for the given time.


There is no bounds checking applied! If there was no value set, the return value is undefined, the method may even
segfault.
Parameters
the

in

time for which the value should be retrieved

Returns
the value for the time
The documentation for this class was generated from the following file:
src/sumo/include/utils/common/ValueTimeLine.h

5.155

VectorHelper< T > Class Template Reference

Static Public Member Functions


static T sum (const std::vector< T > &v)
static void normaliseSum (std::vector< T > &v, T msum=1.0)
static void div (std::vector< T > &v, T by)
static void removeDouble (std::vector< T > &v)
static void set (std::vector< T > &v, T to)
static T maxValue (const std::vector< T > &v)
static T minValue (const std::vector< T > &v)
static void remove_smaller_than (std::vector< T > &v, T swell)
static void remove_larger_than (std::vector< T > &v, T swell)
static void add2All (std::vector< T > &v, T what)
static bool subSetExists (const std::vector< T > &v1, const std::vector< T > &v2)
Returns the information whether at least one element is within both vectors.

The documentation for this class was generated from the following file:
src/sumo/include/utils/common/VectorHelper.h

5.156

TraCIAPI::VehicleTypeScope Class Reference

Scope for interaction with vehicle types.

#include <TraCIAPI.h>
Inheritance diagram for TraCIAPI::VehicleTypeScope:

TraCIAPI::TraCIScopeWrapper
TraCIAPI::VehicleTypeScope

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

338

Class Documentation

Public Member Functions


VehicleTypeScope (TraCIAPI &parent)
std::vector< std::string > getIDList () const
SUMOReal getLength (const std::string &typeID) const
SUMOReal getMaxSpeed (const std::string &typeID) const
SUMOReal getSpeedFactor (const std::string &typeID) const
SUMOReal getSpeedDeviation (const std::string &typeID) const
SUMOReal getAccel (const std::string &typeID) const
SUMOReal getDecel (const std::string &typeID) const
SUMOReal getImperfection (const std::string &typeID) const
SUMOReal getTau (const std::string &typeID) const
std::string getVehicleClass (const std::string &typeID) const
std::string getEmissionClass (const std::string &typeID) const
std::string getShapeClass (const std::string &typeID) const
SUMOReal getMinGap (const std::string &typeID) const
SUMOReal getWidth (const std::string &typeID) const
TraCIColor getColor (const std::string &typeID) const
void setLength (const std::string &typeID, SUMOReal length) const
void setMaxSpeed (const std::string &typeID, SUMOReal speed) const
void setVehicleClass (const std::string &typeID, const std::string &clazz) const
void setSpeedFactor (const std::string &typeID, SUMOReal factor) const
void setSpeedDeviation (const std::string &typeID, SUMOReal deviation) const
void setEmissionClass (const std::string &typeID, const std::string &clazz) const
void setWidth (const std::string &typeID, SUMOReal width) const
void setMinGap (const std::string &typeID, SUMOReal minGap) const
void setShapeClass (const std::string &typeID, const std::string &clazz) const
void setAccel (const std::string &typeID, SUMOReal accel) const
void setDecel (const std::string &typeID, SUMOReal decel) const
void setImperfection (const std::string &typeID, SUMOReal imperfection) const
void setTau (const std::string &typeID, SUMOReal tau) const
void setColor (const std::string &typeID, const TraCIColor &c) const

Protected Attributes
TraCIAPI & myParent
The parent TraCI client which offers the connection.

5.156.1

Detailed Description

Scope for interaction with vehicle types.


The documentation for this class was generated from the following files:
src/sumo/include/utils/traci/TraCIAPI.h
src/sumo/src/utils/traci/TraCIAPI.cpp
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.157 WrappingCommand< T > Class Template Reference

339

WrappingCommand< T > Class Template Reference

5.157

A wrapper for a Command function.

#include <WrappingCommand.h>
Inheritance diagram for WrappingCommand< T >:

Command
WrappingCommand< T >

Public Types
typedef SUMOTime(T:: Operation )(SUMOTime)
Type of the function to execute.

Public Member Functions


WrappingCommand (T receiver, Operation operation)
Constructor.

WrappingCommand ()
Destructor.

void deschedule ()
Marks this Command as being descheduled.

Derived from Command


SUMOTime execute (SUMOTime currentTime)
Executes the command.

5.157.1

Detailed Description

template<class T>class WrappingCommand< T >


A wrapper for a Command function.
In order to ease life, this class may encapsulate a method of a class which in order to be used as a Command.
This allows to use a member methods of a class to be called as Commands are, avoiding that the instance itself is
destroyed by the EventHandler.
Because in some cases, the Command may live longer than the instance class, a boolean value indicates that the
Command is "descheduled". It should be set via "deschedule" as soon as the class instance of which a method is
encapsulated is destroyed and forces that the command (calling of this instaces method) is not executed.
See Also
Design Patterns, Gamma et al.
Command
MSEventControl
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

340

Class Documentation

5.157.2

Constructor & Destructor Documentation

5.157.2.1

template<class T > WrappingCommand< T >::WrappingCommand ( T receiver, Operation operation )


[inline]

Constructor.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.158 rapidxml::xml_attribute< Ch > Class Template Reference

341

Parameters
receiver
operation

in
in

Pointer to object of type T that will receive a call to one of its methods.
The objects method that will be called on execute()

5.157.3

Member Function Documentation

5.157.3.1

template<class T > void WrappingCommand< T >::deschedule ( ) [inline]

Marks this Command as being descheduled.


A simple boolean marker ("myAmDescheduledByParent") is set which prevents this command from being executed.

template<class T > SUMOTime WrappingCommand< T >::execute ( SUMOTime currentTime ) [inline],


[virtual]

5.157.3.2

Executes the command.


If the command is not descheduled, the stored method of the stored instance is called.
Parameters
currentTime

in

The current simulation time

Returns
The time after which the command shall be executed again, 0 if this command shall be descheduled.
Exceptions
ProcessError

Derived actions may throw this exception

Implements Command.
The documentation for this class was generated from the following file:
src/sumo/include/utils/common/WrappingCommand.h

5.158

rapidxml::xml_attribute< Ch > Class Template Reference

Class representing attribute node of XML document.

#include <rapidxml.hpp>
Inheritance diagram for rapidxml::xml_attribute< Ch >:

rapidxml::xml_base< Ch >
rapidxml::xml_attribute< Ch >

Public Member Functions


xml_attribute ()
Constructs an empty attribute with the specified type.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

342

Class Documentation
xml_document< Ch > document () const
Gets document of which attribute is a child.

xml_attribute< Ch > previous_attribute (const Ch name=0, std::size_t name_size=0, bool case_sensitive=true) const
Gets previous attribute, optionally matching attribute name.

xml_attribute< Ch > next_attribute (const Ch name=0, std::size_t name_size=0, bool case_sensitive=true) const
Gets next attribute, optionally matching attribute name.

Ch name () const
Gets name of the node.

void name (const Ch name, std::size_t size)


Sets name of node to a non zero-terminated string.

void name (const Ch name)


Sets name of node to a zero-terminated string.

std::size_t name_size () const


Gets size of node name, not including terminator character.

Ch value () const
Gets value of node.

void value (const Ch value, std::size_t size)


Sets value of node to a non zero-terminated string.

void value (const Ch value)


Sets value of node to a zero-terminated string.

std::size_t value_size () const


Gets size of node value, not including terminator character.

xml_node< Ch > parent () const


Gets node parent.

Static Protected Member Functions


static Ch nullstr ()

Protected Attributes

Ch m_name
Ch m_value
std::size_t m_name_size
std::size_t m_value_size
xml_node< Ch > m_parent

Friends
class xml_node< Ch >

5.158.1

Detailed Description

template<class Ch>class rapidxml::xml_attribute< Ch >


Class representing attribute node of XML document.
Each attribute has name and value strings, which are available through name() and value() functions (inherited
from xml_base). Note that after parse, both name and value of attribute will point to interior of source text used for
parsing. Thus, this text must persist in memory for the lifetime of attribute.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.158 rapidxml::xml_attribute< Ch > Class Template Reference

343

Parameters
Ch

Character type to use.

5.158.2

Constructor & Destructor Documentation

5.158.2.1

template<class Ch> rapidxml::xml_attribute< Ch >::xml_attribute ( ) [inline]

Constructs an empty attribute with the specified type.


Consider using memory_pool of appropriate xml_document if allocating attributes manually.

5.158.3

Member Function Documentation

5.158.3.1

template<class Ch> xml_document<Ch> rapidxml::xml_attribute< Ch >::document ( ) const


[inline]

Gets document of which attribute is a child.


Returns
Pointer to document that contains this attribute, or 0 if there is no parent document.

5.158.3.2

template<class Ch = char> Ch rapidxml::xml_base< Ch >::name (


[inherited]

) const [inline],

Gets name of the node.


Interpretation of name depends on type of node. Note that name will not be zero-terminated if rapidxml::parse_no_string_terminators option was selected during parse.
Use name_size() function to determine length of the name.
Returns
Name of node, or empty string if node has no name.

5.158.3.3

template<class Ch = char> void rapidxml::xml_base< Ch >::name ( const Ch name, std::size_t size )


[inline], [inherited]

Sets name of node to a non zero-terminated string.


See ownership_of_strings.
Note that node does not own its name or value, it only stores a pointer to it. It will not delete or otherwise free the
pointer on destruction. It is reponsibility of the user to properly manage lifetime of the string. The easiest way to
achieve it is to use memory_pool of the document to allocate the string - on destruction of the document the string
will be automatically freed.
Size of name must be specified separately, because name does not have to be zero terminated. Use name(const
Ch ) function to have the length automatically calculated (string must be zero terminated).
Parameters
name
size

Name of node to set. Does not have to be zero terminated.


Size of name, in characters. This does not include zero terminator, if one is present.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

344

Class Documentation

5.158.3.4

template<class Ch = char> void rapidxml::xml_base< Ch >::name ( const Ch name ) [inline],


[inherited]

Sets name of node to a zero-terminated string.


See also ownership_of_strings and xml_node::name(const Ch , std::size_t).
Parameters
name

5.158.3.5

Name of node to set. Must be zero terminated.

template<class Ch = char> std::size_t rapidxml::xml_base< Ch >::name_size ( ) const [inline],


[inherited]

Gets size of node name, not including terminator character.


This function works correctly irrespective of whether name is or is not zero terminated.
Returns
Size of node name, in characters.

5.158.3.6

template<class Ch> xml_attribute<Ch> rapidxml::xml_attribute< Ch >::next_attribute ( const Ch


name = 0, std::size_t name_size = 0, bool case_sensitive = true ) const [inline]

Gets next attribute, optionally matching attribute name.


Parameters
name
name_size
case_sensitive

Name of attribute to find, or 0 to return next attribute regardless of its name; this string doesnt
have to be zero-terminated if name_size is non-zero
Size of name, in characters, or 0 to have size calculated automatically from string
Should name comparison be case-sensitive; non case-sensitive comparison works properly
only for ASCII characters

Returns
Pointer to found attribute, or 0 if not found.

5.158.3.7

template<class Ch = char> xml_node<Ch> rapidxml::xml_base< Ch >::parent ( ) const [inline],


[inherited]

Gets node parent.


Returns
Pointer to parent node, or 0 if there is no parent.

5.158.3.8

template<class Ch> xml_attribute<Ch> rapidxml::xml_attribute< Ch >::previous_attribute ( const Ch


name = 0, std::size_t name_size = 0, bool case_sensitive = true ) const [inline]

Gets previous attribute, optionally matching attribute name.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.158 rapidxml::xml_attribute< Ch > Class Template Reference

345

Parameters
name
name_size
case_sensitive

Name of attribute to find, or 0 to return previous attribute regardless of its name; this string
doesnt have to be zero-terminated if name_size is non-zero
Size of name, in characters, or 0 to have size calculated automatically from string
Should name comparison be case-sensitive; non case-sensitive comparison works properly
only for ASCII characters

Returns
Pointer to found attribute, or 0 if not found.

5.158.3.9

template<class Ch = char> Ch rapidxml::xml_base< Ch >::value (


[inherited]

) const [inline],

Gets value of node.


Interpretation of value depends on type of node. Note that value will not be zero-terminated if rapidxml::parse_no_string_terminators option was selected during parse.
Use value_size() function to determine length of the value.
Returns
Value of node, or empty string if node has no value.

5.158.3.10

template<class Ch = char> void rapidxml::xml_base< Ch >::value ( const Ch value, std::size_t size )


[inline], [inherited]

Sets value of node to a non zero-terminated string.


See ownership_of_strings.
Note that node does not own its name or value, it only stores a pointer to it. It will not delete or otherwise free the
pointer on destruction. It is reponsibility of the user to properly manage lifetime of the string. The easiest way to
achieve it is to use memory_pool of the document to allocate the string - on destruction of the document the string
will be automatically freed.
Size of value must be specified separately, because it does not have to be zero terminated. Use value(const Ch )
function to have the length automatically calculated (string must be zero terminated).
If an element has a child node of type node_data, it will take precedence over element value when printing. If
you want to manipulate data of elements using values, use parser flag rapidxml::parse_no_data_nodes to prevent
creation of data nodes by the parser.
Parameters
value
size

5.158.3.11

value of node to set. Does not have to be zero terminated.


Size of value, in characters. This does not include zero terminator, if one is present.

template<class Ch = char> void rapidxml::xml_base< Ch >::value ( const Ch value ) [inline],


[inherited]

Sets value of node to a zero-terminated string.


See also ownership_of_strings and xml_node::value(const Ch , std::size_t).

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

346

Class Documentation

Parameters
value

5.158.3.12

Vame of node to set. Must be zero terminated.

template<class Ch = char> std::size_t rapidxml::xml_base< Ch >::value_size ( ) const [inline],


[inherited]

Gets size of node value, not including terminator character.


This function works correctly irrespective of whether value is or is not zero terminated.
Returns
Size of node value, in characters.
The documentation for this class was generated from the following file:
src/node/include/node/rapidxml.hpp

5.159

rapidxml::xml_base< Ch > Class Template Reference

Base class for xml_node and xml_attribute implementing common functions: name(), name_size(), value(), value_size() and parent().

#include <rapidxml.hpp>
Inheritance diagram for rapidxml::xml_base< Ch >:

rapidxml::xml_base< Ch >
rapidxml::xml_attribute< Ch >

rapidxml::xml_node< Ch >
rapidxml::xml_document< Ch >

Public Member Functions


Ch name () const
Gets name of the node.

std::size_t name_size () const


Gets size of node name, not including terminator character.

Ch value () const
Gets value of node.

std::size_t value_size () const


Gets size of node value, not including terminator character.

void name (const Ch name, std::size_t size)


Sets name of node to a non zero-terminated string.

void name (const Ch name)


Sets name of node to a zero-terminated string.

void value (const Ch value, std::size_t size)


Sets value of node to a non zero-terminated string.

void value (const Ch value)


Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.159 rapidxml::xml_base< Ch > Class Template Reference

347

Sets value of node to a zero-terminated string.

xml_node< Ch > parent () const


Gets node parent.

Static Protected Member Functions


static Ch nullstr ()

Protected Attributes

Ch m_name
Ch m_value
std::size_t m_name_size
std::size_t m_value_size
xml_node< Ch > m_parent

5.159.1

Detailed Description

template<class Ch = char>class rapidxml::xml_base< Ch >


Base class for xml_node and xml_attribute implementing common functions: name(), name_size(), value(), value_size() and parent().
Parameters
Ch

Character type to use

5.159.2

Member Function Documentation

5.159.2.1

template<class Ch = char> Ch rapidxml::xml_base< Ch >::name ( ) const [inline]

Gets name of the node.


Interpretation of name depends on type of node. Note that name will not be zero-terminated if rapidxml::parse_no_string_terminators option was selected during parse.
Use name_size() function to determine length of the name.
Returns
Name of node, or empty string if node has no name.

5.159.2.2

template<class Ch = char> void rapidxml::xml_base< Ch >::name ( const Ch name, std::size_t size )


[inline]

Sets name of node to a non zero-terminated string.


See ownership_of_strings.
Note that node does not own its name or value, it only stores a pointer to it. It will not delete or otherwise free the
pointer on destruction. It is reponsibility of the user to properly manage lifetime of the string. The easiest way to
achieve it is to use memory_pool of the document to allocate the string - on destruction of the document the string
will be automatically freed.
Size of name must be specified separately, because name does not have to be zero terminated. Use name(const
Ch ) function to have the length automatically calculated (string must be zero terminated).

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

348

Class Documentation

Parameters
name
size

5.159.2.3

Name of node to set. Does not have to be zero terminated.


Size of name, in characters. This does not include zero terminator, if one is present.

template<class Ch = char> void rapidxml::xml_base< Ch >::name ( const Ch name ) [inline]

Sets name of node to a zero-terminated string.


See also ownership_of_strings and xml_node::name(const Ch , std::size_t).
Parameters
name

5.159.2.4

Name of node to set. Must be zero terminated.

template<class Ch = char> std::size_t rapidxml::xml_base< Ch >::name_size ( ) const [inline]

Gets size of node name, not including terminator character.


This function works correctly irrespective of whether name is or is not zero terminated.
Returns
Size of node name, in characters.

5.159.2.5

template<class Ch = char> xml_node<Ch> rapidxml::xml_base< Ch >::parent ( ) const [inline]

Gets node parent.


Returns
Pointer to parent node, or 0 if there is no parent.

5.159.2.6

template<class Ch = char> Ch rapidxml::xml_base< Ch >::value ( ) const [inline]

Gets value of node.


Interpretation of value depends on type of node. Note that value will not be zero-terminated if rapidxml::parse_no_string_terminators option was selected during parse.
Use value_size() function to determine length of the value.
Returns
Value of node, or empty string if node has no value.

5.159.2.7

template<class Ch = char> void rapidxml::xml_base< Ch >::value ( const Ch value, std::size_t size )


[inline]

Sets value of node to a non zero-terminated string.


See ownership_of_strings.
Note that node does not own its name or value, it only stores a pointer to it. It will not delete or otherwise free the
pointer on destruction. It is reponsibility of the user to properly manage lifetime of the string. The easiest way to
achieve it is to use memory_pool of the document to allocate the string - on destruction of the document the string
will be automatically freed.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.160 rapidxml::xml_document< Ch > Class Template Reference

349

Size of value must be specified separately, because it does not have to be zero terminated. Use value(const Ch )
function to have the length automatically calculated (string must be zero terminated).
If an element has a child node of type node_data, it will take precedence over element value when printing. If
you want to manipulate data of elements using values, use parser flag rapidxml::parse_no_data_nodes to prevent
creation of data nodes by the parser.
Parameters
value
size

5.159.2.8

value of node to set. Does not have to be zero terminated.


Size of value, in characters. This does not include zero terminator, if one is present.

template<class Ch = char> void rapidxml::xml_base< Ch >::value ( const Ch value ) [inline]

Sets value of node to a zero-terminated string.


See also ownership_of_strings and xml_node::value(const Ch , std::size_t).
Parameters
value

5.159.2.9

Vame of node to set. Must be zero terminated.

template<class Ch = char> std::size_t rapidxml::xml_base< Ch >::value_size ( ) const [inline]

Gets size of node value, not including terminator character.


This function works correctly irrespective of whether value is or is not zero terminated.
Returns
Size of node value, in characters.
The documentation for this class was generated from the following file:
src/node/include/node/rapidxml.hpp

5.160

rapidxml::xml_document< Ch > Class Template Reference

This class represents root of the DOM hierarchy.

#include <rapidxml.hpp>
Inheritance diagram for rapidxml::xml_document< Ch >:

rapidxml::xml_base< Ch >
rapidxml::xml_node< Ch >

rapidxml::memory_pool< Ch >

rapidxml::xml_document< Ch >

Public Member Functions


xml_document ()
Constructs empty XML document.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

350

Class Documentation

template<int Flags>
void parse (Ch text)
Parses zero-terminated XML string according to given flags.

void clear ()
Clears the document by deleting all nodes and clearing the memory pool.

node_type type () const


Gets type of node.

void type (node_type type)


Sets type of node.

xml_document< Ch > document () const


Gets document of which node is a child.

xml_node< Ch > first_node (const Ch name=0, std::size_t name_size=0, bool case_sensitive=true) const
Gets first child node, optionally matching node name.

xml_node< Ch > last_node (const Ch name=0, std::size_t name_size=0, bool case_sensitive=true) const
Gets last child node, optionally matching node name.

xml_node< Ch > previous_sibling (const Ch name=0, std::size_t name_size=0, bool case_sensitive=true)


const
Gets previous sibling node, optionally matching node name.

xml_node< Ch > next_sibling (const Ch name=0, std::size_t name_size=0, bool case_sensitive=true)


const
Gets next sibling node, optionally matching node name.

xml_attribute< Ch > first_attribute (const Ch name=0, std::size_t name_size=0, bool case_sensitive=true)


const
Gets first attribute of node, optionally matching attribute name.

xml_attribute< Ch > last_attribute (const Ch name=0, std::size_t name_size=0, bool case_sensitive=true)


const
Gets last attribute of node, optionally matching attribute name.

void prepend_node (xml_node< Ch > child)


Prepends a new child node.

void append_node (xml_node< Ch > child)


Appends a new child node.

void insert_node (xml_node< Ch > where, xml_node< Ch > child)


Inserts a new child node at specified place inside the node.

void remove_first_node ()
Removes first child node.

void remove_last_node ()
Removes last child of the node.

void remove_node (xml_node< Ch > where)


Removes specified child from the node.

void remove_all_nodes ()
Removes all child nodes (but not attributes).

void prepend_attribute (xml_attribute< Ch > attribute)


Prepends a new attribute to the node.

void append_attribute (xml_attribute< Ch > attribute)


Appends a new attribute to the node.

void insert_attribute (xml_attribute< Ch > where, xml_attribute< Ch > attribute)


Inserts a new attribute at specified place inside the node.

void remove_first_attribute ()
Removes first attribute of the node.

void remove_last_attribute ()
Removes last attribute of the node.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.160 rapidxml::xml_document< Ch > Class Template Reference

351

void remove_attribute (xml_attribute< Ch > where)


Removes specified attribute from node.

void remove_all_attributes ()
Removes all attributes of node.

Ch name () const
Gets name of the node.

void name (const Ch name, std::size_t size)


Sets name of node to a non zero-terminated string.

void name (const Ch name)


Sets name of node to a zero-terminated string.

std::size_t name_size () const


Gets size of node name, not including terminator character.

Ch value () const
Gets value of node.

void value (const Ch value, std::size_t size)


Sets value of node to a non zero-terminated string.

void value (const Ch value)


Sets value of node to a zero-terminated string.

std::size_t value_size () const


Gets size of node value, not including terminator character.

xml_node< Ch > parent () const


Gets node parent.

xml_node< Ch > allocate_node (node_type type, const Ch name=0, const Ch value=0, std::size_t
name_size=0, std::size_t value_size=0)
Allocates a new node from the pool, and optionally assigns name and value to it.

xml_attribute< Ch > allocate_attribute (const Ch name=0, const Ch value=0, std::size_t name_size=0,


std::size_t value_size=0)
Allocates a new attribute from the pool, and optionally assigns name and value to it.

Ch allocate_string (const Ch source=0, std::size_t size=0)


Allocates a char array of given size from the pool, and optionally copies a given string to it.

xml_node< Ch > clone_node (const xml_node< Ch > source, xml_node< Ch > result=0)
Clones an xml_node and its hierarchy of child nodes and attributes.

void set_allocator (alloc_func af, free_func ff)


Sets or resets the user-defined memory allocation functions for the pool.

Static Protected Member Functions


static Ch nullstr ()

Protected Attributes
Ch m_name
Ch m_value
std::size_t m_name_size
std::size_t m_value_size
xml_node< Ch > m_parent
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

352

Class Documentation

5.160.1

Detailed Description

template<class Ch>class rapidxml::xml_document< Ch >


This class represents root of the DOM hierarchy.
It is also an xml_node and a memory_pool through public inheritance. Use parse() function to build a DOM tree from
a zero-terminated XML text string. parse() function allocates memory for nodes and attributes by using functions of
xml_document, which are inherited from memory_pool. To access root node of the document, use the document
itself, as if it was an xml_node.
Parameters
Ch

Character type to use.

5.160.2

Member Function Documentation

5.160.2.1

template<class Ch = char> xml_attribute<Ch> rapidxml::memory_pool< Ch >::allocate_attribute (


const Ch name = 0, const Ch value = 0, std::size_t name_size = 0, std::size_t value_size = 0 ) [inline],

[inherited]
Allocates a new attribute from the pool, and optionally assigns name and value to it.
If the allocation request cannot be accomodated, this function will throw std::bad_alloc. If exceptions are
disabled by defining RAPIDXML_NO_EXCEPTIONS, this function will call rapidxml::parse_error_handler() function.
Parameters
name
value
name_size
value_size

Name to assign to the attribute, or 0 to assign no name.


Value to assign to the attribute, or 0 to assign no value.
Size of name to assign, or 0 to automatically calculate size from name string.
Size of value to assign, or 0 to automatically calculate size from value string.

Returns
Pointer to allocated attribute. This pointer will never be NULL.

5.160.2.2

template<class Ch = char> xml_node<Ch> rapidxml::memory_pool< Ch >::allocate_node ( node_type


type, const Ch name = 0, const Ch value = 0, std::size_t name_size = 0, std::size_t value_size = 0 )
[inline], [inherited]

Allocates a new node from the pool, and optionally assigns name and value to it.
If the allocation request cannot be accomodated, this function will throw std::bad_alloc. If exceptions are
disabled by defining RAPIDXML_NO_EXCEPTIONS, this function will call rapidxml::parse_error_handler() function.
Parameters
type
name
value
name_size
value_size

Type of node to create.


Name to assign to the node, or 0 to assign no name.
Value to assign to the node, or 0 to assign no value.
Size of name to assign, or 0 to automatically calculate size from name string.
Size of value to assign, or 0 to automatically calculate size from value string.

Returns
Pointer to allocated node. This pointer will never be NULL.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.160 rapidxml::xml_document< Ch > Class Template Reference

5.160.2.3

353

template<class Ch = char> Ch rapidxml::memory_pool< Ch >::allocate_string ( const Ch source = 0,


std::size_t size = 0 ) [inline], [inherited]

Allocates a char array of given size from the pool, and optionally copies a given string to it.
If the allocation request cannot be accomodated, this function will throw std::bad_alloc. If exceptions are
disabled by defining RAPIDXML_NO_EXCEPTIONS, this function will call rapidxml::parse_error_handler() function.
Parameters
source
size

String to initialize the allocated memory with, or 0 to not initialize it.


Number of characters to allocate, or zero to calculate it automatically from source string
length; if size is 0, source string must be specified and null terminated.

Returns
Pointer to allocated char array. This pointer will never be NULL.

5.160.2.4

template<class Ch> void rapidxml::xml_node< Ch >::append_attribute ( xml_attribute< Ch > attribute )


[inline], [inherited]

Appends a new attribute to the node.


Parameters
attribute

5.160.2.5

Attribute to append.

template<class Ch> void rapidxml::xml_node< Ch >::append_node ( xml_node< Ch > child )


[inline], [inherited]

Appends a new child node.


The appended child becomes the last child.
Parameters
child

5.160.2.6

Node to append.

template<class Ch > void rapidxml::xml_document< Ch >::clear ( ) [inline]

Clears the document by deleting all nodes and clearing the memory pool.
All nodes owned by document pool are destroyed.

5.160.2.7

template<class Ch = char> xml_node<Ch> rapidxml::memory_pool< Ch >::clone_node ( const


xml_node< Ch > source, xml_node< Ch > result = 0 ) [inline], [inherited]

Clones an xml_node and its hierarchy of child nodes and attributes.


Nodes and attributes are allocated from this memory pool. Names and values are not cloned, they are shared
between the clone and the source. Result node can be optionally specified as a second parameter, in which case
its contents will be replaced with cloned source node. This is useful when you want to clone entire document.
Parameters
source
result

Node to clone.
Node to put results in, or 0 to automatically allocate result node

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

354

Class Documentation

Returns
Pointer to cloned node. This pointer will never be NULL.

5.160.2.8

template<class Ch> xml_document<Ch> rapidxml::xml_node< Ch >::document ( ) const


[inline], [inherited]

Gets document of which node is a child.


Returns
Pointer to document that contains this node, or 0 if there is no parent document.

5.160.2.9

template<class Ch> xml_attribute<Ch> rapidxml::xml_node< Ch >::first_attribute ( const Ch name =


0, std::size_t name_size = 0, bool case_sensitive = true ) const [inline], [inherited]

Gets first attribute of node, optionally matching attribute name.


Parameters
name
name_size
case_sensitive

Name of attribute to find, or 0 to return first attribute regardless of its name; this string doesnt
have to be zero-terminated if name_size is non-zero
Size of name, in characters, or 0 to have size calculated automatically from string
Should name comparison be case-sensitive; non case-sensitive comparison works properly
only for ASCII characters

Returns
Pointer to found attribute, or 0 if not found.

5.160.2.10

template<class Ch> xml_node<Ch> rapidxml::xml_node< Ch >::first_node ( const Ch name = 0,


std::size_t name_size = 0, bool case_sensitive = true ) const [inline], [inherited]

Gets first child node, optionally matching node name.


Parameters
name
name_size
case_sensitive

Name of child to find, or 0 to return first child regardless of its name; this string doesnt have
to be zero-terminated if name_size is non-zero
Size of name, in characters, or 0 to have size calculated automatically from string
Should name comparison be case-sensitive; non case-sensitive comparison works properly
only for ASCII characters

Returns
Pointer to found child, or 0 if not found.

5.160.2.11

template<class Ch> void rapidxml::xml_node< Ch >::insert_attribute ( xml_attribute< Ch > where,


xml_attribute< Ch > attribute ) [inline], [inherited]

Inserts a new attribute at specified place inside the node.


All attributes after and including the specified attribute are moved one position back.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.160 rapidxml::xml_document< Ch > Class Template Reference

355

Parameters
where
attribute

5.160.2.12

Place where to insert the attribute, or 0 to insert at the back.


Attribute to insert.

template<class Ch> void rapidxml::xml_node< Ch >::insert_node ( xml_node< Ch > where,


xml_node< Ch > child ) [inline], [inherited]

Inserts a new child node at specified place inside the node.


All children after and including the specified node are moved one position back.
Parameters
where
child

5.160.2.13

Place where to insert the child, or 0 to insert at the back.


Node to insert.

template<class Ch> xml_attribute<Ch> rapidxml::xml_node< Ch >::last_attribute ( const Ch name =


0, std::size_t name_size = 0, bool case_sensitive = true ) const [inline], [inherited]

Gets last attribute of node, optionally matching attribute name.


Parameters
name
name_size
case_sensitive

Name of attribute to find, or 0 to return last attribute regardless of its name; this string doesnt
have to be zero-terminated if name_size is non-zero
Size of name, in characters, or 0 to have size calculated automatically from string
Should name comparison be case-sensitive; non case-sensitive comparison works properly
only for ASCII characters

Returns
Pointer to found attribute, or 0 if not found.

5.160.2.14

template<class Ch> xml_node<Ch> rapidxml::xml_node< Ch >::last_node ( const Ch name = 0,


std::size_t name_size = 0, bool case_sensitive = true ) const [inline], [inherited]

Gets last child node, optionally matching node name.


Behaviour is undefined if node has no children. Use first_node() to test if node has children.
Parameters
name
name_size
case_sensitive

Name of child to find, or 0 to return last child regardless of its name; this string doesnt have
to be zero-terminated if name_size is non-zero
Size of name, in characters, or 0 to have size calculated automatically from string
Should name comparison be case-sensitive; non case-sensitive comparison works properly
only for ASCII characters

Returns
Pointer to found child, or 0 if not found.

5.160.2.15

template<class Ch = char> Ch rapidxml::xml_base< Ch >::name (


[inherited]

Gets name of the node.


Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

) const [inline],

356

Class Documentation

Interpretation of name depends on type of node. Note that name will not be zero-terminated if rapidxml::parse_no_string_terminators option was selected during parse.
Use name_size() function to determine length of the name.
Returns
Name of node, or empty string if node has no name.

5.160.2.16

template<class Ch = char> void rapidxml::xml_base< Ch >::name ( const Ch name, std::size_t size )


[inline], [inherited]

Sets name of node to a non zero-terminated string.


See ownership_of_strings.
Note that node does not own its name or value, it only stores a pointer to it. It will not delete or otherwise free the
pointer on destruction. It is reponsibility of the user to properly manage lifetime of the string. The easiest way to
achieve it is to use memory_pool of the document to allocate the string - on destruction of the document the string
will be automatically freed.
Size of name must be specified separately, because name does not have to be zero terminated. Use name(const
Ch ) function to have the length automatically calculated (string must be zero terminated).
Parameters
name
size

5.160.2.17

Name of node to set. Does not have to be zero terminated.


Size of name, in characters. This does not include zero terminator, if one is present.

template<class Ch = char> void rapidxml::xml_base< Ch >::name ( const Ch name ) [inline],


[inherited]

Sets name of node to a zero-terminated string.


See also ownership_of_strings and xml_node::name(const Ch , std::size_t).
Parameters
name

5.160.2.18

Name of node to set. Must be zero terminated.

template<class Ch = char> std::size_t rapidxml::xml_base< Ch >::name_size ( ) const [inline],


[inherited]

Gets size of node name, not including terminator character.


This function works correctly irrespective of whether name is or is not zero terminated.
Returns
Size of node name, in characters.

5.160.2.19

template<class Ch> xml_node<Ch> rapidxml::xml_node< Ch >::next_sibling ( const Ch name = 0,


std::size_t name_size = 0, bool case_sensitive = true ) const [inline], [inherited]

Gets next sibling node, optionally matching node name.


Behaviour is undefined if node has no parent. Use parent() to test if node has a parent.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.160 rapidxml::xml_document< Ch > Class Template Reference

357

Parameters
name
name_size
case_sensitive

Name of sibling to find, or 0 to return next sibling regardless of its name; this string doesnt
have to be zero-terminated if name_size is non-zero
Size of name, in characters, or 0 to have size calculated automatically from string
Should name comparison be case-sensitive; non case-sensitive comparison works properly
only for ASCII characters

Returns
Pointer to found sibling, or 0 if not found.

5.160.2.20

template<class Ch = char> xml_node<Ch> rapidxml::xml_base< Ch >::parent ( ) const [inline],


[inherited]

Gets node parent.


Returns
Pointer to parent node, or 0 if there is no parent.

5.160.2.21

template<class Ch > template<int Flags> void rapidxml::xml_document< Ch >::parse ( Ch text )


[inline]

Parses zero-terminated XML string according to given flags.


Passed string will be modified by the parser, unless rapidxml::parse_non_destructive flag is used. The string must
persist for the lifetime of the document. In case of error, rapidxml::parse_error exception will be thrown.
If you want to parse contents of a file, you must first load the file into the memory, and pass pointer to its beginning.
Make sure that data is zero-terminated.
Document can be parsed into multiple times. Each new call to parse removes previous nodes and attributes (if any),
but does not clear memory pool.
Parameters
text

5.160.2.22

XML data to parse; pointer is non-const to denote fact that this data may be modified by the
parser.

template<class Ch> void rapidxml::xml_node< Ch >::prepend_attribute ( xml_attribute< Ch > attribute


) [inline], [inherited]

Prepends a new attribute to the node.


Parameters
attribute

5.160.2.23

Attribute to prepend.

template<class Ch> void rapidxml::xml_node< Ch >::prepend_node ( xml_node< Ch > child )


[inline], [inherited]

Prepends a new child node.


The prepended child becomes the first child, and all existing children are moved one position back.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

358

Class Documentation

Parameters
child

5.160.2.24

Node to prepend.

template<class Ch> xml_node<Ch> rapidxml::xml_node< Ch >::previous_sibling ( const Ch name =


0, std::size_t name_size = 0, bool case_sensitive = true ) const [inline], [inherited]

Gets previous sibling node, optionally matching node name.


Behaviour is undefined if node has no parent. Use parent() to test if node has a parent.
Parameters
name
name_size
case_sensitive

Name of sibling to find, or 0 to return previous sibling regardless of its name; this string
doesnt have to be zero-terminated if name_size is non-zero
Size of name, in characters, or 0 to have size calculated automatically from string
Should name comparison be case-sensitive; non case-sensitive comparison works properly
only for ASCII characters

Returns
Pointer to found sibling, or 0 if not found.

5.160.2.25

template<class Ch> void rapidxml::xml_node< Ch >::remove_attribute ( xml_attribute< Ch > where )


[inline], [inherited]

Removes specified attribute from node.


Parameters
where

5.160.2.26

Pointer to attribute to be removed.

template<class Ch> void rapidxml::xml_node< Ch >::remove_first_attribute ( ) [inline],


[inherited]

Removes first attribute of the node.


If node has no attributes, behaviour is undefined. Use first_attribute() to test if node has attributes.

5.160.2.27

template<class Ch> void rapidxml::xml_node< Ch >::remove_first_node ( ) [inline],


[inherited]

Removes first child node.


If node has no children, behaviour is undefined. Use first_node() to test if node has children.

5.160.2.28

template<class Ch> void rapidxml::xml_node< Ch >::remove_last_attribute ( ) [inline],


[inherited]

Removes last attribute of the node.


If node has no attributes, behaviour is undefined. Use first_attribute() to test if node has attributes.

5.160.2.29

template<class Ch> void rapidxml::xml_node< Ch >::remove_last_node (


[inherited]

) [inline],

Removes last child of the node.


Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.160 rapidxml::xml_document< Ch > Class Template Reference

359

If node has no children, behaviour is undefined. Use first_node() to test if node has children.

5.160.2.30

template<class Ch = char> void rapidxml::memory_pool< Ch >::set_allocator ( alloc_func af, free_func


ff ) [inline], [inherited]

Sets or resets the user-defined memory allocation functions for the pool.
This can only be called when no memory is allocated from the pool yet, otherwise results are undefined. Allocation
function must not return invalid pointer on failure. It should either throw, stop the program, or use longjmp()
function to pass control to other place of program. If it returns invalid pointer, results are undefined.
User defined allocation functions must have the following forms:

void allocate(std::size_t size);


void free(void pointer);
Parameters
af
ff

5.160.2.31

Allocation function, or 0 to restore default function


Free function, or 0 to restore default function

template<class Ch> node_type rapidxml::xml_node< Ch >::type (


[inherited]

) const [inline],

Gets type of node.


Returns
Type of node.

5.160.2.32

template<class Ch> void rapidxml::xml_node< Ch >::type ( node_type type ) [inline],


[inherited]

Sets type of node.


Parameters
type

5.160.2.33

Type of node to set.

template<class Ch = char> Ch rapidxml::xml_base< Ch >::value (


[inherited]

) const [inline],

Gets value of node.


Interpretation of value depends on type of node. Note that value will not be zero-terminated if rapidxml::parse_no_string_terminators option was selected during parse.
Use value_size() function to determine length of the value.
Returns
Value of node, or empty string if node has no value.

5.160.2.34

template<class Ch = char> void rapidxml::xml_base< Ch >::value ( const Ch value, std::size_t size )


[inline], [inherited]

Sets value of node to a non zero-terminated string.


Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

360

Class Documentation

See ownership_of_strings.
Note that node does not own its name or value, it only stores a pointer to it. It will not delete or otherwise free the
pointer on destruction. It is reponsibility of the user to properly manage lifetime of the string. The easiest way to
achieve it is to use memory_pool of the document to allocate the string - on destruction of the document the string
will be automatically freed.
Size of value must be specified separately, because it does not have to be zero terminated. Use value(const Ch )
function to have the length automatically calculated (string must be zero terminated).
If an element has a child node of type node_data, it will take precedence over element value when printing. If
you want to manipulate data of elements using values, use parser flag rapidxml::parse_no_data_nodes to prevent
creation of data nodes by the parser.
Parameters
value
size

value of node to set. Does not have to be zero terminated.


Size of value, in characters. This does not include zero terminator, if one is present.

template<class Ch = char> void rapidxml::xml_base< Ch >::value ( const Ch value ) [inline],


[inherited]

5.160.2.35

Sets value of node to a zero-terminated string.


See also ownership_of_strings and xml_node::value(const Ch , std::size_t).
Parameters
value

5.160.2.36

Vame of node to set. Must be zero terminated.

template<class Ch = char> std::size_t rapidxml::xml_base< Ch >::value_size ( ) const [inline],


[inherited]

Gets size of node value, not including terminator character.


This function works correctly irrespective of whether value is or is not zero terminated.

Returns
Size of node value, in characters.

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

src/node/include/node/rapidxml.hpp

5.161

rapidxml::xml_node< Ch > Class Template Reference

Class representing a node of XML document.

#include <rapidxml.hpp>
Inheritance diagram for rapidxml::xml_node< Ch >:
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.161 rapidxml::xml_node< Ch > Class Template Reference

361

rapidxml::xml_base< Ch >
rapidxml::xml_node< Ch >
rapidxml::xml_document< Ch >

Public Member Functions


xml_node (node_type type)
Constructs an empty node with the specified type.

node_type type () const


Gets type of node.

xml_document< Ch > document () const


Gets document of which node is a child.

xml_node< Ch > first_node (const Ch name=0, std::size_t name_size=0, bool case_sensitive=true) const
Gets first child node, optionally matching node name.

xml_node< Ch > last_node (const Ch name=0, std::size_t name_size=0, bool case_sensitive=true) const
Gets last child node, optionally matching node name.

xml_node< Ch > previous_sibling (const Ch name=0, std::size_t name_size=0, bool case_sensitive=true)


const
Gets previous sibling node, optionally matching node name.

xml_node< Ch > next_sibling (const Ch name=0, std::size_t name_size=0, bool case_sensitive=true)


const
Gets next sibling node, optionally matching node name.

xml_attribute< Ch > first_attribute (const Ch name=0, std::size_t name_size=0, bool case_sensitive=true)


const
Gets first attribute of node, optionally matching attribute name.

xml_attribute< Ch > last_attribute (const Ch name=0, std::size_t name_size=0, bool case_sensitive=true)


const
Gets last attribute of node, optionally matching attribute name.

void type (node_type type)


Sets type of node.

void prepend_node (xml_node< Ch > child)


Prepends a new child node.

void append_node (xml_node< Ch > child)


Appends a new child node.

void insert_node (xml_node< Ch > where, xml_node< Ch > child)


Inserts a new child node at specified place inside the node.

void remove_first_node ()
Removes first child node.

void remove_last_node ()
Removes last child of the node.

void remove_node (xml_node< Ch > where)


Removes specified child from the node.

void remove_all_nodes ()
Removes all child nodes (but not attributes).

void prepend_attribute (xml_attribute< Ch > attribute)


Prepends a new attribute to the node.

void append_attribute (xml_attribute< Ch > attribute)


Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

362

Class Documentation

Appends a new attribute to the node.

void insert_attribute (xml_attribute< Ch > where, xml_attribute< Ch > attribute)


Inserts a new attribute at specified place inside the node.

void remove_first_attribute ()
Removes first attribute of the node.

void remove_last_attribute ()
Removes last attribute of the node.

void remove_attribute (xml_attribute< Ch > where)


Removes specified attribute from node.

void remove_all_attributes ()
Removes all attributes of node.

Ch name () const
Gets name of the node.

void name (const Ch name, std::size_t size)


Sets name of node to a non zero-terminated string.

void name (const Ch name)


Sets name of node to a zero-terminated string.

std::size_t name_size () const


Gets size of node name, not including terminator character.

Ch value () const
Gets value of node.

void value (const Ch value, std::size_t size)


Sets value of node to a non zero-terminated string.

void value (const Ch value)


Sets value of node to a zero-terminated string.

std::size_t value_size () const


Gets size of node value, not including terminator character.

xml_node< Ch > parent () const


Gets node parent.

Static Protected Member Functions


static Ch nullstr ()

Protected Attributes

Ch m_name
Ch m_value
std::size_t m_name_size
std::size_t m_value_size
xml_node< Ch > m_parent

5.161.1

Detailed Description

template<class Ch>class rapidxml::xml_node< Ch >


Class representing a node of XML document.
Each node may have associated name and value strings, which are available through name() and value() functions.
Interpretation of name and value depends on type of the node. Type of node can be determined by using type()
function.
Note that after parse, both name and value of node, if any, will point interior of source text used for parsing. Thus,
this text must persist in the memory for the lifetime of node.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.161 rapidxml::xml_node< Ch > Class Template Reference

363

Parameters
Ch

Character type to use.

5.161.2

Constructor & Destructor Documentation

5.161.2.1

template<class Ch> rapidxml::xml_node< Ch >::xml_node ( node_type type ) [inline]

Constructs an empty node with the specified type.


Consider using memory_pool of appropriate document to allocate nodes manually.
Parameters
type

Type of node to construct.

5.161.3

Member Function Documentation

5.161.3.1

template<class Ch> void rapidxml::xml_node< Ch >::append_attribute ( xml_attribute< Ch > attribute )


[inline]

Appends a new attribute to the node.


Parameters
attribute

5.161.3.2

Attribute to append.

template<class Ch> void rapidxml::xml_node< Ch >::append_node ( xml_node< Ch > child )


[inline]

Appends a new child node.


The appended child becomes the last child.
Parameters
child

5.161.3.3

Node to append.

template<class Ch> xml_document<Ch> rapidxml::xml_node< Ch >::document ( ) const


[inline]

Gets document of which node is a child.


Returns
Pointer to document that contains this node, or 0 if there is no parent document.

5.161.3.4

template<class Ch> xml_attribute<Ch> rapidxml::xml_node< Ch >::first_attribute ( const Ch name =


0, std::size_t name_size = 0, bool case_sensitive = true ) const [inline]

Gets first attribute of node, optionally matching attribute name.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

364

Class Documentation

Parameters
name
name_size
case_sensitive

Name of attribute to find, or 0 to return first attribute regardless of its name; this string doesnt
have to be zero-terminated if name_size is non-zero
Size of name, in characters, or 0 to have size calculated automatically from string
Should name comparison be case-sensitive; non case-sensitive comparison works properly
only for ASCII characters

Returns
Pointer to found attribute, or 0 if not found.

5.161.3.5

template<class Ch> xml_node<Ch> rapidxml::xml_node< Ch >::first_node ( const Ch name = 0,


std::size_t name_size = 0, bool case_sensitive = true ) const [inline]

Gets first child node, optionally matching node name.


Parameters
name
name_size
case_sensitive

Name of child to find, or 0 to return first child regardless of its name; this string doesnt have
to be zero-terminated if name_size is non-zero
Size of name, in characters, or 0 to have size calculated automatically from string
Should name comparison be case-sensitive; non case-sensitive comparison works properly
only for ASCII characters

Returns
Pointer to found child, or 0 if not found.

5.161.3.6

template<class Ch> void rapidxml::xml_node< Ch >::insert_attribute ( xml_attribute< Ch > where,


xml_attribute< Ch > attribute ) [inline]

Inserts a new attribute at specified place inside the node.


All attributes after and including the specified attribute are moved one position back.
Parameters
where
attribute

5.161.3.7

Place where to insert the attribute, or 0 to insert at the back.


Attribute to insert.

template<class Ch> void rapidxml::xml_node< Ch >::insert_node ( xml_node< Ch > where,


xml_node< Ch > child ) [inline]

Inserts a new child node at specified place inside the node.


All children after and including the specified node are moved one position back.
Parameters
where
child

5.161.3.8

Place where to insert the child, or 0 to insert at the back.


Node to insert.

template<class Ch> xml_attribute<Ch> rapidxml::xml_node< Ch >::last_attribute ( const Ch name =


0, std::size_t name_size = 0, bool case_sensitive = true ) const [inline]

Gets last attribute of node, optionally matching attribute name.


Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.161 rapidxml::xml_node< Ch > Class Template Reference

365

Parameters
name
name_size
case_sensitive

Name of attribute to find, or 0 to return last attribute regardless of its name; this string doesnt
have to be zero-terminated if name_size is non-zero
Size of name, in characters, or 0 to have size calculated automatically from string
Should name comparison be case-sensitive; non case-sensitive comparison works properly
only for ASCII characters

Returns
Pointer to found attribute, or 0 if not found.

5.161.3.9

template<class Ch> xml_node<Ch> rapidxml::xml_node< Ch >::last_node ( const Ch name = 0,


std::size_t name_size = 0, bool case_sensitive = true ) const [inline]

Gets last child node, optionally matching node name.


Behaviour is undefined if node has no children. Use first_node() to test if node has children.
Parameters
name
name_size
case_sensitive

Name of child to find, or 0 to return last child regardless of its name; this string doesnt have
to be zero-terminated if name_size is non-zero
Size of name, in characters, or 0 to have size calculated automatically from string
Should name comparison be case-sensitive; non case-sensitive comparison works properly
only for ASCII characters

Returns
Pointer to found child, or 0 if not found.

5.161.3.10

template<class Ch = char> Ch rapidxml::xml_base< Ch >::name (


[inherited]

) const [inline],

Gets name of the node.


Interpretation of name depends on type of node. Note that name will not be zero-terminated if rapidxml::parse_no_string_terminators option was selected during parse.
Use name_size() function to determine length of the name.
Returns
Name of node, or empty string if node has no name.

5.161.3.11

template<class Ch = char> void rapidxml::xml_base< Ch >::name ( const Ch name, std::size_t size )


[inline], [inherited]

Sets name of node to a non zero-terminated string.


See ownership_of_strings.
Note that node does not own its name or value, it only stores a pointer to it. It will not delete or otherwise free the
pointer on destruction. It is reponsibility of the user to properly manage lifetime of the string. The easiest way to
achieve it is to use memory_pool of the document to allocate the string - on destruction of the document the string
will be automatically freed.
Size of name must be specified separately, because name does not have to be zero terminated. Use name(const
Ch ) function to have the length automatically calculated (string must be zero terminated).
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

366

Class Documentation

Parameters
name
size

5.161.3.12

Name of node to set. Does not have to be zero terminated.


Size of name, in characters. This does not include zero terminator, if one is present.

template<class Ch = char> void rapidxml::xml_base< Ch >::name ( const Ch name ) [inline],


[inherited]

Sets name of node to a zero-terminated string.


See also ownership_of_strings and xml_node::name(const Ch , std::size_t).
Parameters
name

5.161.3.13

Name of node to set. Must be zero terminated.

template<class Ch = char> std::size_t rapidxml::xml_base< Ch >::name_size ( ) const [inline],


[inherited]

Gets size of node name, not including terminator character.


This function works correctly irrespective of whether name is or is not zero terminated.
Returns
Size of node name, in characters.

5.161.3.14

template<class Ch> xml_node<Ch> rapidxml::xml_node< Ch >::next_sibling ( const Ch name = 0,


std::size_t name_size = 0, bool case_sensitive = true ) const [inline]

Gets next sibling node, optionally matching node name.


Behaviour is undefined if node has no parent. Use parent() to test if node has a parent.
Parameters
name
name_size
case_sensitive

Name of sibling to find, or 0 to return next sibling regardless of its name; this string doesnt
have to be zero-terminated if name_size is non-zero
Size of name, in characters, or 0 to have size calculated automatically from string
Should name comparison be case-sensitive; non case-sensitive comparison works properly
only for ASCII characters

Returns
Pointer to found sibling, or 0 if not found.

5.161.3.15

template<class Ch = char> xml_node<Ch> rapidxml::xml_base< Ch >::parent ( ) const [inline],


[inherited]

Gets node parent.


Returns
Pointer to parent node, or 0 if there is no parent.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.161 rapidxml::xml_node< Ch > Class Template Reference

5.161.3.16

367

template<class Ch> void rapidxml::xml_node< Ch >::prepend_attribute ( xml_attribute< Ch > attribute


) [inline]

Prepends a new attribute to the node.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

368

Class Documentation

Parameters
attribute

5.161.3.17

Attribute to prepend.

template<class Ch> void rapidxml::xml_node< Ch >::prepend_node ( xml_node< Ch > child )


[inline]

Prepends a new child node.


The prepended child becomes the first child, and all existing children are moved one position back.
Parameters
child

5.161.3.18

Node to prepend.

template<class Ch> xml_node<Ch> rapidxml::xml_node< Ch >::previous_sibling ( const Ch name =


0, std::size_t name_size = 0, bool case_sensitive = true ) const [inline]

Gets previous sibling node, optionally matching node name.


Behaviour is undefined if node has no parent. Use parent() to test if node has a parent.
Parameters
name
name_size
case_sensitive

Name of sibling to find, or 0 to return previous sibling regardless of its name; this string
doesnt have to be zero-terminated if name_size is non-zero
Size of name, in characters, or 0 to have size calculated automatically from string
Should name comparison be case-sensitive; non case-sensitive comparison works properly
only for ASCII characters

Returns
Pointer to found sibling, or 0 if not found.

5.161.3.19

template<class Ch> void rapidxml::xml_node< Ch >::remove_attribute ( xml_attribute< Ch > where )


[inline]

Removes specified attribute from node.


Parameters
where

5.161.3.20

Pointer to attribute to be removed.

template<class Ch> void rapidxml::xml_node< Ch >::remove_first_attribute ( ) [inline]

Removes first attribute of the node.


If node has no attributes, behaviour is undefined. Use first_attribute() to test if node has attributes.

5.161.3.21

template<class Ch> void rapidxml::xml_node< Ch >::remove_first_node ( ) [inline]

Removes first child node.


If node has no children, behaviour is undefined. Use first_node() to test if node has children.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.161 rapidxml::xml_node< Ch > Class Template Reference

5.161.3.22

369

template<class Ch> void rapidxml::xml_node< Ch >::remove_last_attribute ( ) [inline]

Removes last attribute of the node.


If node has no attributes, behaviour is undefined. Use first_attribute() to test if node has attributes.

5.161.3.23

template<class Ch> void rapidxml::xml_node< Ch >::remove_last_node ( ) [inline]

Removes last child of the node.


If node has no children, behaviour is undefined. Use first_node() to test if node has children.

5.161.3.24

template<class Ch> node_type rapidxml::xml_node< Ch >::type ( ) const [inline]

Gets type of node.


Returns
Type of node.

5.161.3.25

template<class Ch> void rapidxml::xml_node< Ch >::type ( node_type type ) [inline]

Sets type of node.


Parameters
type

5.161.3.26

Type of node to set.

template<class Ch = char> Ch rapidxml::xml_base< Ch >::value (


[inherited]

) const [inline],

Gets value of node.


Interpretation of value depends on type of node. Note that value will not be zero-terminated if rapidxml::parse_no_string_terminators option was selected during parse.
Use value_size() function to determine length of the value.
Returns
Value of node, or empty string if node has no value.

5.161.3.27

template<class Ch = char> void rapidxml::xml_base< Ch >::value ( const Ch value, std::size_t size )


[inline], [inherited]

Sets value of node to a non zero-terminated string.


See ownership_of_strings.
Note that node does not own its name or value, it only stores a pointer to it. It will not delete or otherwise free the
pointer on destruction. It is reponsibility of the user to properly manage lifetime of the string. The easiest way to
achieve it is to use memory_pool of the document to allocate the string - on destruction of the document the string
will be automatically freed.
Size of value must be specified separately, because it does not have to be zero terminated. Use value(const Ch )
function to have the length automatically calculated (string must be zero terminated).
If an element has a child node of type node_data, it will take precedence over element value when printing. If
you want to manipulate data of elements using values, use parser flag rapidxml::parse_no_data_nodes to prevent
creation of data nodes by the parser.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

370

Class Documentation

Parameters
value
size

value of node to set. Does not have to be zero terminated.


Size of value, in characters. This does not include zero terminator, if one is present.

template<class Ch = char> void rapidxml::xml_base< Ch >::value ( const Ch value ) [inline],


[inherited]

5.161.3.28

Sets value of node to a zero-terminated string.


See also ownership_of_strings and xml_node::value(const Ch , std::size_t).
Parameters
value

5.161.3.29

Vame of node to set. Must be zero terminated.

template<class Ch = char> std::size_t rapidxml::xml_base< Ch >::value_size ( ) const [inline],


[inherited]

Gets size of node value, not including terminator character.


This function works correctly irrespective of whether value is or is not zero terminated.
Returns
Size of node value, in characters.
The documentation for this class was generated from the following file:
src/node/include/node/rapidxml.hpp

5.162

XMLParser Class Reference

Public Member Functions


bool Return_Boolean (std::string value)
void PrintNode (xml_node<> node, std::string &prepend)
bool Parse (std::string fName)

Public Attributes

std::vector< ComponentConfig > compConfigList


std::vector< std::string > libList
std::string nodeName
int node_priority

The documentation for this class was generated from the following file:
src/node/include/node/xmlParser.hpp

5.163

XMLSubSys Class Reference

Utility methods for initialising, closing and using the XML-subsystem.

#include <XMLSubSys.h>
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.163 XMLSubSys Class Reference

371

Static Public Member Functions


static void init ()
Initialises the xml-subsystem.

static void setValidation (const std::string &validationScheme, const std::string &netValidationScheme)


Enables or disables validation.

static void close ()


Closes the xml-subsystem.

static SUMOSAXReader getSAXReader (SUMOSAXHandler &handler)


Builds a reader and assigns the handler to it.

static void setHandler (GenericSAXHandler &handler)


Sets the given handler for the default reader.

static bool runParser (GenericSAXHandler &handler, const std::string &file, const bool isNet=false)
Runs the given handler on the given file; returns if everythings ok.

5.163.1

Detailed Description

Utility methods for initialising, closing and using the XML-subsystem.


The Xerces-parsers need an initialisation and should also be closed.
As we use xerces for both the input files and the configuration we would have to check whether the system was
initialised before. Instead, we call XMLSubSys::init(bool) once at the beginning of our application and XMLSubSys::close() at the end.
Closing and initialising the XML subsystem is necessary. Still, we never encountered any problems with it. Once,
after some modifications, SUMO crashed when closing the XML sub system. The reason was a memory leak within
the microsim-module. On initialisation, a SAX2XMLReader is built which can be used during later process. It is
destroyed when the subsystem is closed.
In addition to initialisation and shutdown, this module allows to build SAXReaders and/or running a given handler
on a given file without dealing with the reader at all.
Todo make schema checking optional

5.163.2

Member Function Documentation

5.163.2.1

static void XMLSubSys::close ( ) [static]

Closes the xml-subsystem.


Deletes the built reader and calls XMLPlatformUtils::Terminate();

5.163.2.2

static SUMOSAXReader XMLSubSys::getSAXReader ( SUMOSAXHandler & handler ) [static]

Builds a reader and assigns the handler to it.


Tries to build a SAX2XMLReader using "getSAXReader()". If this fails, 0 is returned. Otherwise, the given handler
is assigned to the reader as the current DefaultHandler and ErrorHandler.
Parameters

in

handler

The handler to assign to the built reader

Returns
The built Xerces-SAX-reader, 0 if something failed

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

372

Class Documentation

See Also
getSAXReader()

5.163.2.3

static void XMLSubSys::init ( ) [static]

Initialises the xml-subsystem.


Calls XMLPlatformUtils::Initialize(). If this fails, the exception is caught and its content is reported using a ProcessError.
Exceptions
ProcessError

5.163.2.4

If the initialisation fails

static bool XMLSubSys::runParser ( GenericSAXHandler & handler, const std::string & file, const bool isNet =

false ) [static]
Runs the given handler on the given file; returns if everythings ok.
Uses the reader built on init() which is stored in myReader to parse the given file.
All exceptions are catched and reported to the error-instance of the MsgHandler. Also, if the reader could not be
built, this is reported.
The method returns true if everything went ok. This means, that the reader could be built, no exception was caught,
and nothing was reported to the error-instance of the MsgHandler.
Parameters
handler
file
isNet

in
in
in

The handler to assign to the built reader


The file to run the parser at
whether a network gets loaded

Returns
true if the parsing was done without errors, false otherwise (error was printed)

5.163.2.5

static void XMLSubSys::setHandler ( GenericSAXHandler & handler ) [static]

Sets the given handler for the default reader.


Uses the reader built on init() which is stored in myReader.
Parameters

in

5.163.2.6

handler

The handler to assign to the built reader

static void XMLSubSys::setValidation ( const std::string & validationScheme, const std::string & netValidationScheme
) [static]

Enables or disables validation.


The setting is only valid for parsers created after the call. Existing parsers are not adapted.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

5.163 XMLSubSys Class Reference


Parameters

in
in

validationScheme
netValidationScheme

Whether validation of XML-documents against schemata shall be enabled


Whether validation of SUMO networks against schemata shall be enabled

The documentation for this class was generated from the following file:
src/sumo/include/utils/xml/XMLSubSys.h

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

373

374

Class Documentation

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

Chapter 6

File Documentation
6.1

src/node/include/node/Component.hpp File Reference

This file declares the Component class.

#include
#include
#include
#include
#include

<iostream>
<string>
<std_msgs/Bool.h>
"node/xmlParser.hpp"
"node/Logger.hpp"

Classes
class Component
Component class.

6.1.1

Detailed Description

This file declares the Component class.


Author
William Emfinger
Pranav Srinivas Kumar

Date

<%- Date().toISOString().replace(/T/, ).replace(/..+/, ) %>

6.2

src/node/include/node/rapidxml.hpp File Reference

This file contains rapidxml parser and DOM implementation.

#include
#include
#include
#include

<cstdlib>
<cassert>
<new>
<exception>

376

File Documentation

Classes
class rapidxml::parse_error
Parse error exception.

class rapidxml::xml_node< Ch >


Class representing a node of XML document.

class rapidxml::xml_attribute< Ch >


Class representing attribute node of XML document.

class rapidxml::xml_document< Ch >


This class represents root of the DOM hierarchy.

class rapidxml::memory_pool< Ch >


This class is used by the parser to create new nodes and attributes, without overheads of dynamic memory allocation.

class rapidxml::xml_base< Ch >


Base class for xml_node and xml_attribute implementing common functions: name(), name_size(), value(), value_size() and parent().

class rapidxml::xml_attribute< Ch >


Class representing attribute node of XML document.

class rapidxml::xml_node< Ch >


Class representing a node of XML document.

class rapidxml::xml_document< Ch >


This class represents root of the DOM hierarchy.

Macros

#define RAPIDXML_PARSE_ERROR(what, where) throw parse_error(what, where)


#define RAPIDXML_STATIC_POOL_SIZE (64 1024)
#define RAPIDXML_DYNAMIC_POOL_SIZE (64 1024)
#define RAPIDXML_ALIGNMENT sizeof(void )

Enumerations
enum node_type {
rapidxml::node_document, rapidxml::node_element, rapidxml::node_data, rapidxml::node_cdata,
rapidxml::node_comment, rapidxml::node_declaration, rapidxml::node_doctype, rapidxml::node_pi }
Enumeration listing all node types produced by the parser.

Variables
const int rapidxml::parse_no_data_nodes = 0x1
Parse flag instructing the parser to not create data nodes.

const int rapidxml::parse_no_element_values = 0x2


Parse flag instructing the parser to not use text of first data node as a value of parent element.

const int rapidxml::parse_no_string_terminators = 0x4


Parse flag instructing the parser to not place zero terminators after strings in the source text.

const int rapidxml::parse_no_entity_translation = 0x8


Parse flag instructing the parser to not translate entities in the source text.

const int rapidxml::parse_no_utf8 = 0x10


Parse flag instructing the parser to disable UTF-8 handling and assume plain 8 bit characters.

const int rapidxml::parse_declaration_node = 0x20


Parse flag instructing the parser to create XML declaration node.

const int rapidxml::parse_comment_nodes = 0x40


Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

6.3 src/node/include/node/rapidxml_utils.hpp File Reference

377

Parse flag instructing the parser to create comments nodes.

const int rapidxml::parse_doctype_node = 0x80


Parse flag instructing the parser to create DOCTYPE node.

const int rapidxml::parse_pi_nodes = 0x100


Parse flag instructing the parser to create PI nodes.

const int rapidxml::parse_validate_closing_tags = 0x200


Parse flag instructing the parser to validate closing tag names.

const int rapidxml::parse_trim_whitespace = 0x400


Parse flag instructing the parser to trim all leading and trailing whitespace of data nodes.

const int rapidxml::parse_normalize_whitespace = 0x800


Parse flag instructing the parser to condense all whitespace runs of data nodes to a single space character.

const int rapidxml::parse_default = 0


Parse flags which represent default behaviour of the parser.

const int rapidxml::parse_non_destructive = parse_no_string_terminators | parse_no_entity_translation


A combination of parse flags that forbids any modifications of the source text.

const int rapidxml::parse_fastest = parse_non_destructive | parse_no_data_nodes


A combination of parse flags resulting in fastest possible parsing, without sacrificing important data.

const int rapidxml::parse_full = parse_declaration_node | parse_comment_nodes | parse_doctype_node |


parse_pi_nodes | parse_validate_closing_tags
A combination of parse flags resulting in largest amount of data being extracted.

6.2.1

Detailed Description

This file contains rapidxml parser and DOM implementation.

6.3

src/node/include/node/rapidxml_utils.hpp File Reference

This file contains high-level rapidxml utilities that can be useful in certain simple scenarios.

#include
#include
#include
#include
#include

"rapidxml.hpp"
<vector>
<string>
<fstream>
<stdexcept>

Classes
class rapidxml::file< Ch >
Represents data loaded from a file.

Functions
template<class Ch >
std::size_t rapidxml::count_children (xml_node< Ch > node)
Counts children of node.

template<class Ch >
std::size_t rapidxml::count_attributes (xml_node< Ch > node)
Counts attributes of node.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

378

File Documentation

6.3.1

Detailed Description

This file contains high-level rapidxml utilities that can be useful in certain simple scenarios. They should probably
not be used if maximizing performance is the main objective.

6.4

src/node/src/node/Component.cpp File Reference

This file contains definitions for the base Component class.

#include "node/Component.hpp"

6.4.1

Detailed Description

This file contains definitions for the base Component class.


Author
William Emfinger
Pranav Srinivas Kumar

Date

<%- Date().toISOString().replace(/T/, ).replace(/..+/, ) %>

6.5

src/node/src/node/node_main.cpp File Reference

This file contains the main function for a ROSMOD actor/node.

#include
#include
#include
#include
#include
#include
#include
#include
#include

<cstdlib>
<string.h>
<dlfcn.h>
<exception>
<signal.h>
<boost/thread.hpp>
"node/Component.hpp"
"pthread.h"
"sched.h"

Functions
void componentThreadFunc (Component compPtr)
int main (int argc, char argv)
Parses node configuration and spawns component executor threads.

Variables
std::vector< boost::thread > compThreads
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

6.6 src/pnp2/include/pnp2/NetworkProfile.hpp File Reference

6.5.1

Detailed Description

This file contains the main function for a ROSMOD actor/node.


Author
William Emfinger

Date

<%- Date().toISOString().replace(/T/, ).replace(/..+/, ) %>

6.6

src/pnp2/include/pnp2/NetworkProfile.hpp File Reference

This file declares the Network::ResourceEntry and Network::NetworkProfile classes.

#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include

"CSVIterator.hpp"
"Message.hpp"
<stdio.h>
<string.h>
<math.h>
<iomanip>
<algorithm>
<streambuf>
<list>
<vector>
<memory>
<boost/algorithm/string.hpp>
<time.h>

Classes
class Network::Exceeded_Production_Profile
Exception class thrown when application exceeds allowed data production.

struct Network::profileMemBuf
class Network::ResourceEntry
Holds the information about an interval of time starting at time, with constant bandwidth and max_bandwidth.

class Network::NetworkProfile
Defines how the bandwidth and latency of a given network link vary as functions of time over a specified period.

6.6.1

Detailed Description

This file declares the Network::ResourceEntry and Network::NetworkProfile classes.

6.7

src/pnp2/include/pnp2/receiver.hpp File Reference

This file declares the Network::receiver class.


Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

379

380

File Documentation

#include
#include
#include
#include
#include
#include
#include

"ros/ros.h"
<boost/thread/thread.hpp>
<boost/asio.hpp>
<boost/bind.hpp>
"pnp2/NetworkProfile.hpp"
"pnp2/buffer.hpp"
"pnp2/oob.hpp"

Classes
class Network::receiver
Allows for the reception of data through a (possibly fixed-size) buffer at a configurable rate that can vary as a function
of time.

6.7.1

Detailed Description

This file declares the Network::receiver class.

6.8

src/pnp2/include/pnp2/sender.hpp File Reference

This file declares the Network::sender class.

#include
#include
#include
#include
#include
#include
#include
#include
#include

"ros/ros.h"
<boost/thread/thread.hpp>
<boost/asio.hpp>
<boost/bind.hpp>
<sys/socket.h>
<arpa/inet.h>
<netinet/in.h>
"pnp2/NetworkProfile.hpp"
"pnp2/oob.hpp"

Classes
class Network::Exceeded_Production_profile
Exception class thrown when application exceeds allowed data production.

class Network::sender
Allows for the sending of data (possibly through a buffer) at a configurable rate and with configurable push-back to
inform if the rate has been exceeded.

6.8.1

Detailed Description

This file declares the Network::sender class.

6.9

src/sumo/include/traci-server/TraCIConstants.h File Reference

Macros
#define TRACI_VERSION 9
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

6.9 src/sumo/include/traci-server/TraCIConstants.h File Reference

#define CMD_GETVERSION 0x00


#define CMD_SIMSTEP2 0x02
#define CMD_STOP 0x12
#define CMD_RESUME 0x19
#define CMD_CHANGELANE 0x13
#define CMD_SLOWDOWN 0x14
#define CMD_CHANGETARGET 0x31
#define CMD_CLOSE 0x7F
#define CMD_SUBSCRIBE_INDUCTIONLOOP_CONTEXT 0x80
#define RESPONSE_SUBSCRIBE_INDUCTIONLOOP_CONTEXT 0x90
#define CMD_GET_INDUCTIONLOOP_VARIABLE 0xa0
#define RESPONSE_GET_INDUCTIONLOOP_VARIABLE 0xb0
#define CMD_SUBSCRIBE_INDUCTIONLOOP_VARIABLE 0xd0
#define RESPONSE_SUBSCRIBE_INDUCTIONLOOP_VARIABLE 0xe0
#define CMD_SUBSCRIBE_MULTI_ENTRY_EXIT_DETECTOR_CONTEXT 0x81
#define RESPONSE_SUBSCRIBE_MULTI_ENTRY_EXIT_DETECTOR_CONTEXT 0x91
#define CMD_GET_MULTI_ENTRY_EXIT_DETECTOR_VARIABLE 0xa1
#define RESPONSE_GET_MULTI_ENTRY_EXIT_DETECTOR_VARIABLE 0xb1
#define CMD_SUBSCRIBE_MULTI_ENTRY_EXIT_DETECTOR_VARIABLE 0xd1
#define RESPONSE_SUBSCRIBE_MULTI_ENTRY_EXIT_DETECTOR_VARIABLE 0xe1
#define CMD_SUBSCRIBE_TL_CONTEXT 0x82
#define RESPONSE_SUBSCRIBE_TL_CONTEXT 0x92
#define CMD_GET_TL_VARIABLE 0xa2
#define RESPONSE_GET_TL_VARIABLE 0xb2
#define CMD_SET_TL_VARIABLE 0xc2
#define CMD_SUBSCRIBE_TL_VARIABLE 0xd2
#define RESPONSE_SUBSCRIBE_TL_VARIABLE 0xe2
#define CMD_SUBSCRIBE_LANE_CONTEXT 0x83
#define RESPONSE_SUBSCRIBE_LANE_CONTEXT 0x93
#define CMD_GET_LANE_VARIABLE 0xa3
#define RESPONSE_GET_LANE_VARIABLE 0xb3
#define CMD_SET_LANE_VARIABLE 0xc3
#define CMD_SUBSCRIBE_LANE_VARIABLE 0xd3
#define RESPONSE_SUBSCRIBE_LANE_VARIABLE 0xe3
#define CMD_SUBSCRIBE_VEHICLE_CONTEXT 0x84
#define RESPONSE_SUBSCRIBE_VEHICLE_CONTEXT 0x94
#define CMD_GET_VEHICLE_VARIABLE 0xa4
#define RESPONSE_GET_VEHICLE_VARIABLE 0xb4
#define CMD_SET_VEHICLE_VARIABLE 0xc4
#define CMD_SUBSCRIBE_VEHICLE_VARIABLE 0xd4
#define RESPONSE_SUBSCRIBE_VEHICLE_VARIABLE 0xe4
#define CMD_SUBSCRIBE_VEHICLETYPE_CONTEXT 0x85
#define RESPONSE_SUBSCRIBE_VEHICLETYPE_CONTEXT 0x95
#define CMD_GET_VEHICLETYPE_VARIABLE 0xa5
#define RESPONSE_GET_VEHICLETYPE_VARIABLE 0xb5
#define CMD_SET_VEHICLETYPE_VARIABLE 0xc5
#define CMD_SUBSCRIBE_VEHICLETYPE_VARIABLE 0xd5
#define RESPONSE_SUBSCRIBE_VEHICLETYPE_VARIABLE 0xe5
#define CMD_SUBSCRIBE_ROUTE_CONTEXT 0x86
#define RESPONSE_SUBSCRIBE_ROUTE_CONTEXT 0x96
#define CMD_GET_ROUTE_VARIABLE 0xa6
#define RESPONSE_GET_ROUTE_VARIABLE 0xb6
#define CMD_SET_ROUTE_VARIABLE 0xc6
#define CMD_SUBSCRIBE_ROUTE_VARIABLE 0xd6
#define RESPONSE_SUBSCRIBE_ROUTE_VARIABLE 0xe6

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

381

382

File Documentation

#define CMD_SUBSCRIBE_POI_CONTEXT 0x87


#define RESPONSE_SUBSCRIBE_POI_CONTEXT 0x97
#define CMD_GET_POI_VARIABLE 0xa7
#define RESPONSE_GET_POI_VARIABLE 0xb7
#define CMD_SET_POI_VARIABLE 0xc7
#define CMD_SUBSCRIBE_POI_VARIABLE 0xd7
#define RESPONSE_SUBSCRIBE_POI_VARIABLE 0xe7
#define CMD_SUBSCRIBE_POLYGON_CONTEXT 0x88
#define RESPONSE_SUBSCRIBE_POLYGON_CONTEXT 0x98
#define CMD_GET_POLYGON_VARIABLE 0xa8
#define RESPONSE_GET_POLYGON_VARIABLE 0xb8
#define CMD_SET_POLYGON_VARIABLE 0xc8
#define CMD_SUBSCRIBE_POLYGON_VARIABLE 0xd8
#define RESPONSE_SUBSCRIBE_POLYGON_VARIABLE 0xe8
#define CMD_SUBSCRIBE_JUNCTION_CONTEXT 0x89
#define RESPONSE_SUBSCRIBE_JUNCTION_CONTEXT 0x99
#define CMD_GET_JUNCTION_VARIABLE 0xa9
#define RESPONSE_GET_JUNCTION_VARIABLE 0xb9
#define CMD_SET_JUNCTION_VARIABLE 0xc9
#define CMD_SUBSCRIBE_JUNCTION_VARIABLE 0xd9
#define RESPONSE_SUBSCRIBE_JUNCTION_VARIABLE 0xe9
#define CMD_SUBSCRIBE_EDGE_CONTEXT 0x8a
#define RESPONSE_SUBSCRIBE_EDGE_CONTEXT 0x9a
#define CMD_GET_EDGE_VARIABLE 0xaa
#define RESPONSE_GET_EDGE_VARIABLE 0xba
#define CMD_SET_EDGE_VARIABLE 0xca
#define CMD_SUBSCRIBE_EDGE_VARIABLE 0xda
#define RESPONSE_SUBSCRIBE_EDGE_VARIABLE 0xea
#define CMD_SUBSCRIBE_SIM_CONTEXT 0x8b
#define RESPONSE_SUBSCRIBE_SIM_CONTEXT 0x9b
#define CMD_GET_SIM_VARIABLE 0xab
#define RESPONSE_GET_SIM_VARIABLE 0xbb
#define CMD_SET_SIM_VARIABLE 0xcb
#define CMD_SUBSCRIBE_SIM_VARIABLE 0xdb
#define RESPONSE_SUBSCRIBE_SIM_VARIABLE 0xeb
#define CMD_SUBSCRIBE_GUI_CONTEXT 0x8c
#define RESPONSE_SUBSCRIBE_GUI_CONTEXT 0x9c
#define CMD_GET_GUI_VARIABLE 0xac
#define RESPONSE_GET_GUI_VARIABLE 0xbc
#define CMD_SET_GUI_VARIABLE 0xcc
#define CMD_SUBSCRIBE_GUI_VARIABLE 0xdc
#define RESPONSE_SUBSCRIBE_GUI_VARIABLE 0xec
#define CMD_SUBSCRIBE_AREAL_DETECTOR_CONTEXT 0x8d
#define RESPONSE_SUBSCRIBE_AREAL_DETECTOR_CONTEXT 0x9d
#define CMD_GET_AREAL_DETECTOR_VARIABLE 0xad
#define RESPONSE_GET_AREAL_DETECTOR_VARIABLE 0xbd
#define CMD_SUBSCRIBE_AREAL_DETECTOR_VARIABLE 0xdd
#define RESPONSE_SUBSCRIBE_AREAL_DETECTOR_VARIABLE 0xed
#define CMD_SUBSCRIBE_PERSON_CONTEXT 0x8e
#define RESPONSE_SUBSCRIBE_PERSON_CONTEXT 0x9e
#define CMD_GET_PERSON_VARIABLE 0xae
#define RESPONSE_GET_PERSON_VARIABLE 0xbe
#define CMD_SET_PERSON_VARIABLE 0xce
#define CMD_SUBSCRIBE_PERSON_VARIABLE 0xde
#define RESPONSE_SUBSCRIBE_PERSON_VARIABLE 0xee
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

6.9 src/sumo/include/traci-server/TraCIConstants.h File Reference

#define POSITION_LON_LAT 0x00


#define POSITION_2D 0x01
#define POSITION_LON_LAT_ALT 0x02
#define POSITION_3D 0x03
#define POSITION_ROADMAP 0x04
#define TYPE_BOUNDINGBOX 0x05
#define TYPE_POLYGON 0x06
#define TYPE_UBYTE 0x07
#define TYPE_BYTE 0x08
#define TYPE_INTEGER 0x09
#define TYPE_FLOAT 0x0A
#define TYPE_DOUBLE 0x0B
#define TYPE_STRING 0x0C
#define TYPE_TLPHASELIST 0x0D
#define TYPE_STRINGLIST 0x0E
#define TYPE_COMPOUND 0x0F
#define TYPE_COLOR 0x11
#define RTYPE_OK 0x00
#define RTYPE_NOTIMPLEMENTED 0x01
#define RTYPE_ERR 0xFF
#define INVALID_DOUBLE_VALUE -1001.
#define INVALID_INT_VALUE -1
#define TLPHASE_RED 0x01
#define TLPHASE_YELLOW 0x02
#define TLPHASE_GREEN 0x03
#define TLPHASE_BLINKING 0x04
#define TLPHASE_NOSIGNAL 0x05
#define REQUEST_AIRDIST 0x00
#define REQUEST_DRIVINGDIST 0x01
#define REMOVE_TELEPORT 0x00
#define REMOVE_PARKING 0x01
#define REMOVE_ARRIVED 0x02
#define REMOVE_VAPORIZED 0x03
#define REMOVE_TELEPORT_ARRIVED 0x04
#define ID_LIST 0x00
#define ID_COUNT 0x01
#define OBJECT_VARIABLES_SUBSCRIPTION 0x02
#define SURROUNDING_VARIABLES_SUBSCRIPTION 0x03
#define LAST_STEP_VEHICLE_NUMBER 0x10
#define LAST_STEP_MEAN_SPEED 0x11
#define LAST_STEP_VEHICLE_ID_LIST 0x12
#define LAST_STEP_OCCUPANCY 0x13
#define LAST_STEP_VEHICLE_HALTING_NUMBER 0x14
#define LAST_STEP_LENGTH 0x15
#define LAST_STEP_TIME_SINCE_DETECTION 0x16
#define LAST_STEP_VEHICLE_DATA 0x17
#define JAM_LENGTH_VEHICLE 0x18
#define JAM_LENGTH_METERS 0x19
#define TL_RED_YELLOW_GREEN_STATE 0x20
#define TL_PHASE_INDEX 0x22
#define TL_PROGRAM 0x23
#define TL_PHASE_DURATION 0x24
#define TL_CONTROLLED_LANES 0x26
#define TL_CONTROLLED_LINKS 0x27
#define TL_CURRENT_PHASE 0x28

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

383

384

File Documentation

#define TL_CURRENT_PROGRAM 0x29


#define TL_CONTROLLED_JUNCTIONS 0x2a
#define TL_COMPLETE_DEFINITION_RYG 0x2b
#define TL_COMPLETE_PROGRAM_RYG 0x2c
#define TL_NEXT_SWITCH 0x2d
#define TL_EXTERNAL_STATE 0x2e
#define LANE_LINK_NUMBER 0x30
#define LANE_EDGE_ID 0x31
#define LANE_LINKS 0x33
#define LANE_ALLOWED 0x34
#define LANE_DISALLOWED 0x35
#define VAR_SPEED 0x40
#define VAR_MAXSPEED 0x41
#define VAR_POSITION 0x42
#define VAR_POSITION3D 0x39
#define VAR_ANGLE 0x43
#define VAR_LENGTH 0x44
#define VAR_COLOR 0x45
#define VAR_ACCEL 0x46
#define VAR_DECEL 0x47
#define VAR_TAU 0x48
#define VAR_VEHICLECLASS 0x49
#define VAR_EMISSIONCLASS 0x4a
#define VAR_SHAPECLASS 0x4b
#define VAR_MINGAP 0x4c
#define VAR_WIDTH 0x4d
#define VAR_SHAPE 0x4e
#define VAR_TYPE 0x4f
#define VAR_ROAD_ID 0x50
#define VAR_LANE_ID 0x51
#define VAR_LANE_INDEX 0x52
#define VAR_ROUTE_ID 0x53
#define VAR_EDGES 0x54
#define VAR_FILL 0x55
#define VAR_LANEPOSITION 0x56
#define VAR_ROUTE 0x57
#define VAR_EDGE_TRAVELTIME 0x58
#define VAR_EDGE_EFFORT 0x59
#define VAR_CURRENT_TRAVELTIME 0x5a
#define VAR_SIGNALS 0x5b
#define VAR_MOVE_TO 0x5c
#define VAR_IMPERFECTION 0x5d
#define VAR_SPEED_FACTOR 0x5e
#define VAR_SPEED_DEVIATION 0x5f
#define VAR_SPEED_WITHOUT_TRACI 0xb1
#define VAR_BEST_LANES 0xb2
#define VAR_SPEEDSETMODE 0xb3
#define VAR_MOVE_TO_VTD 0xb4
#define VAR_STOPSTATE 0xb5
#define VAR_LANECHANGE_MODE 0xb6
#define VAR_ALLOWED_SPEED 0xb7
#define VAR_CO2EMISSION 0x60
#define VAR_COEMISSION 0x61
#define VAR_HCEMISSION 0x62
#define VAR_PMXEMISSION 0x63
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

6.9 src/sumo/include/traci-server/TraCIConstants.h File Reference

#define VAR_NOXEMISSION 0x64


#define VAR_FUELCONSUMPTION 0x65
#define VAR_NOISEEMISSION 0x66
#define VAR_PERSON_NUMBER 0x67
#define VAR_BUS_STOP_WAITING 0x67
#define VAR_LEADER 0x68
#define VAR_WAITING_TIME 0x7a
#define VAR_TIME_STEP 0x70
#define VAR_LOADED_VEHICLES_NUMBER 0x71
#define VAR_LOADED_VEHICLES_IDS 0x72
#define VAR_DEPARTED_VEHICLES_NUMBER 0x73
#define VAR_DEPARTED_VEHICLES_IDS 0x74
#define VAR_TELEPORT_STARTING_VEHICLES_NUMBER 0x75
#define VAR_TELEPORT_STARTING_VEHICLES_IDS 0x76
#define VAR_TELEPORT_ENDING_VEHICLES_NUMBER 0x77
#define VAR_TELEPORT_ENDING_VEHICLES_IDS 0x78
#define VAR_ARRIVED_VEHICLES_NUMBER 0x79
#define VAR_ARRIVED_VEHICLES_IDS 0x7a
#define VAR_DELTA_T 0x7b
#define VAR_NET_BOUNDING_BOX 0x7c
#define VAR_MIN_EXPECTED_VEHICLES 0x7d
#define VAR_STOP_STARTING_VEHICLES_NUMBER 0x68
#define VAR_STOP_STARTING_VEHICLES_IDS 0x69
#define VAR_STOP_ENDING_VEHICLES_NUMBER 0x6a
#define VAR_STOP_ENDING_VEHICLES_IDS 0x6b
#define VAR_PARKING_STARTING_VEHICLES_NUMBER 0x6c
#define VAR_PARKING_STARTING_VEHICLES_IDS 0x6d
#define VAR_PARKING_ENDING_VEHICLES_NUMBER 0x6e
#define VAR_PARKING_ENDING_VEHICLES_IDS 0x6f
#define CMD_CLEAR_PENDING_VEHICLES 0x94
#define VAR_PARAMETER 0x7e
#define ADD 0x80
#define REMOVE 0x81
#define POSITION_CONVERSION 0x82
#define DISTANCE_REQUEST 0x83
#define VAR_DISTANCE 0x84
#define ADD_FULL 0x85
#define CMD_REROUTE_TRAVELTIME 0x90
#define CMD_REROUTE_EFFORT 0x91
#define VAR_ROUTE_VALID 0x92
#define VAR_VIEW_ZOOM 0xa0
#define VAR_VIEW_OFFSET 0xa1
#define VAR_VIEW_SCHEMA 0xa2
#define VAR_VIEW_BOUNDARY 0xa3
#define VAR_SCREENSHOT 0xa5
#define VAR_TRACK_VEHICLE 0xa6
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

385

386

File Documentation

6.9.1

Detailed Description

Author
Axel Wegener
Friedemann Wesner
Bjoern Hendriks
Daniel Krajzewicz
Thimor Bohn
Tino Morenz
Michael Behrisch
Christoph Sommer
Mario Krumnow
Jakob Erdmann
Laura Bieker

Date
2007/10/24

Version

Id:
TraCIConstants.h 18095 2015-03-17 09:39:00Z behrisch
holds codes used for TraCI

6.10

src/sumo/include/traci-server/TraCIException.h File Reference

#include <config.h>
#include <string>
#include <stdexcept>

Classes
class TraCIException

6.10.1

Detailed Description

Author
Axel Wegener
Friedemann Wesner
Christoph Sommer
Daniel Krajzewicz
Michael Behrisch

Date
2007/10/24

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

6.11 src/sumo/include/traci-server/TraCIServer.h File Reference


Version

Id:
TraCIException.h 18095 2015-03-17 09:39:00Z behrisch
Exception thrown by TraCI

6.11

src/sumo/include/traci-server/TraCIServer.h File Reference

#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include

<config.h>
"TraCIConstants.h"
<foreign/tcpip/socket.h>
<foreign/tcpip/storage.h>
<utils/common/SUMOTime.h>
<utils/common/ToString.h>
<utils/geom/Boundary.h>
<utils/geom/Position.h>
<utils/geom/GeomHelper.h>
<utils/shapes/Polygon.h>
<utils/shapes/PointOfInterest.h>
<utils/options/OptionsCont.h>
<microsim/MSVehicle.h>
<microsim/MSNet.h>
<microsim/traffic_lights/MSTrafficLightLogic.h>
"TraCIException.h"
<utils/common/NamedRTree.h>
<map>
<string>
<set>

Classes
class TraCIServer
TraCI server used to control sumo by a remote TraCI client.

6.11.1

Detailed Description

Author
Axel Wegener
Friedemann Wesner
Christoph Sommer
Tino Morenz
Daniel Krajzewicz
Thimor Bohn
Sascha Krieg
Michael Behrisch

Date
2007/10/24

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

387

388

File Documentation

Version

Id:
TraCIServer.h 18096 2015-03-17 09:50:59Z behrisch
TraCI server used to control sumo by a remote TraCI client

6.12

src/sumo/include/traci-server/TraCIServerAPI_Edge.h File Reference

#include
#include
#include
#include

<config.h>
"TraCIException.h"
"TraCIServer.h"
<foreign/tcpip/storage.h>

Classes
class TraCIServerAPI_Edge
APIs for getting/setting edge values via TraCI.

6.12.1

Detailed Description

Author
Daniel Krajzewicz
Michael Behrisch

Date
07.05.2009

Version

Id:
TraCIServerAPI_Edge.h 18095 2015-03-17 09:39:00Z behrisch

6.13

src/sumo/include/traci-server/TraCIServerAPI_InductionLoop.h File Reference

#include
#include
#include
#include

<config.h>
"TraCIException.h"
"TraCIServer.h"
<foreign/tcpip/storage.h>

Classes
class TraCIServerAPI_InductionLoop
APIs for getting/setting induction loop values via TraCI.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

6.14 src/sumo/include/traci-server/TraCIServerAPI_Junction.h File Reference

6.13.1

Detailed Description

Author
Daniel Krajzewicz
Michael Behrisch
Date
07.05.2009
Version

Id:
TraCIServerAPI_InductionLoop.h 18095 2015-03-17 09:39:00Z behrisch

6.14

src/sumo/include/traci-server/TraCIServerAPI_Junction.h File Reference

#include
#include
#include
#include

<config.h>
"TraCIException.h"
"TraCIServer.h"
<foreign/tcpip/storage.h>

Classes
class TraCIServerAPI_Junction
APIs for getting/setting junction values via TraCI.

6.14.1

Detailed Description

Author
Daniel Krajzewicz
Michael Behrisch
Date
07.05.2009
Version

Id:
TraCIServerAPI_Junction.h 18095 2015-03-17 09:39:00Z behrisch

6.15

src/sumo/include/traci-server/TraCIServerAPI_Lane.h File Reference

#include <config.h>
#include <foreign/tcpip/storage.h>

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

389

390

File Documentation

Classes
class TraCIServerAPI_Lane
APIs for getting/setting lane values via TraCI.

class TraCIServerAPI_Lane::StoringVisitor
Allows to store the object; used as context while traveling the rtree in TraCI.

Macros
#define LANE_RTREE_QUAL RTree<MSLane, MSLane, float, 2, TraCIServerAPI_Lane::StoringVisitor>

6.15.1

Detailed Description

Author
Daniel Krajzewicz
Michael Behrisch
Jakob Erdmann
Date
07.05.2009
Version

Id:
TraCIServerAPI_Lane.h 18095 2015-03-17 09:39:00Z behrisch

6.16

src/sumo/include/traci-server/TraCIServerAPI_MeMeDetector.h File Reference

#include
#include
#include
#include

<config.h>
"TraCIException.h"
"TraCIServer.h"
<foreign/tcpip/storage.h>

Classes
class TraCIServerAPI_MeMeDetector
APIs for getting/setting multi-entry/multi-exit detector values via TraCI.

6.16.1

Detailed Description

Author
Daniel Krajzewicz
Michael Behrisch
Date
07.05.2009

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

6.17 src/sumo/include/traci-server/TraCIServerAPI_Person.h File Reference


Version

Id:
TraCIServerAPI_MeMeDetector.h 18095 2015-03-17 09:39:00Z behrisch

6.17

src/sumo/include/traci-server/TraCIServerAPI_Person.h File Reference

#include <config.h>
#include <foreign/tcpip/storage.h>

Classes
class TraCIServerAPI_Person
APIs for getting/setting person values via TraCI.

6.17.1

Detailed Description

Author
Daniel Krajzewicz

Date
26.05.2014

Version

Id:
TraCIServerAPI_Person.h 18095 2015-03-17 09:39:00Z behrisch

6.18

src/sumo/include/traci-server/TraCIServerAPI_POI.h File Reference

#include
#include
#include
#include

<config.h>
"TraCIException.h"
"TraCIServer.h"
<foreign/tcpip/storage.h>

Classes
class TraCIServerAPI_POI
APIs for getting/setting POI values via TraCI.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

391

392

File Documentation

6.18.1

Detailed Description

Author
Daniel Krajzewicz
Michael Behrisch
Date
07.05.2009
Version

Id:
TraCIServerAPI_POI.h 18095 2015-03-17 09:39:00Z behrisch

6.19

src/sumo/include/traci-server/TraCIServerAPI_Polygon.h File Reference

#include
#include
#include
#include

<config.h>
"TraCIException.h"
"TraCIServer.h"
<foreign/tcpip/storage.h>

Classes
class TraCIServerAPI_Polygon
APIs for getting/setting polygon values via TraCI.

6.19.1

Detailed Description

Author
Daniel Krajzewicz
Michael Behrisch
Date
07.05.2009
Version

Id:
TraCIServerAPI_Polygon.h 18095 2015-03-17 09:39:00Z behrisch

6.20

src/sumo/include/traci-server/TraCIServerAPI_Route.h File Reference

#include
#include
#include
#include

<config.h>
"TraCIException.h"
"TraCIServer.h"
<foreign/tcpip/storage.h>

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

6.21 src/sumo/include/traci-server/TraCIServerAPI_Simulation.h File Reference

Classes
class TraCIServerAPI_Route
APIs for getting/setting route values via TraCI.

6.20.1

Detailed Description

Author
Daniel Krajzewicz
Michael Behrisch
Date
07.05.2009
Version

Id:
TraCIServerAPI_Route.h 18095 2015-03-17 09:39:00Z behrisch

6.21

src/sumo/include/traci-server/TraCIServerAPI_Simulation.h File Reference

#include
#include
#include
#include
#include
#include
#include

<config.h>
<string>
<map>
<vector>
"TraCIException.h"
"TraCIServer.h"
<foreign/tcpip/storage.h>

Classes
class TraCIServerAPI_Simulation
APIs for getting/setting simulation values via TraCI.

6.21.1

Detailed Description

Author
Daniel Krajzewicz
Michael Behrisch
Date
07.05.2009
Version

Id:
TraCIServerAPI_Simulation.h 18095 2015-03-17 09:39:00Z behrisch
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

393

394

File Documentation

6.22

src/sumo/include/traci-server/TraCIServerAPI_TLS.h File Reference

#include
#include
#include
#include

<config.h>
"TraCIException.h"
"TraCIServer.h"
<foreign/tcpip/storage.h>

Classes
class TraCIServerAPI_TLS
APIs for getting/setting traffic light values via TraCI.

6.22.1

Detailed Description

Author
Daniel Krajzewicz
Michael Behrisch

Date
07.05.2009

Version

Id:
TraCIServerAPI_TLS.h 18095 2015-03-17 09:39:00Z behrisch

6.23

src/sumo/include/traci-server/TraCIServerAPI_Vehicle.h File Reference

#include
#include
#include
#include
#include

<config.h>
"TraCIException.h"
<microsim/MSEdgeWeightsStorage.h>
"TraCIServer.h"
<foreign/tcpip/storage.h>

Classes
class TraCIServerAPI_Vehicle
APIs for getting/setting vehicle values via TraCI.

6.23.1

Detailed Description

Author
Daniel Krajzewicz
Michael Behrisch

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

6.24 src/sumo/include/traci-server/TraCIServerAPI_VehicleType.h File Reference


Date
07.05.2009
Version

Id:
TraCIServerAPI_Vehicle.h 18096 2015-03-17 09:50:59Z behrisch

6.24

src/sumo/include/traci-server/TraCIServerAPI_VehicleType.h File Reference

#include
#include
#include
#include

<config.h>
"TraCIException.h"
"TraCIServer.h"
<foreign/tcpip/storage.h>

Classes
class TraCIServerAPI_VehicleType
APIs for getting/setting vehicle type values via TraCI.

6.24.1

Detailed Description

Author
Daniel Krajzewicz
Michael Behrisch
Date
07.05.2009
Version

Id:
TraCIServerAPI_VehicleType.h 18095 2015-03-17 09:39:00Z behrisch

6.25

src/sumo/include/utils/common/AbstractMutex.h File Reference

#include <config.h>

Classes
class AbstractMutex
An abstract class for encapsulating mutex implementations.

class AbstractMutex::ScopedLocker
A mutex encapsulator which locks/unlocks the given mutex on construction/destruction, respectively.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

395

396

File Documentation

6.25.1

Detailed Description

Author
Daniel Krajzewicz
Michael Behrisch

Date
2005-07-12

Version

Id:
AbstractMutex.h 18095 2015-03-17 09:39:00Z behrisch

6.26

src/sumo/include/utils/common/Command.h File Reference

#include <config.h>
#include <utils/common/SUMOTime.h>
#include <utils/common/UtilExceptions.h>

Classes
class Command
Base (microsim) event class.

6.26.1

Detailed Description

Author
Christian Roessel
Daniel Krajzewicz

Date
Thu, 20 Dec 2001

Version

Id:
Command.h 18095 2015-03-17 09:39:00Z behrisch
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

6.27 src/sumo/include/utils/common/FileHelpers.h File Reference

6.27

src/sumo/include/utils/common/FileHelpers.h File Reference

#include
#include
#include
#include
#include
#include

<config.h>
<cassert>
<fstream>
<string>
<vector>
"SUMOTime.h"

Classes
class FileHelpers
Functions for an easier usage of files and paths.

6.27.1

Detailed Description

Author
Daniel Krajzewicz
Michael Behrisch
Jakob Erdmann

Date
Mon, 17 Dec 2001

Version

Id:
FileHelpers.h 18095 2015-03-17 09:39:00Z behrisch

6.28

src/sumo/include/utils/common/IDSupplier.h File Reference

#include <config.h>
#include <string>
#include <vector>

Classes
class IDSupplier
This class builds string ids by adding an increasing numerical value to a previously given string.

6.28.1

Detailed Description

Author
Daniel Krajzewicz
Jakob Erdmann

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

397

398

File Documentation

Date
Sept 2002

Version

Id:
IDSupplier.h 18095 2015-03-17 09:39:00Z behrisch

6.29

src/sumo/include/utils/common/MsgHandler.h File Reference

#include
#include
#include
#include

<config.h>
<string>
<vector>
<iostream>

Classes
class MsgHandler
MsgHandler.

Macros
#define WRITE_WARNING(msg) MsgHandler::getWarningInstance()->inform(msg);
#define WRITE_MESSAGE(msg) MsgHandler::getMessageInstance()->inform(msg);
#define
PROGRESS_BEGIN_MESSAGE(msg)
MsgHandler::getMessageInstance()->beginProcessMsg((msg) + std::string("..."));
#define PROGRESS_DONE_MESSAGE() MsgHandler::getMessageInstance()->endProcessMsg("done.");
#define PROGRESS_FAILED_MESSAGE() MsgHandler::getMessageInstance()->endProcessMsg("failed.");
#define WRITE_ERROR(msg) MsgHandler::getErrorInstance()->inform(msg);

6.29.1

Detailed Description

Author
Daniel Krajzewicz
Michael Behrisch
Jakob Erdmann

Date
Tue, 17 Jun 2003

Version

Id:
MsgHandler.h 18095 2015-03-17 09:39:00Z behrisch
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

6.30 src/sumo/include/utils/common/MsgRetrievingFunction.h File Reference

6.30

src/sumo/include/utils/common/MsgRetrievingFunction.h File Reference

#include
#include
#include
#include
#include

<config.h>
<string>
<sstream>
<utils/iodevices/OutputDevice.h>
"MsgHandler.h"

Classes
class MsgRetrievingFunction< T >
Encapsulates an objects method for using it as a message retriever.

6.30.1

Detailed Description

Author
Daniel Krajzewicz
Michael Behrisch

Date
Mon, 24 Oct 2003

Version

Id:
MsgRetrievingFunction.h 18095 2015-03-17 09:39:00Z behrisch

6.31

src/sumo/include/utils/common/Named.h File Reference

#include <config.h>
#include <string>
#include <set>

Classes
class Named
Base class for objects which have an id.

struct Named::ComparatorIdLess
Function-object for stable sorting in containers.

struct Named::NamedLikeComparatorIdLess< NamedLike >


Function-object for stable sorting of objects acting like Named without being derived (SUMOVehicle)

class Named::StoringVisitor
Allows to store the object; used as context while traveling the rtree in TraCI.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

399

400

File Documentation

6.31.1

Detailed Description

Author
Daniel Krajzewicz
Jakob Erdmann

Date
Sept 2002

Version

Id:
Named.h 18095 2015-03-17 09:39:00Z behrisch

6.32

src/sumo/include/utils/common/NamedObjectCont.h File Reference

#include
#include
#include
#include
#include

<config.h>
<map>
<string>
<vector>
<algorithm>

Classes
class NamedObjectCont< T >
A map of named object pointers.

6.32.1

Detailed Description

Author
Daniel Krajzewicz
Michael Behrisch
Jakob Erdmann

Date
Sept 2002

Version

Id:
NamedObjectCont.h 18095 2015-03-17 09:39:00Z behrisch
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

6.33 src/sumo/include/utils/common/NamedRTree.h File Reference

6.33

src/sumo/include/utils/common/NamedRTree.h File Reference

#include
#include
#include
#include

<config.h>
<set>
<foreign/rtree/RTree.h>
<utils/common/Named.h>

Classes
class NamedRTree
A RT-tree for efficient storing of SUMOs Named objects.

Macros
#define NAMED_RTREE_QUAL RTree<Named, Named, float, 2, Named::StoringVisitor>

6.33.1

Detailed Description

Author
Daniel Krajzewicz
Jakob Erdmann
Michael Behrisch

Date
27.10.2008

Version

Id:
NamedRTree.h 18095 2015-03-17 09:39:00Z behrisch

6.34

src/sumo/include/utils/common/Parameterised.h File Reference

#include <config.h>
#include <map>
#include <string>

Classes
class Parameterised
An upper class for objects with additional parameters.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

401

402

File Documentation

6.34.1

Detailed Description

Author
Daniel Krajzewicz
Jakob Erdmann
Michael Behrisch
Melanie Knocke

Date
Sept 2002

Version

Id:
Parameterised.h 18137 2015-03-24 15:12:38Z behrisch

6.35

src/sumo/include/utils/common/RandHelper.h File Reference

#include
#include
#include
#include

<config.h>
<cassert>
<vector>
<foreign/mersenne/MersenneTwister.h>

Classes
class RandHelper
Utility functions for using a global, resetable random number generator.

6.35.1

Detailed Description

Author
Daniel Krajzewicz
Michael Behrisch
Jakob Erdmann

Date
Fri, 29.04.2005

Version

Id:
RandHelper.h 18096 2015-03-17 09:50:59Z behrisch
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

6.36 src/sumo/include/utils/common/RandomDistributor.h File Reference

6.36

src/sumo/include/utils/common/RandomDistributor.h File Reference

#include
#include
#include
#include
#include

<config.h>
<cassert>
<limits>
<utils/common/RandHelper.h>
<utils/common/UtilExceptions.h>

Classes
class RandomDistributor< T >
Represents a generic random distribution.

6.36.1

Detailed Description

Author
Daniel Krajzewicz
Michael Behrisch
Jakob Erdmann

Date
2005-09-15

Version

Id:
RandomDistributor.h 18095 2015-03-17 09:39:00Z behrisch

6.37

src/sumo/include/utils/common/RGBColor.h File Reference

#include <config.h>
#include <iostream>
#include <utils/common/UtilExceptions.h>

Classes
class RGBColor
The definition of a color in the RGB-space with an alpha channel.

6.37.1

Detailed Description

Author
Daniel Krajzewicz
Jakob Erdmann
Michael Behrisch

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

403

404

File Documentation

Date
Sept 2002

Version

Id:
RGBColor.h 18095 2015-03-17 09:39:00Z behrisch

6.38

src/sumo/include/utils/common/StaticCommand.h File Reference

#include <config.h>
#include "Command.h"

Classes
class StaticCommand< T >
A wrapper for a Command function.

6.38.1

Detailed Description

Author
Daniel Krajzewicz
Michael Behrisch

Date
Wed, 13.02.2008

Version

Id:
taticCommand.h 4699 2007-11-09 14:05:13Z dkrajzew

6.39

src/sumo/include/utils/common/StdDefs.h File Reference

#include <config.h>
#include <utils/xml/SUMOXMLDefinitions.h>

Macros
#define UNUSED_PARAMETER(x) ((void)(x))
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

6.39 src/sumo/include/utils/common/StdDefs.h File Reference

Functions
const RGBColor & getLinkColor (const LinkState &ls)
const std::string getBuildName (const std::string &version)
attach some build flags to the version string

template<typename T >
T MIN2 (T a, T b)
template<typename T >
T MAX2 (T a, T b)
template<typename T >
T MIN3 (T a, T b, T c)
template<typename T >
T MAX3 (T a, T b, T c)
template<typename T >
T MIN4 (T a, T b, T c, T d)
template<typename T >
T MAX4 (T a, T b, T c, T d)
template<typename T >
T ISNAN (T a)

Variables
const SUMOReal SUMO_const_laneWidth = (SUMOReal) 3.2
const SUMOReal SUMO_const_halfLaneWidth = (SUMOReal) 1.6
const SUMOReal SUMO_const_quarterLaneWidth = (SUMOReal) 0.8
const SUMOReal SUMO_const_laneOffset = (SUMOReal) .1
const SUMOReal SUMO_const_laneWidthAndOffset = (SUMOReal) 3.3
const SUMOReal SUMO_const_halfLaneAndOffset = (SUMOReal)(3.2 / 2. + .1)
const SUMOReal SUMO_const_haltingSpeed = (SUMOReal) 0.1
the speed threshold at which vehicles are considered as halting

bool gDebugFlag1
global utility flags for debugging

bool gDebugFlag2

6.39.1

Detailed Description

Author
Daniel Krajzewicz
Laura Bieker
Michael Behrisch
Jakob Erdmann

Date
Fri, 29.04.2005

Version

Id:
StdDefs.h 18095 2015-03-17 09:39:00Z behrisch
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

405

406

File Documentation

6.40

src/sumo/include/utils/common/StringBijection.h File Reference

#include
#include
#include
#include
#include
#include

<config.h>
<iostream>
<map>
<vector>
<string>
<utils/common/UtilExceptions.h>

Classes
class StringBijection< T >
Template container for maintaining a bidirectional map between strings and something else It is not always a bijection
since it allows for duplicate entries on both sides if either checkDuplicates is set to false in the constructor or the insert
function or if the addAlias function is used.

struct StringBijection< T >::Entry

6.40.1

Detailed Description

Author
Daniel Krajzewicz
Michael Behrisch
Jakob Erdmann

Date
Mar 2011

Version

Id:
StringBijection.h 18095 2015-03-17 09:39:00Z behrisch

6.41

src/sumo/include/utils/common/StringTokenizer.h File Reference

#include <config.h>
#include <string>
#include <vector>

Classes
class StringTokenizer
StringTokenizer A class similar to the StringTokenizer from Java.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

6.42 src/sumo/include/utils/common/StringUtils.h File Reference

6.41.1

Detailed Description

Author
Daniel Krajzewicz
Jakob Erdmann
Michael Behrisch
Date
?
Version

Id:
StringTokenizer.h 18095 2015-03-17 09:39:00Z behrisch

6.42

src/sumo/include/utils/common/StringUtils.h File Reference

#include <config.h>
#include <string>

Classes
class StringUtils
Some static methods for string processing.

6.42.1

Detailed Description

Author
Daniel Krajzewicz
Jakob Erdmann
Michael Behrisch
Date
unknown
Version

Id:
StringUtils.h 18095 2015-03-17 09:39:00Z behrisch

6.43

src/sumo/include/utils/common/SUMOTime.h File Reference

#include
#include
#include
#include

<config.h>
<climits>
<string>
"UtilExceptions.h"

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

407

408

File Documentation

Macros
#define SUMOTime_MAX INT_MAX
#define SUMOTime_MIN INT_MIN
#define SUMOTIME_MAXSTRING "2147483"
#define DELTA_T 1
#define TS (static_cast<SUMOReal>(1.))
#define SPEED2DIST(x) (x)
#define DIST2SPEED(x) (x)
#define ACCEL2DIST(x) (x)
#define ACCEL2SPEED(x) (x)
#define SPEED2ACCEL(x) (x)
#define STEPS2TIME(x) (static_cast<SUMOReal>(x))
#define TIME2STEPS(x) (static_cast<SUMOTime>(x))
#define STEPFLOOR(x) (x)
#define STEPS2MS(x) ((x)1000)
#define SIMTIME STEPS2TIME(MSNet::getInstance()->getCurrentTimeStep())

Typedefs
typedef int SUMOTime

Functions
SUMOTime string2time (const std::string &r)
std::string time2string (SUMOTime t)

6.43.1

Detailed Description

Author
Daniel Krajzewicz
Jakob Erdmann
Michael Behrisch

Date
Fri, 29.04.2005

Version

Id:
SUMOTime.h 18095 2015-03-17 09:39:00Z behrisch

Author
Daniel Krajzewicz
Jakob Erdmann
Michael Behrisch

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

6.44 src/sumo/include/utils/common/SUMOVehicleClass.h File Reference

409

Date
Fri, 29.04.2005

Version

Id:
SUMOTime.cpp 18095 2015-03-17 09:39:00Z behrisch

6.44

src/sumo/include/utils/common/SUMOVehicleClass.h File Reference

#include
#include
#include
#include
#include
#include
#include

<config.h>
<string>
<set>
<limits>
<utils/common/UtilExceptions.h>
<utils/common/StringBijection.h>
<utils/xml/SUMOXMLDefinitions.h>

Typedefs
typedef int SVCPermissions
typedef int SUMOEmissionClass

Enumerations
enum SUMOVehicleShape {
SVS_UNKNOWN, SVS_PEDESTRIAN, SVS_BICYCLE, SVS_MOPED,
SVS_MOTORCYCLE, SVS_PASSENGER, SVS_PASSENGER_SEDAN, SVS_PASSENGER_HATCHBACK,
SVS_PASSENGER_WAGON, SVS_PASSENGER_VAN, SVS_DELIVERY, SVS_TRUCK,
SVS_TRUCK_SEMITRAILER, SVS_TRUCK_1TRAILER, SVS_BUS, SVS_BUS_COACH,
SVS_BUS_FLEXIBLE, SVS_BUS_TROLLEY, SVS_RAIL, SVS_RAIL_CAR,
SVS_RAIL_CARGO, SVS_E_VEHICLE, SVS_ANT, SVS_SHIP }
Definition of vehicle classes to differ between different appearences.

enum SUMOVehicleClass {
SVC_IGNORING = 0, SVC_PRIVATE = 1, SVC_EMERGENCY = 1 << 1, SVC_AUTHORITY = 1 << 2,
SVC_ARMY = 1 << 3, SVC_VIP = 1 << 4, SVC_PASSENGER = 1 << 5, SVC_HOV = 1 << 6,
SVC_TAXI = 1 << 7, SVC_BUS = 1 << 8, SVC_COACH = 1 << 9, SVC_DELIVERY = 1 << 10,
SVC_TRUCK = 1 << 11, SVC_TRAILER = 1 << 12, SVC_TRAM = 1 << 13, SVC_RAIL_URBAN = 1 <<
14,
SVC_RAIL = 1 << 15, SVC_RAIL_ELECTRIC = 1 << 16, SVC_MOTORCYCLE = 1 << 17, SVC_MOPED
= 1 << 18,
SVC_BICYCLE = 1 << 19, SVC_PEDESTRIAN = 1 << 20, SVC_E_VEHICLE = 1 << 21, SVC_SHIP = 1
<< 22,
SVC_CUSTOM1 = 1 << 23, SVC_CUSTOM2 = 1 << 24 }
Definition of vehicle classes to differ between different lane usage and authority types.

Functions
std::string getVehicleClassCompoundName (int id)
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

410

File Documentation

std::string getVehicleClassNames (SVCPermissions permissions)


Returns the ids of the given classes, divided using a .

std::vector< std::string > getVehicleClassNamesList (SVCPermissions permissions)


Returns the ids of the given classes, divided using a .

SUMOVehicleClass getVehicleClassID (const std::string &name)


Returns the class id of the abstract class given by its name.

int getVehicleClassCompoundID (const std::string &name)


Returns the ORed id of the compound class given by its name.

SVCPermissions parseVehicleClasses (const std::string &allowedS)


Parses the given definition of allowed vehicle classes into the given containers Deprecated classes go into a separate
container.

bool canParseVehicleClasses (const std::string &classes)


Checks whether the given string contains only known vehicle classes.

SVCPermissions parseVehicleClasses (const std::string &allowedS, const std::string &disallowedS)


Encodes the given vector of allowed and disallowed classes into a bitset.

SVCPermissions parseVehicleClasses (const std::vector< std::string > &allowedS)


Encodes the given vector of allowed classs into a bitset Unlike the methods which parse a string it gives immediately
a warning output on deprecated vehicle classes.

std::string getVehicleShapeName (SUMOVehicleShape id)


Returns the class name of the shape class given by its id.

SUMOVehicleShape getVehicleShapeID (const std::string &name)


Returns the class id of the shape class given by its name.

bool isRailway (SVCPermissions permissions)


Returns whether an edge with the given permission is a railway edge.

bool isWaterway (SVCPermissions permissions)


Returns whether an edge with the given permission is a waterway edge.

bool isForbidden (SVCPermissions permissions)


Returns whether an edge with the given permission is a forbidden edge.

Variables
const int SUMOVehicleClass_MAX
StringBijection< SUMOVehicleClass > SumoVehicleClassStrings
std::set< std::string > deprecatedVehicleClassesSeen
StringBijection< SUMOVehicleShape > SumoVehicleShapeStrings
const SVCPermissions SVCAll
const SVCPermissions SVC_UNSPECIFIED
const std::string DEFAULT_VTYPE_ID
const std::string DEFAULT_PEDTYPE_ID
const SUMOReal DEFAULT_VEH_PROB
const SUMOReal DEFAULT_PEDESTRIAN_SPEED
const SUMOReal DEFAULT_CONTAINER_TRANSHIP_SPEED

6.44.1

Detailed Description

Author
Daniel Krajzewicz
Jakob Erdmann
Michael Behrisch
Walter Bamberger

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

6.44 src/sumo/include/utils/common/SUMOVehicleClass.h File Reference


Date
2006-01-24

Version

Id:
SUMOVehicleClass.h 18096 2015-03-17 09:50:59Z behrisch

6.44.2

Enumeration Type Documentation

6.44.2.1

enum SUMOVehicleClass

Definition of vehicle classes to differ between different lane usage and authority types.
Bits:
0-7: vehicle ownership
8-23: vehicle size
From NavTeq:
[0] All
[1] Passenger cars
[2] High Occupancy Vehicle
[3] Emergency Vehicle
[4] Taxi
[5] Public Bus
[6] Delivery Truck
[7] Transport Truck
[8] Bicycle
[9] Pedestrian
Enumerator
SVC_IGNORING vehicles ignoring classes
SVC_PRIVATE private vehicles
SVC_EMERGENCY public emergency vehicles
SVC_AUTHORITY authorities vehicles
SVC_ARMY army vehicles
SVC_VIP vip vehicles
SVC_PASSENGER vehicle is a passenger car (a "normal" car)
SVC_HOV vehicle is a HOV
SVC_TAXI vehicle is a taxi
SVC_BUS vehicle is a bus
SVC_COACH vehicle is a coach
SVC_DELIVERY vehicle is a small delivery vehicle
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

411

412

File Documentation

SVC_TRUCK vehicle is a large transport vehicle


SVC_TRAILER vehicle is a large transport vehicle
SVC_TRAM vehicle is a light rail
SVC_RAIL_URBAN vehicle is a city rail
SVC_RAIL vehicle is a not electrified rail
SVC_RAIL_ELECTRIC vehicle is a (possibly fast moving) electric rail
SVC_MOTORCYCLE vehicle is a motorcycle
SVC_MOPED vehicle is a moped
SVC_BICYCLE vehicle is a bicycle
SVC_PEDESTRIAN is a pedestrian
SVC_E_VEHICLE is an electric vehicle
SVC_SHIP is an arbitrary ship
SVC_CUSTOM1 is a user-defined type
SVC_CUSTOM2 is a user-defined type

6.44.2.2

enum SUMOVehicleShape

Definition of vehicle classes to differ between different appearences.


Enumerator
SVS_UNKNOWN not defined
SVS_PEDESTRIAN render as a pedestrian
SVS_BICYCLE render as a bicycle
SVS_MOPED render as a moped
SVS_MOTORCYCLE render as a motorcycle
SVS_PASSENGER render as a passenger vehicle
SVS_PASSENGER_SEDAN render as a sedan passenger vehicle ("Stufenheck")
SVS_PASSENGER_HATCHBACK render as a hatchback passenger vehicle ("Fliessheck")
SVS_PASSENGER_WAGON render as a wagon passenger vehicle ("Combi")
SVS_PASSENGER_VAN render as a van
SVS_DELIVERY render as a delivery vehicle
SVS_TRUCK render as a transport vehicle
SVS_TRUCK_SEMITRAILER render as a semi-trailer transport vehicle ("Sattelschlepper")
SVS_TRUCK_1TRAILER render as a transport vehicle with one trailer
SVS_BUS render as a bus
SVS_BUS_COACH render as a coach
SVS_BUS_FLEXIBLE render as a flexible city bus
SVS_BUS_TROLLEY render as a trolley bus
SVS_RAIL render as a rail
SVS_RAIL_CAR render as a (city) rail without locomotive
SVS_RAIL_CARGO render as a cargo train
SVS_E_VEHICLE render as a (futuristic) e-vehicle
SVS_ANT render as a giant ant
SVS_SHIP render as a arbitrary ship

6.44.3

Function Documentation

6.44.3.1

int getVehicleClassCompoundID ( const std::string & name )

Returns the ORed id of the compound class given by its name.


Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

6.44 src/sumo/include/utils/common/SUMOVehicleClass.h File Reference


Parameters
name

in

The name of the abstract vehicle class

Returns
The ORed combination of base enum values

6.44.3.2 SUMOVehicleClass getVehicleClassID ( const std::string & name )


Returns the class id of the abstract class given by its name.
Parameters
name

in

The name of the abstract vehicle class

Returns
The internal representation of this class. Name must not be a compound name

6.44.3.3

std::string getVehicleClassNames ( SVCPermissions permissions )

Returns the ids of the given classes, divided using a .


Parameters
the

in

permissions to encode

Returns
The string representation of these classes

6.44.3.4

std::vector<std::string> getVehicleClassNamesList ( SVCPermissions permissions )

Returns the ids of the given classes, divided using a .


Parameters

in

the

permissions to encode

Returns
The string representation of these classes as a vector
Todo cache values?

6.44.3.5 SUMOVehicleShape getVehicleShapeID ( const std::string & name )


Returns the class id of the shape class given by its name.
Parameters

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

413

414

File Documentation

name

in

The name of the shape class

Returns
The internal representation of this class

6.44.3.6

std::string getVehicleShapeName ( SUMOVehicleShape id )

Returns the class name of the shape class given by its id.
Parameters
id

in

The id of the shape class

Returns
The string representation of this class

6.44.3.7

bool isForbidden ( SVCPermissions permissions )

Returns whether an edge with the given permission is a forbidden edge.


Parameters
permissions

in

The permissions of the edge

Returns
Whether the edge is forbidden

6.44.3.8

bool isRailway ( SVCPermissions permissions )

Returns whether an edge with the given permission is a railway edge.


Parameters
permissions

in

The permissions of the edge

Returns
Whether the edge is a railway edge

6.44.3.9

bool isWaterway ( SVCPermissions permissions )

Returns whether an edge with the given permission is a waterway edge.


Parameters

in

permissions

The permissions of the edge

Returns
Whether the edge is a waterway edge

6.44.3.10

SVCPermissions parseVehicleClasses ( const std::string & allowedS )

Parses the given definition of allowed vehicle classes into the given containers Deprecated classes go into a separate container.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

6.45 src/sumo/include/utils/common/SystemFrame.h File Reference

415

Parameters
classNames
container

in
out

6.44.3.11

Space separated class names


The set of vehicle classes to fill throws ProcessError if parsing fails

SVCPermissions parseVehicleClasses ( const std::string & allowedS, const std::string & disallowedS )

Encodes the given vector of allowed and disallowed classes into a bitset.
Parameters
allowedS
disallowedS

in
in

Definition which classes are allowed


Definition which classes are not allowed

SVCPermissions parseVehicleClasses ( const std::vector< std::string > & allowedS )

6.44.3.12

Encodes the given vector of allowed classs into a bitset Unlike the methods which parse a string it gives immediately
a warning output on deprecated vehicle classes.
Parameters
classesS

in

6.45

The names vector to parse

src/sumo/include/utils/common/SystemFrame.h File Reference

#include <config.h>

Classes
class SystemFrame
A set of actions common to all applications.

6.45.1

Detailed Description

Author
Daniel Krajzewicz
Michael Behrisch

Date
Mon, 23.06.2003

Version

Id:
SystemFrame.h 18095 2015-03-17 09:39:00Z behrisch
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

416

File Documentation

6.46

src/sumo/include/utils/common/SysUtils.h File Reference

#include <config.h>
#include <string>

Classes
class SysUtils
A few system-specific functions.

6.46.1

Detailed Description

Author
Daniel Krajzewicz

Date
Fri, 29.04.2005

Version

Id:
SysUtils.h 18095 2015-03-17 09:39:00Z behrisch

6.47

src/sumo/include/utils/common/ToString.h File Reference

#include
#include
#include
#include
#include
#include
#include
#include

<config.h>
<sstream>
<string>
<iomanip>
<algorithm>
<utils/xml/SUMOXMLDefinitions.h>
<utils/common/SUMOVehicleClass.h>
"StdDefs.h"

Functions
template<class T >
std::string toString (const T &t, std::streamsize accuracy=OUTPUT_ACCURACY)
Template for conversions from origin format to string representation (when supplied by c++/the stl)

template<typename T >
std::string toHex (const T i, std::streamsize numDigits=0)
template<>
std::string toString< SumoXMLTag > (const SumoXMLTag &tag, std::streamsize accuracy)
template<>
std::string toString< SumoXMLAttr > (const SumoXMLAttr &attr, std::streamsize accuracy)
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

6.47 src/sumo/include/utils/common/ToString.h File Reference

417

template<>
std::string toString< SumoXMLNodeType > (const SumoXMLNodeType &nodeType, std::streamsize accuracy)
template<>
std::string toString< SumoXMLEdgeFunc > (const SumoXMLEdgeFunc &edgeFunc, std::streamsize accuracy)
template<>
std::string toString< SUMOVehicleClass > (const SUMOVehicleClass &vClass, std::streamsize accuracy)
template<>
std::string toString< LaneSpreadFunction > (const LaneSpreadFunction &lsf, std::streamsize accuracy)
template<>
std::string toString< LinkState > (const LinkState &linkState, std::streamsize accuracy)
template<>
std::string toString< LinkDirection > (const LinkDirection &linkDir, std::streamsize accuracy)
template<>
std::string toString< TrafficLightType > (const TrafficLightType &type, std::streamsize accuracy)
template<>
std::string toString< LaneChangeModel > (const LaneChangeModel &model, std::streamsize accuracy)
template<typename V >
std::string toString (const std::vector< V > &v, std::streamsize accuracy=OUTPUT_ACCURACY)
template<typename V >
std::string toString (const typename std::vector< V >::const_iterator &b, const typename std::vector< V
>::const_iterator &e, std::streamsize accuracy=OUTPUT_ACCURACY)
template<typename T , typename T_BETWEEN >
std::string joinToString (const std::vector< T > &v, const T_BETWEEN &between, std::streamsize
accuracy=OUTPUT_ACCURACY)
template<typename T , typename T_BETWEEN >
std::string joinToStringSorting (const std::vector< T > &v, const T_BETWEEN &between, std::streamsize
accuracy=OUTPUT_ACCURACY)
template<typename V >
std::string toString (const std::set< V > &v, std::streamsize accuracy=OUTPUT_ACCURACY)
template<>
std::string toString (const std::vector< int > &v, std::streamsize accuracy)
template<>
std::string toString (const std::vector< SUMOReal > &v, std::streamsize accuracy)
template<typename T , typename T_BETWEEN >
std::string joinToString (const std::set< T > &s, const T_BETWEEN &between, std::streamsize
accuracy=OUTPUT_ACCURACY)
template<>
std::string toString (const std::set< std::string > &v, std::streamsize)
template<typename KEY , typename VAL , typename T_BETWEEN , typename T_BETWEEN_KEYVAL >
std::string joinToString (const std::map< KEY, VAL > &s, const T_BETWEEN &between, const T_BETWEEN_KEYVAL &between_keyval, std::streamsize accuracy=OUTPUT_ACCURACY)
template<>
std::string toString (const std::map< std::string, std::string > &v, std::streamsize)

6.47.1

Detailed Description

Author
Christian Roessel
Daniel Krajzewicz
Jakob Erdmann
Michael Behrisch

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

418

File Documentation

Date
Wed, 23 Sep 2002

Version

Id:
ToString.h 18095 2015-03-17 09:39:00Z behrisch

6.48

src/sumo/include/utils/common/TplConvert.h File Reference

#include
#include
#include
#include
#include
#include
#include

<config.h>
<string>
<cmath>
<limits>
<algorithm>
<utils/common/UtilExceptions.h>
<utils/common/StdDefs.h>

Classes
class TplConvert
TplConvert Some methods that convert 0-terminated char-arrays of any type into other values (numerical/boolean) or
into std::strings.

6.48.1

Detailed Description

Author
Daniel Krajzewicz
Jakob Erdmann
Michael Behrisch

Date
Sun, 09 Jun 2002

Version

Id:
TplConvert.h 18095 2015-03-17 09:39:00Z behrisch

6.49

src/sumo/include/utils/common/UtilExceptions.h File Reference

#include <config.h>
#include <string>
#include <stdexcept>

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

6.50 src/sumo/include/utils/common/ValueRetriever.h File Reference

419

Classes
class ProcessError
ProcessError A general exception type that may be thrown when the process is no longer able to proceed due to any
reason.

class InvalidArgument
InvalidArgument Thrown when an argument was not proper in the current context A message will be supplied.

class EmptyData
EmptyData Thrown when data required by a method is missing.

class FormatException
FormatException Thrown when a string that shall be converted into something else contained the wrong characters.

class NumberFormatException
NumberFormatException Thrown when the string that shall be converted into a numerical representation has any
other characters then digits and a dot.

class BoolFormatException
BoolFormatException Thrown when the string that shall be converted into a boolean does not match.

class OutOfBoundsException
OutOfBoundsException Thrown when an array element out of the arrays bounderies is accessed.

class UnknownElement
UnknownElement Thrown when a named element is tried to be accesed which is not known to the container.

class IOError

6.49.1

Detailed Description

Author
Daniel Krajzewicz
Christian Roessel
Michael Behrisch
Felix Brack

Date
Mon, 17 Dec 2001

Version

Id:
UtilExceptions.h 18095 2015-03-17 09:39:00Z behrisch

6.50

src/sumo/include/utils/common/ValueRetriever.h File Reference

#include <config.h>

Classes
class ValueRetriever< T >
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

420

File Documentation

6.50.1

Detailed Description

Author
Daniel Krajzewicz

Date
Fri, 29.04.2005

Version

Id:
ValueRetriever.h 18095 2015-03-17 09:39:00Z behrisch

6.51

src/sumo/include/utils/common/ValueSource.h File Reference

#include <config.h>

Classes
class ValueSource< T >

6.51.1

Detailed Description

Author
Daniel Krajzewicz

Date
Fri, 29.04.2005

Version

Id:
ValueSource.h 18095 2015-03-17 09:39:00Z behrisch

6.52

src/sumo/include/utils/common/ValueTimeLine.h File Reference

#include
#include
#include
#include
#include

<map>
<cassert>
<utility>
<utils/common/SUMOTime.h>
<config.h>

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

6.53 src/sumo/include/utils/common/VectorHelper.h File Reference

Classes
class ValueTimeLine< T >
A time line being a sorted container of non-overlapping time-ranges with assigned values.

6.52.1

Detailed Description

Author
Christian Roessel
Daniel Krajzewicz
Michael Behrisch

Date
Sept 2002

Version

Id:
ValueTimeLine.h 18095 2015-03-17 09:39:00Z behrisch

6.53

src/sumo/include/utils/common/VectorHelper.h File Reference

#include
#include
#include
#include
#include

<config.h>
<vector>
<limits>
<algorithm>
<iostream>

Classes
class VectorHelper< T >

Functions
template<class T >
std::ostream & operator<< (std::ostream &os, const std::vector< T > &v)

6.53.1

Detailed Description

Author
Daniel Krajzewicz
Jakob Erdmann
Michael Behrisch

Date
Sept 2002

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

421

422

File Documentation

Version

Id:
VectorHelper.h 18095 2015-03-17 09:39:00Z behrisch

6.54

src/sumo/include/utils/common/WrappingCommand.h File Reference

#include <config.h>
#include "Command.h"

Classes
class WrappingCommand< T >
A wrapper for a Command function.

6.54.1

Detailed Description

Author
Christian Roessel
Daniel Krajzewicz

Date
Thu, 20 Dec 2001

Version

Id:
WrappingCommand.h 18095 2015-03-17 09:39:00Z behrisch

6.55

src/sumo/include/utils/iodevices/BinaryFormatter.h File Reference

#include
#include
#include
#include
#include
#include

<config.h>
<vector>
<utils/common/FileHelpers.h>
<utils/common/ToString.h>
<utils/xml/SUMOXMLDefinitions.h>
"OutputFormatter.h"

Classes
class BinaryFormatter
Output formatter for plain XML output.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

6.56 src/sumo/include/utils/iodevices/BinaryInputDevice.h File Reference

6.55.1

Detailed Description

Author
Daniel Krajzewicz
Jakob Erdmann
Michael Behrisch

Date
2012

Version

Id:
BinaryFormatter.h 18095 2015-03-17 09:39:00Z behrisch

6.56

src/sumo/include/utils/iodevices/BinaryInputDevice.h File Reference

#include
#include
#include
#include
#include

<config.h>
<string>
<vector>
<fstream>
"BinaryFormatter.h"

Classes
class BinaryInputDevice
Encapsulates binary reading operations on a file.

6.56.1

Detailed Description

Author
Daniel Krajzewicz
Michael Behrisch
Jakob Erdmann

Date
2005-09-15

Version

Id:
BinaryInputDevice.h 18095 2015-03-17 09:39:00Z behrisch
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

423

424

File Documentation

6.57

src/sumo/include/utils/iodevices/OutputDevice.h File Reference

#include
#include
#include
#include
#include
#include
#include

<config.h>
<string>
<map>
<utils/common/ToString.h>
<utils/xml/SUMOXMLDefinitions.h>
"PlainXMLFormatter.h"
"BinaryFormatter.h"

Classes
class OutputDevice
Static storage of an output device and its base (abstract) implementation.

6.57.1

Detailed Description

Author
Daniel Krajzewicz
Jakob Erdmann
Michael Behrisch
Mario Krumnow
Date
2004
Version

Id:
OutputDevice.h 18095 2015-03-17 09:39:00Z behrisch

6.58

src/sumo/include/utils/iodevices/OutputDevice_CERR.h File Reference

#include <config.h>
#include "OutputDevice.h"

Classes
class OutputDevice_CERR
An output device that encapsulates cerr.

6.58.1

Detailed Description

Author
Daniel Krajzewicz
Michael Behrisch

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

6.59 src/sumo/include/utils/iodevices/OutputDevice_COUT.h File Reference


Date
2004

Version

Id:
OutputDevice_CERR.h 18095 2015-03-17 09:39:00Z behrisch

6.59

src/sumo/include/utils/iodevices/OutputDevice_COUT.h File Reference

#include <config.h>
#include "OutputDevice.h"

Classes
class OutputDevice_COUT
An output device that encapsulates cout.

6.59.1

Detailed Description

Author
Daniel Krajzewicz
Michael Behrisch

Date
2004

Version

Id:
OutputDevice_COUT.h 18095 2015-03-17 09:39:00Z behrisch

6.60

src/sumo/include/utils/iodevices/OutputDevice_File.h File Reference

#include <config.h>
#include <fstream>
#include "OutputDevice.h"

Classes
class OutputDevice_File
An output device that encapsulates an ofstream.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

425

426

File Documentation

6.60.1

Detailed Description

Author
Daniel Krajzewicz
Michael Behrisch

Date
2004

Version

Id:
OutputDevice_File.h 18095 2015-03-17 09:39:00Z behrisch

6.61

src/sumo/include/utils/iodevices/OutputDevice_Network.h File Reference

#include
#include
#include
#include
#include
#include
#include
#include

<config.h>
"foreign/tcpip/socket.h"
"foreign/tcpip/storage.h"
"OutputDevice.h"
<utils/common/UtilExceptions.h>
<string>
<iostream>
<sstream>

Classes
class OutputDevice_Network
An output device for TCP/IP network connections.

6.61.1

Detailed Description

Author
Michael Behrisch
Daniel Krajzewicz
Felix Brack

Date
2006

Version

Id:
OutputDevice_Network.h 18095 2015-03-17 09:39:00Z behrisch
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

6.62 src/sumo/include/utils/iodevices/OutputDevice_String.h File Reference

6.62

src/sumo/include/utils/iodevices/OutputDevice_String.h File Reference

#include <config.h>
#include <fstream>
#include "OutputDevice.h"

Classes
class OutputDevice_String
An output device that encapsulates an ofstream.

6.62.1

Detailed Description

Author
Michael Behrisch

Date
2009

Version

Id:
OutputDevice_String.h 18095 2015-03-17 09:39:00Z behrisch

6.63

src/sumo/include/utils/iodevices/OutputFormatter.h File Reference

#include
#include
#include
#include

<config.h>
<string>
<vector>
<utils/xml/SUMOXMLDefinitions.h>

Classes
class OutputFormatter
Abstract base class for output formatters.

6.63.1

Detailed Description

Author
Daniel Krajzewicz
Michael Behrisch

Date
2012

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

427

428

File Documentation

Version

Id:
OutputFormatter.h 18095 2015-03-17 09:39:00Z behrisch

6.64

src/sumo/include/utils/iodevices/PlainXMLFormatter.h File Reference

#include <config.h>
#include "OutputFormatter.h"

Classes
class PlainXMLFormatter
Output formatter for plain XML output.

6.64.1

Detailed Description

Author
Daniel Krajzewicz
Michael Behrisch

Date
2012

Version

Id:
PlainXMLFormatter.h 18095 2015-03-17 09:39:00Z behrisch

6.65

src/sumo/include/utils/options/Option.h File Reference

#include
#include
#include
#include
#include

<config.h>
<string>
<vector>
<exception>
<utils/common/UtilExceptions.h>

Classes
class Option
A class representing a single program option.

class Option_Integer
An integer-option.

class Option_String
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

6.66 src/sumo/include/utils/options/OptionsCont.h File Reference

class Option_Float
class Option_Bool
class Option_FileName
class Option_IntVector

Typedefs
typedef std::vector< int > IntVector
Definition of a vector of unsigned ints.

6.65.1

Detailed Description

Author
Daniel Krajzewicz
Michael Behrisch
Jakob Erdmann

Date
Mon, 17 Dec 2001

Version

Id:
Option.h 18095 2015-03-17 09:39:00Z behrisch

6.66

src/sumo/include/utils/options/OptionsCont.h File Reference

#include
#include
#include
#include
#include
#include

<config.h>
<map>
<string>
<vector>
<iostream>
"Option.h"

Classes
class OptionsCont
A storage for options typed value containers)

6.66.1

Detailed Description

Author
Daniel Krajzewicz
Jakob Erdmann
Michael Behrisch
Walter Bamberger

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

429

430

File Documentation

Date
Mon, 17 Dec 2001
Version

Id:
OptionsCont.h 18095 2015-03-17 09:39:00Z behrisch

6.67

src/sumo/include/utils/options/OptionsIO.h File Reference

#include <config.h>
#include <utils/common/UtilExceptions.h>

Classes
class OptionsIO
Helping methods for parsing of command line arguments and reading a configuration file.

6.67.1

Detailed Description

Author
Daniel Krajzewicz
Michael Behrisch
Date
Mon, 17 Dec 2001
Version

Id:
OptionsIO.h 18095 2015-03-17 09:39:00Z behrisch

6.68

src/sumo/include/utils/options/OptionsLoader.h File Reference

#include
#include
#include
#include
#include
#include

<config.h>
<xercesc/sax/HandlerBase.hpp>
<xercesc/sax/AttributeList.hpp>
<xercesc/sax/SAXParseException.hpp>
<xercesc/sax/SAXException.hpp>
<string>

Classes
class OptionsLoader
A SAX-Handler for loading options.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

6.69 src/sumo/include/utils/options/OptionsParser.h File Reference

6.68.1

Detailed Description

Author
Daniel Krajzewicz
Michael Behrisch
Date
Mon, 17 Dec 2001
Version

Id:
OptionsLoader.h 18095 2015-03-17 09:39:00Z behrisch

6.69

src/sumo/include/utils/options/OptionsParser.h File Reference

#include <config.h>

Classes
class OptionsParser
Parses command line arguments.

6.69.1

Detailed Description

Author
Daniel Krajzewicz
Jakob Erdmann
Michael Behrisch
Date
Mon, 17 Dec 2001
Version

Id:
OptionsParser.h 18095 2015-03-17 09:39:00Z behrisch

6.70

src/sumo/include/utils/traci/TraCIAPI.h File Reference

#include
#include
#include
#include
#include

<config.h>
<vector>
<string>
<foreign/tcpip/socket.h>
<utils/common/SUMOTime.h>

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

431

432

File Documentation

Classes
class TraCIAPI
C++ TraCI client API implementation.

struct TraCIAPI::TraCIPosition
A 3D-position.

struct TraCIAPI::TraCIColor
struct TraCIAPI::TraCIBoundary
A 3D-bounding box.

class TraCIAPI::TraCIPhase
class TraCIAPI::TraCILogic
class TraCIAPI::TraCILink
class TraCIAPI::TraCIScopeWrapper
An abstract interface for accessing type-dependent values.

class TraCIAPI::EdgeScope
Scope for interaction with edges.

class TraCIAPI::GUIScope
Scope for interaction with the gui.

class TraCIAPI::InductionLoopScope
Scope for interaction with inductive loops.

class TraCIAPI::JunctionScope
Scope for interaction with junctions.

class TraCIAPI::LaneScope
Scope for interaction with lanes.

class TraCIAPI::AreaScope
Scope for interaction with areal detectors.

class TraCIAPI::MeMeScope
Scope for interaction with multi entry/-exit detectors.

class TraCIAPI::POIScope
Scope for interaction with POIs.

class TraCIAPI::PolygonScope
Scope for interaction with polygons.

class TraCIAPI::RouteScope
Scope for interaction with routes.

class TraCIAPI::SimulationScope
Scope for interaction with the simulation.

class TraCIAPI::TrafficLightScope
Scope for interaction with traffic lights.

class TraCIAPI::VehicleTypeScope
Scope for interaction with vehicle types.

Macros
#define DEFAULT_VIEW "View #0"
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

6.71 src/sumo/include/utils/xml/GenericSAXHandler.h File Reference

6.70.1

Detailed Description

Author
Daniel Krajzewicz
Mario Krumnow
Michael Behrisch
Date
30.05.2012
Version

Id:
TraCIAPI.h 18095 2015-03-17 09:39:00Z behrisch
Author
Daniel Krajzewicz
Mario Krumnow
Jakob Erdmann
Michael Behrisch
Date
30.05.2012
Version

Id:
TraCIAPI.cpp 18095 2015-03-17 09:39:00Z behrisch

6.71

src/sumo/include/utils/xml/GenericSAXHandler.h File Reference

#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include

<config.h>
<string>
<map>
<stack>
<sstream>
<vector>
<xercesc/sax2/Attributes.hpp>
<xercesc/sax2/DefaultHandler.hpp>
<utils/common/UtilExceptions.h>
<utils/common/StringBijection.h>
"SUMOSAXAttributes.h"

Classes
class GenericSAXHandler
A handler which converts occuring elements and attributes into enums.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

433

434

File Documentation

6.71.1

Detailed Description

Author
Daniel Krajzewicz
Jakob Erdmann
Michael Behrisch

Date
Sept 2002

Version

Id:
GenericSAXHandler.h 18095 2015-03-17 09:39:00Z behrisch

6.72

src/sumo/include/utils/xml/SAXWeightsHandler.h File Reference

#include
#include
#include
#include

<config.h>
<string>
<utils/xml/SUMOSAXHandler.h>
<utils/common/SUMOTime.h>

Classes
class SAXWeightsHandler
An XML-handler for network weights.

class SAXWeightsHandler::EdgeFloatTimeLineRetriever
Interface for a class which obtains read weights for named edges.

class SAXWeightsHandler::ToRetrieveDefinition
Complete definition about what shall be retrieved and where to store it.

6.72.1

Detailed Description

Author
Daniel Krajzewicz
Jakob Erdmann
Michael Behrisch

Date
Fri, 30 Mar 2007

Version

Id:
SAXWeightsHandler.h 18095 2015-03-17 09:39:00Z behrisch
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

6.73 src/sumo/include/utils/xml/SUMORouteHandler.h File Reference

6.73

src/sumo/include/utils/xml/SUMORouteHandler.h File Reference

#include
#include
#include
#include
#include

<config.h>
<utils/common/IDSupplier.h>
<utils/common/SUMOTime.h>
<utils/vehicle/SUMOVehicleParameter.h>
<utils/xml/SUMOSAXHandler.h>

Classes
class SUMORouteHandler
Parser for routes during their loading.

6.73.1

Detailed Description

Author
Daniel Krajzewicz
Jakob Erdmann
Michael Behrisch
Date
Mon, 9 Jul 2001

Version

Id:
SUMORouteHandler.h 18095 2015-03-17 09:39:00Z behrisch

6.74

src/sumo/include/utils/xml/SUMORouteLoader.h File Reference

#include <config.h>
#include <utils/common/SUMOTime.h>

Classes
class SUMORouteLoader

6.74.1

Detailed Description

Author
Daniel Krajzewicz
Michael Behrisch
Date
Wed, 6 Nov 2002

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

435

436

File Documentation

Version

Id:
SUMORouteLoader.h 18095 2015-03-17 09:39:00Z behrisch

6.75

src/sumo/include/utils/xml/SUMORouteLoaderControl.h File Reference

#include <config.h>
#include <vector>

Classes
class SUMORouteLoaderControl
SUMORouteLoaderControl This controls is initialised with the list of route loaders and uses them to load routes step
wise.

6.75.1

Detailed Description

Author
Daniel Krajzewicz
Sascha Krieg
Michael Behrisch
Jakob Erdmann

Date
Wed, 06 Nov 2002

Version

Id:
SUMORouteLoaderControl.h 18095 2015-03-17 09:39:00Z behrisch

6.76

src/sumo/include/utils/xml/SUMOSAXAttributes.h File Reference

#include
#include
#include
#include
#include
#include
#include
#include

<config.h>
<string>
<vector>
<set>
<utils/common/SUMOTime.h>
<utils/common/ToString.h>
<utils/common/UtilExceptions.h>
"SUMOXMLDefinitions.h"

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

6.77 src/sumo/include/utils/xml/SUMOSAXAttributesImpl_Binary.h File Reference

Classes
class SUMOSAXAttributes
Encapsulated SAX-Attributes.

struct invalid_return< X >

Functions
std::ostream & operator<< (std::ostream &os, const SUMOSAXAttributes &src)

6.76.1

Detailed Description

Author
Daniel Krajzewicz
Jakob Erdmann
Michael Behrisch
Date
Fri, 30 Mar 2007

Version

Id:
SUMOSAXAttributes.h 18095 2015-03-17 09:39:00Z behrisch

6.77

src/sumo/include/utils/xml/SUMOSAXAttributesImpl_Binary.h File Reference

#include
#include
#include
#include

<config.h>
<map>
<set>
"SUMOSAXAttributes.h"

Classes
class SUMOSAXAttributesImpl_Binary
Encapsulated Xerces-SAX-attributes.

6.77.1

Detailed Description

Author
Daniel Krajzewicz
Jakob Erdmann
Michael Behrisch
Date
Fri, 30 Mar 2007

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

437

438

File Documentation

Version

Id:
SUMOSAXAttributesImpl_Binary.h 18095 2015-03-17 09:39:00Z behrisch

6.78

src/sumo/include/utils/xml/SUMOSAXAttributesImpl_Xerces.h File Reference

#include
#include
#include
#include
#include
#include
#include
#include

<config.h>
<string>
<map>
<iostream>
<xercesc/sax2/Attributes.hpp>
<utils/common/SUMOTime.h>
<utils/common/TplConvert.h>
"SUMOSAXAttributes.h"

Classes
class SUMOSAXAttributesImpl_Xerces
Encapsulated Xerces-SAX-attributes.

6.78.1

Detailed Description

Author
Daniel Krajzewicz
Jakob Erdmann
Michael Behrisch
Date
Fri, 30 Mar 2007
Version

Id:
SUMOSAXAttributesImpl_Xerces.h 18095 2015-03-17 09:39:00Z behrisch

6.79

src/sumo/include/utils/xml/SUMOSAXHandler.h File Reference

#include <config.h>
#include <string>
#include <utils/xml/GenericSAXHandler.h>

Classes
class SUMOSAXHandler
SAX-handler base for SUMO-files.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

6.80 src/sumo/include/utils/xml/SUMOSAXReader.h File Reference

6.79.1

Detailed Description

Author
Daniel Krajzewicz
Jakob Erdmann
Michael Behrisch

Date
Sept 2002

Version

Id:
SUMOSAXHandler.h 18095 2015-03-17 09:39:00Z behrisch

6.80

src/sumo/include/utils/xml/SUMOSAXReader.h File Reference

#include
#include
#include
#include

<config.h>
<xercesc/sax2/SAX2XMLReader.hpp>
<xercesc/sax/EntityResolver.hpp>
<xercesc/sax/InputSource.hpp>

Classes
class SUMOSAXReader
SAX-reader encapsulation containing binary reader.

6.80.1

Detailed Description

Author
Daniel Krajzewicz
Jakob Erdmann
Michael Behrisch

Date
Nov 2012

Version

Id:
SUMOSAXReader.h 18095 2015-03-17 09:39:00Z behrisch
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

439

440

File Documentation

6.81

src/sumo/include/utils/xml/SUMOVehicleParserHelper.h File Reference

#include
#include
#include
#include
#include
#include
#include
#include
#include
#include

<config.h>
<string>
<utils/xml/SUMOSAXHandler.h>
<utils/xml/SUMOXMLDefinitions.h>
<utils/common/SUMOTime.h>
<utils/common/SUMOVehicleClass.h>
<utils/vehicle/SUMOVehicleParameter.h>
<utils/vehicle/SUMOVTypeParameter.h>
<utils/common/UtilExceptions.h>
<utils/common/StdDefs.h>

Classes
class SUMOVehicleParserHelper
Helper methods for parsing vehicle attributes.

6.81.1

Detailed Description

Author
Daniel Krajzewicz
Jakob Erdmann
Michael Behrisch
Laura Bieker

Date
Mon, 07.04.2008

Version

Id:
SUMOVehicleParserHelper.h 18095 2015-03-17 09:39:00Z behrisch

6.82

src/sumo/include/utils/xml/SUMOXMLDefinitions.h File Reference

#include <config.h>
#include <utils/common/StringBijection.h>

Classes
class SUMOXMLDefinitions
class for maintaining associations between enums and xml-strings

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

6.82 src/sumo/include/utils/xml/SUMOXMLDefinitions.h File Reference

441

Enumerations
enum SumoXMLTag {
SUMO_TAG_NOTHING, SUMO_TAG_NET, SUMO_TAG_EDGE, SUMO_TAG_LANE,
SUMO_TAG_POI, SUMO_TAG_POLY, SUMO_TAG_JUNCTION, SUMO_TAG_E1DETECTOR,
SUMO_TAG_INDUCTION_LOOP, SUMO_TAG_E2DETECTOR, SUMO_TAG_LANE_AREA_DETECTOR,
SUMO_TAG_E3DETECTOR,
SUMO_TAG_ENTRY_EXIT_DETECTOR, SUMO_TAG_MEANDATA_EDGE, SUMO_TAG_MEANDATA_LANE, SUMO_TAG_DET_ENTRY,
SUMO_TAG_DET_EXIT, SUMO_TAG_EDGEFOLLOWDETECTOR, SUMO_TAG_INSTANT_INDUCTION_LOOP, SUMO_TAG_VSS,
SUMO_TAG_CALIBRATOR, SUMO_TAG_REROUTER, SUMO_TAG_BUS_STOP, SUMO_TAG_CONTAINER_STOP,
SUMO_TAG_VTYPEPROBE, SUMO_TAG_ROUTEPROBE, SUMO_TAG_ROUTES, SUMO_TAG_VEHICLE,
SUMO_TAG_VTYPE, SUMO_TAG_ROUTE, SUMO_TAG_REQUEST, SUMO_TAG_SOURCE,
SUMO_TAG_TAZ, SUMO_TAG_TAZSOURCE, SUMO_TAG_TAZSINK, SUMO_TAG_TLLOGIC,
SUMO_TAG_PHASE, SUMO_TAG_TRIP, SUMO_TAG_FLOW, SUMO_TAG_STEP,
SUMO_TAG_INTERVAL, SUMO_TAG_TIMEDEVENT, SUMO_TAG_FROMEDGE, SUMO_TAG_TOEDGE,
SUMO_TAG_SINK, SUMO_TAG_PARAM, SUMO_TAG_WAUT, SUMO_TAG_WAUT_SWITCH,
SUMO_TAG_WAUT_JUNCTION, SUMO_TAG_SEGMENT, SUMO_TAG_DELETE, SUMO_TAG_STOP,
SUMO_TAG_DEST_PROB_REROUTE, SUMO_TAG_CLOSING_REROUTE, SUMO_TAG_ROUTE_PROB_REROUTE, SUMO_TAG_POLYTYPE,
SUMO_TAG_CONNECTION, SUMO_TAG_PROHIBITION, SUMO_TAG_SPLIT, SUMO_TAG_NODE,
SUMO_TAG_TYPE, SUMO_TAG_DETECTOR_DEFINITION, SUMO_TAG_ROUTE_DISTRIBUTION, SUMO_TAG_VTYPE_DISTRIBUTION,
SUMO_TAG_VAPORIZER, SUMO_TAG_ROUNDABOUT, SUMO_TAG_JOIN, SUMO_TAG_JOINEXCLUDE,
SUMO_TAG_CROSSING, SUMO_TAG_CUSTOMSHAPE, SUMO_TAG_WAY, SUMO_TAG_ND,
SUMO_TAG_TAG, SUMO_TAG_RELATION, SUMO_TAG_MEMBER, SUMO_TAG_VIEWSETTINGS,
SUMO_TAG_VIEWSETTINGS_DECAL, SUMO_TAG_VIEWSETTINGS_LIGHT, SUMO_TAG_VIEWSETTINGS_SCHEME, SUMO_TAG_VIEWSETTINGS_OPENGL,
SUMO_TAG_VIEWSETTINGS_BACKGROUND, SUMO_TAG_VIEWSETTINGS_EDGES, SUMO_TAG_VIEWSETTINGS_VEHICLES, SUMO_TAG_VIEWSETTINGS_PERSONS,
SUMO_TAG_VIEWSETTINGS_CONTAINERS, SUMO_TAG_VIEWSETTINGS_JUNCTIONS, SUMO_TAG_VIEWSETTINGS_ADDITIONALS, SUMO_TAG_VIEWSETTINGS_POIS,
SUMO_TAG_VIEWSETTINGS_POLYS, SUMO_TAG_VIEWSETTINGS_LEGEND, SUMO_TAG_VIEWSETTINGS_EVENT, SUMO_TAG_VIEWSETTINGS_EVENT_JAM_TIME,
SUMO_TAG_INCLUDE, SUMO_TAG_DELAY, SUMO_TAG_VIEWPORT, SUMO_TAG_SNAPSHOT,
SUMO_TAG_BREAKPOINTS_FILE, SUMO_TAG_LOCATION, SUMO_TAG_COLORSCHEME, SUMO_TAG_SCALINGSCHEME,
SUMO_TAG_ENTRY, SUMO_TAG_CF_KRAUSS, SUMO_TAG_CF_KRAUSS_PLUS_SLOPE, SUMO_TAG_CF_KRAUSS_ACCEL_BOUND,
SUMO_TAG_CF_KRAUSS_ORIG1, SUMO_TAG_CF_SMART_SK, SUMO_TAG_CF_DANIEL1, SUMO_TAG_CF_IDM,
SUMO_TAG_CF_IDMM, SUMO_TAG_CF_PWAGNER2009, SUMO_TAG_CF_BKERNER, SUMO_TAG_CF_WIEDEMANN,
SUMO_TAG_PERSON, SUMO_TAG_RIDE, SUMO_TAG_WALK, SUMO_TAG_CONTAINER,
SUMO_TAG_TRANSPORT, SUMO_TAG_TRANSHIP, SUMO_TAG_TRAJECTORIES, SUMO_TAG_TIMESTEP,
SUMO_TAG_TIMESLICE, SUMO_TAG_ACTORCONFIG, SUMO_TAG_MOTIONSTATE, SUMO_TAG_OD_PAIR,
AGEN_TAG_GENERAL, AGEN_TAG_STREET, AGEN_TAG_WORKHOURS, AGEN_TAG_OPENING,
AGEN_TAG_CLOSING, AGEN_TAG_SCHOOLS, AGEN_TAG_SCHOOL, AGEN_TAG_BUSSTATION,
AGEN_TAG_BUSLINE, AGEN_TAG_STATIONS, AGEN_TAG_REV_STATIONS, AGEN_TAG_STATION,
AGEN_TAG_FREQUENCY, AGEN_TAG_POPULATION, AGEN_TAG_BRACKET, AGEN_TAG_CITYGATES,
AGEN_TAG_ENTRANCE, AGEN_TAG_PARAM }
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

442

File Documentation

Numbers representing SUMO-XML - element names.

enum SumoXMLAttr {
SUMO_ATTR_NOTHING, SUMO_ATTR_ID, SUMO_ATTR_REFID, SUMO_ATTR_NAME,
SUMO_ATTR_TYPE, SUMO_ATTR_PRIORITY, SUMO_ATTR_NUMLANES, SUMO_ATTR_SPEED,
SUMO_ATTR_ONEWAY, SUMO_ATTR_WIDTH, SUMO_ATTR_SIDEWALKWIDTH, SUMO_ATTR_REMOVE,
SUMO_ATTR_LENGTH, SUMO_ATTR_X, SUMO_ATTR_Y, SUMO_ATTR_Z,
SUMO_ATTR_CENTER_X, SUMO_ATTR_CENTER_Y, SUMO_ATTR_CENTER_Z, SUMO_ATTR_KEY,
SUMO_ATTR_REQUESTSIZE, SUMO_ATTR_REQUEST, SUMO_ATTR_RESPONSE, SUMO_ATTR_PROGRAMID,
SUMO_ATTR_OFFSET, SUMO_ATTR_ENDOFFSET, SUMO_ATTR_INCLANES, SUMO_ATTR_INTLANES,
SUMO_ATTR_WEIGHT, SUMO_ATTR_NODE, SUMO_ATTR_EDGE, SUMO_ATTR_EDGES,
SUMO_ATTR_DEPART, SUMO_ATTR_DEPARTLANE, SUMO_ATTR_DEPARTPOS, SUMO_ATTR_DEPARTSPEED,
SUMO_ATTR_ARRIVALLANE, SUMO_ATTR_ARRIVALPOS, SUMO_ATTR_ARRIVALSPEED, SUMO_ATTR_ROUTE,
SUMO_ATTR_MAXSPEED, SUMO_ATTR_ACCEL, SUMO_ATTR_DECEL, SUMO_ATTR_VCLASS,
SUMO_ATTR_REPNUMBER, SUMO_ATTR_SPEEDFACTOR, SUMO_ATTR_SPEEDDEV, SUMO_ATTR_LANE_CHANGE_MODEL,
SUMO_ATTR_MINGAP, SUMO_ATTR_BOARDING_DURATION, SUMO_ATTR_LOADING_DURATION,
SUMO_ATTR_SIGMA,
SUMO_ATTR_TAU, SUMO_ATTR_TMP1, SUMO_ATTR_TMP2, SUMO_ATTR_TMP3,
SUMO_ATTR_TMP4, SUMO_ATTR_TMP5, SUMO_ATTR_LAST, SUMO_ATTR_COST,
SUMO_ATTR_PROB, SUMO_ATTR_PROBS, SUMO_ATTR_ROUTES, SUMO_ATTR_VTYPES,
SUMO_ATTR_LANE, SUMO_ATTR_LANES, SUMO_ATTR_FROM, SUMO_ATTR_TO,
SUMO_ATTR_PERIOD, SUMO_ATTR_FROM_TAZ, SUMO_ATTR_TO_TAZ, SUMO_ATTR_REROUTE,
SUMO_ATTR_PERSON_CAPACITY, SUMO_ATTR_CONTAINER_CAPACITY, SUMO_ATTR_PERSON_NUMBER, SUMO_ATTR_CONTAINER_NUMBER,
SUMO_ATTR_FUNCTION, SUMO_ATTR_POSITION, SUMO_ATTR_FREQUENCY, SUMO_ATTR_STYLE,
SUMO_ATTR_FILE, SUMO_ATTR_JUNCTION, SUMO_ATTR_NUMBER, SUMO_ATTR_DURATION,
SUMO_ATTR_UNTIL, SUMO_ATTR_ROUTEPROBE, SUMO_ATTR_CROSSING_EDGES, SUMO_ATTR_TIME,
SUMO_ATTR_BEGIN, SUMO_ATTR_END, SUMO_ATTR_TLID, SUMO_ATTR_TLTYPE,
SUMO_ATTR_TLLINKINDEX, SUMO_ATTR_SHAPE, SUMO_ATTR_SPREADTYPE, SUMO_ATTR_RADIUS,
SUMO_ATTR_CUSTOMSHAPE, SUMO_ATTR_COLOR, SUMO_ATTR_DIR, SUMO_ATTR_STATE,
SUMO_ATTR_LAYER, SUMO_ATTR_FILL, SUMO_ATTR_PREFIX, SUMO_ATTR_DISCARD,
SUMO_ATTR_FROM_LANE, SUMO_ATTR_TO_LANE, SUMO_ATTR_DEST, SUMO_ATTR_SOURCE,
SUMO_ATTR_VIA, SUMO_ATTR_NODES, SUMO_ATTR_MINDURATION, SUMO_ATTR_MAXDURATION,
SUMO_ATTR_FOES, SUMO_ATTR_CONT, SUMO_ATTR_HALTING_TIME_THRESHOLD, SUMO_ATTR_HALTING_SPEED_THRESHOLD,
SUMO_ATTR_JAM_DIST_THRESHOLD, SUMO_ATTR_WAUT_ID, SUMO_ATTR_JUNCTION_ID, SUMO_ATTR_PROCEDURE,
SUMO_ATTR_SYNCHRON, SUMO_ATTR_REF_TIME, SUMO_ATTR_START_PROG, SUMO_ATTR_OFF,
SUMO_ATTR_FRIENDLY_POS, SUMO_ATTR_SPLIT_VTYPE, SUMO_ATTR_UNCONTROLLED, SUMO_ATTR_PASS,
SUMO_ATTR_BUS_STOP, SUMO_ATTR_CONTAINER_STOP, SUMO_ATTR_LINE, SUMO_ATTR_LINES,
SUMO_ATTR_VALUE, SUMO_ATTR_PROHIBITOR, SUMO_ATTR_PROHIBITED, SUMO_ATTR_ALLOW,
SUMO_ATTR_DISALLOW, SUMO_ATTR_PREFER, SUMO_ATTR_CONTROLLED_INNER, SUMO_ATTR_VEHSPERHOUR,
SUMO_ATTR_OUTPUT, SUMO_ATTR_HEIGHT, SUMO_ATTR_GUISHAPE, SUMO_ATTR_OSGFILE,
SUMO_ATTR_IMGFILE, SUMO_ATTR_ANGLE, SUMO_ATTR_EMISSIONCLASS, SUMO_ATTR_IMPAGenerated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

6.82 src/sumo/include/utils/xml/SUMOXMLDefinitions.h File Reference

443

TIENCE,
SUMO_ATTR_STARTPOS, SUMO_ATTR_ENDPOS, SUMO_ATTR_TRIGGERED, SUMO_ATTR_CONTAINER_TRIGGERED,
SUMO_ATTR_PARKING, SUMO_ATTR_EXPECTED, SUMO_ATTR_EXPECTED_CONTAINERS, SUMO_ATTR_INDEX,
SUMO_ATTR_ENTERING, SUMO_ATTR_EXCLUDE_EMPTY, SUMO_ATTR_WITH_INTERNAL, SUMO_ATTR_TRACK_VEHICLES,
SUMO_ATTR_MAX_TRAVELTIME, SUMO_ATTR_MIN_SAMPLES, SUMO_ATTR_LON, SUMO_ATTR_LAT,
SUMO_ATTR_GEO, SUMO_ATTR_K, SUMO_ATTR_V, SUMO_ATTR_REF,
SUMO_ATTR_HREF, SUMO_ATTR_ZOOM, SUMO_ATTR_INTERPOLATED, SUMO_ATTR_THRESHOLD,
SUMO_ATTR_NET_OFFSET, SUMO_ATTR_CONV_BOUNDARY, SUMO_ATTR_ORIG_BOUNDARY, SUMO_ATTR_ORIG_PROJ,
SUMO_ATTR_CF_PWAGNER2009_TAULAST, SUMO_ATTR_CF_PWAGNER2009_APPROB, SUMO_ATTR_CF_IDM_DELTA, SUMO_ATTR_CF_IDM_STEPPING,
SUMO_ATTR_CF_IDMM_ADAPT_FACTOR, SUMO_ATTR_CF_IDMM_ADAPT_TIME, SUMO_ATTR_CF_KERNER_PHI, SUMO_ATTR_CF_WIEDEMANN_SECURITY,
SUMO_ATTR_CF_WIEDEMANN_ESTIMATION, SUMO_ATTR_GENERATE_WALKS, SUMO_ATTR_ACTTYPE, SUMO_ATTR_SLOPE,
SUMO_ATTR_VERSION, SUMO_ATTR_COMMAND, SUMO_ATTR_ACTORCONFIG, SUMO_ATTR_VEHICLE,
SUMO_ATTR_STARTTIME, SUMO_ATTR_VEHICLECLASS, SUMO_ATTR_FUEL, SUMO_ATTR_ACCELERATION,
SUMO_ATTR_AMOUNT, SUMO_ATTR_ORIGIN, SUMO_ATTR_DESTINATION, AGEN_ATTR_INHABITANTS,
AGEN_ATTR_HOUSEHOLDS, AGEN_ATTR_CHILDREN, AGEN_ATTR_RETIREMENT, AGEN_ATTR_CARS,
AGEN_ATTR_UNEMPLOYEMENT, AGEN_ATTR_MAX_FOOT_DIST, AGEN_ATTR_IN_TRAFFIC, AGEN_ATTR_OUT_TRAFFIC,
AGEN_ATTR_POPULATION, AGEN_ATTR_OUT_WORKPOSITION, AGEN_ATTR_HOUR, AGEN_ATTR_PROP,
AGEN_ATTR_CAPACITY, AGEN_ATTR_OPENING, AGEN_ATTR_CLOSING, AGEN_ATTR_MAX_TRIP_DURATION,
AGEN_ATTR_RATE, AGEN_ATTR_BEGINAGE, AGEN_ATTR_ENDAGE, AGEN_ATTR_PEOPLENBR,
AGEN_ATTR_CARPREF, AGEN_ATTR_CITYSPEED, AGEN_ATTR_FREETIMERATE, AGEN_ATTR_UNI_RAND_TRAFFIC,
AGEN_ATTR_DEP_VARIATION, AGEN_ATTR_INCOMING, AGEN_ATTR_OUTGOING, GNE_ATTR_MODIFICATION_STATUS,
GNE_ATTR_SHAPE_START, GNE_ATTR_SHAPE_END }
Numbers representing SUMO-XML - attributes.

enum SumoXMLNodeType {
NODETYPE_UNKNOWN, NODETYPE_TRAFFIC_LIGHT, NODETYPE_TRAFFIC_LIGHT_NOJUNCTION,
NODETYPE_RAIL_SIGNAL,
NODETYPE_PRIORITY, NODETYPE_PRIORITY_STOP, NODETYPE_RIGHT_BEFORE_LEFT, NODETYPE_ALLWAY_STOP,
NODETYPE_DISTRICT, NODETYPE_NOJUNCTION, NODETYPE_INTERNAL, NODETYPE_DEAD_END,
NODETYPE_DEAD_END_DEPRECATED }
Numbers representing special SUMO-XML-attribute values for representing node- (junction-) types used in netbuild/netimport and netload.

enum SumoXMLEdgeFunc {
EDGEFUNC_NORMAL, EDGEFUNC_CONNECTOR, EDGEFUNC_SINK, EDGEFUNC_SOURCE,
EDGEFUNC_CROSSING, EDGEFUNC_WALKINGAREA, EDGEFUNC_INTERNAL }
Numbers representing special SUMO-XML-attribute values for representing edge functions used in netbuild/netimport
and netload.

enum LaneSpreadFunction { LANESPREAD_RIGHT, LANESPREAD_CENTER }


Numbers representing special SUMO-XML-attribute values Information how the edges lateral offset shall be computed In dependence to this value, lanes will be spread to the right side or to both sides from the given edge geometry
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

444

File Documentation

(Also used when node positions are used as edge geometry).

enum LinkState {
LINKSTATE_TL_GREEN_MAJOR = G, LINKSTATE_TL_GREEN_MINOR = g, LINKSTATE_TL_RED = r,
LINKSTATE_TL_REDYELLOW = u,
LINKSTATE_TL_YELLOW_MAJOR = Y, LINKSTATE_TL_YELLOW_MINOR = y, LINKSTATE_TL_OFF_BLINKING = o, LINKSTATE_TL_OFF_NOSIGNAL = O,
LINKSTATE_MAJOR = M, LINKSTATE_MINOR = m, LINKSTATE_EQUAL = =, LINKSTATE_STOP = s,
LINKSTATE_ALLWAY_STOP = w, LINKSTATE_DEADEND = - }
The right-of-way state of a link between two lanes used when constructing a NBTrafficLightLogic, in MSLink and
GNEInternalLane.

enum LinkDirection {
LINKDIR_STRAIGHT = 0, LINKDIR_TURN, LINKDIR_LEFT, LINKDIR_RIGHT,
LINKDIR_PARTLEFT, LINKDIR_PARTRIGHT, LINKDIR_NODIR }
The different directions a link between two lanes may take (or a stream between two edges).

enum TrafficLightType { TLTYPE_STATIC, TLTYPE_RAIL, TLTYPE_ACTUATED }


enum LaneChangeModel { LCM_DK2008, LCM_LC2013, LCM_JE2013 }

6.82.1

Detailed Description

Author
Daniel Krajzewicz
Jakob Erdmann
Clemens Honomichl
Piotr Woznica
Michael Behrisch
Walter Bamberger
Date
Sept 2002
Version

Id:
SUMOXMLDefinitions.h 18096 2015-03-17 09:50:59Z behrisch

6.82.2

Enumeration Type Documentation

6.82.2.1

enum LinkDirection

The different directions a link between two lanes may take (or a stream between two edges).
used in netbuild (formerly NBMMLDirection) and MSLink
Enumerator
LINKDIR_STRAIGHT The link is a straight direction.
LINKDIR_TURN The link is a 180 degree turn.
LINKDIR_LEFT The link is a (hard) left direction.
LINKDIR_RIGHT The link is a (hard) right direction.
LINKDIR_PARTLEFT The link is a partial left direction.
LINKDIR_PARTRIGHT The link is a partial right direction.
LINKDIR_NODIR The link has no direction (is a dead end link)

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

6.82 src/sumo/include/utils/xml/SUMOXMLDefinitions.h File Reference

6.82.2.2

445

enum LinkState

The right-of-way state of a link between two lanes used when constructing a NBTrafficLightLogic, in MSLink and
GNEInternalLane.
This enumerations holds the possible right-of-way rules a link may have. Beyond the righ-of-way rules, this enumeration also holds the possible traffic light states.
enum values are assigned so that chars can be cast back to linkstates
Todo fix redundancy
Enumerator
LINKSTATE_TL_GREEN_MAJOR The link has green light, may pass.
LINKSTATE_TL_GREEN_MINOR The link has green light, has to brake.
LINKSTATE_TL_RED The link has red light (must brake)
LINKSTATE_TL_REDYELLOW The link has red light (must brake) but indicates upcoming green.
LINKSTATE_TL_YELLOW_MAJOR The link has yellow light, may pass.
LINKSTATE_TL_YELLOW_MINOR The link has yellow light, has to brake anyway.
LINKSTATE_TL_OFF_BLINKING The link is controlled by a tls which is off and blinks, has to brake.
LINKSTATE_TL_OFF_NOSIGNAL The link is controlled by a tls which is off, not blinking, may pass.
LINKSTATE_MAJOR This is an uncontrolled, major link, may pass.
LINKSTATE_MINOR This is an uncontrolled, minor link, has to brake.
LINKSTATE_EQUAL This is an uncontrolled, right-before-left link.
LINKSTATE_STOP This is an uncontrolled, minor link, has to stop.
LINKSTATE_ALLWAY_STOP This is an uncontrolled, all-way stop link.
LINKSTATE_DEADEND This is a dead end link.

6.82.2.3

enum SumoXMLAttr

Numbers representing SUMO-XML - attributes.


See Also
GenericSAXHandler
SUMOSAXHandler
Enumerator
SUMO_ATTR_NOTHING invalid attribute
SUMO_ATTR_WEIGHT the weight of a districts source or sink
SUMO_ATTR_EDGES the edges of a route
SUMO_ATTR_TIME trigger: the time of the step
SUMO_ATTR_BEGIN weights: time range begin
SUMO_ATTR_END weights: time range end
SUMO_ATTR_TLID link,node: the traffic light id responsible for this link
SUMO_ATTR_TLTYPE node: the type of traffic light
SUMO_ATTR_TLLINKINDEX link: the index of the link within the traffic light
SUMO_ATTR_SHAPE edge: the shape in xml-definition
SUMO_ATTR_SPREADTYPE The information about how to spread the lanes from the given position.
SUMO_ATTR_RADIUS The turning radius at an intersection in m.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

446

File Documentation

SUMO_ATTR_CUSTOMSHAPE whether a given shape is user-defined


SUMO_ATTR_COLOR A color information.
SUMO_ATTR_DIR The abstract direction of a link.
SUMO_ATTR_STATE The state of a link.
SUMO_ATTR_LAYER A layer number.
SUMO_ATTR_FILL Fill the polygon.
SUMO_ATTR_NODES a list of node ids, used for controlling joining
SUMO_ATTR_MINDURATION minimum duration of a phase
SUMO_ATTR_MAXDURATION maximum duration of a phase
SUMO_ATTR_FOES Information within the junction logic which internal lanes block external.
SUMO_ATTR_CONT Information whether the detector shall be continued on the folowing lanes.
AGEN_ATTR_INHABITANTS ActivityGen Tags.

6.82.2.4

enum SumoXMLTag

Numbers representing SUMO-XML - element names.


See Also
GenericSAXHandler
SUMOSAXHandler
Enumerator
SUMO_TAG_NOTHING invalid tag
SUMO_TAG_NET root element of a network file
SUMO_TAG_EDGE begin/end of the description of an edge
SUMO_TAG_LANE begin/end of the description of a single lane
SUMO_TAG_POI begin/end of the description of a polygon
SUMO_TAG_POLY begin/end of the description of a polygon
SUMO_TAG_JUNCTION begin/end of the description of a junction
SUMO_TAG_E1DETECTOR an e1 detector
SUMO_TAG_E2DETECTOR an e2 detector
SUMO_TAG_E3DETECTOR an e3 detector
SUMO_TAG_MEANDATA_EDGE an edge based mean data detector
SUMO_TAG_MEANDATA_LANE a lane based mean data detector
SUMO_TAG_DET_ENTRY an e3 entry point
SUMO_TAG_DET_EXIT an e3 exit point
SUMO_TAG_EDGEFOLLOWDETECTOR An edge-following detector.
SUMO_TAG_INSTANT_INDUCTION_LOOP An instantenous induction loop.
SUMO_TAG_VSS A variable speed sign.
SUMO_TAG_CALIBRATOR A calibrator.
SUMO_TAG_REROUTER A rerouter.
SUMO_TAG_BUS_STOP A bus stop.
SUMO_TAG_CONTAINER_STOP A container stop.
SUMO_TAG_VTYPEPROBE a vtypeprobe detector
SUMO_TAG_ROUTEPROBE a routeprobe detector
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

6.83 src/sumo/include/utils/xml/XMLSubSys.h File Reference

SUMO_TAG_ROUTES root element of a route file


SUMO_TAG_VEHICLE description of a vehicle
SUMO_TAG_VTYPE description of a vehicle type
SUMO_TAG_ROUTE begin/end of the description of a route
SUMO_TAG_REQUEST description of a logic request within the junction
SUMO_TAG_SOURCE a source
SUMO_TAG_TAZ a traffic assignment zone
SUMO_TAG_TAZSOURCE a source within a district (connection road)
SUMO_TAG_TAZSINK a sink within a district (connection road)
SUMO_TAG_TLLOGIC a traffic light logic
SUMO_TAG_PHASE a single phase description
SUMO_TAG_TRIP a single trip definition (used by router)
SUMO_TAG_FLOW a flow definition (used by router)
SUMO_TAG_STEP trigger: a step description
SUMO_TAG_INTERVAL an aggreagated-output interval
SUMO_TAG_TIMEDEVENT The definition of a periodic event.
SUMO_TAG_FROMEDGE Incoming edge specification (jtrrouter)
SUMO_TAG_TOEDGE Outgoing edge specification (jtrrouter)
SUMO_TAG_SINK Sink(s) specification.
AGEN_TAG_GENERAL ActivityGen Tags.

6.83

src/sumo/include/utils/xml/XMLSubSys.h File Reference

#include <config.h>
#include <vector>
#include <xercesc/sax2/SAX2XMLReader.hpp>

Classes
class XMLSubSys
Utility methods for initialising, closing and using the XML-subsystem.

6.83.1

Detailed Description

Author
Daniel Krajzewicz
Michael Behrisch
Date
Mon, 1 Jul 2002

Version

Id:
XMLSubSys.h 18095 2015-03-17 09:39:00Z behrisch
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

447

448

File Documentation

6.84

src/sumo/src/utils/common/FileHelpers.cpp File Reference

#include
#include
#include
#include
#include
#include
#include

6.84.1

<config.h>
<string>
<unistd.h>
<fstream>
"FileHelpers.h"
"StringTokenizer.h"
"MsgHandler.h"

Detailed Description

Author
Daniel Krajzewicz
Michael Behrisch
Date
Mon, 17 Dec 2001
Version

Id:
FileHelpers.cpp 18096 2015-03-17 09:50:59Z behrisch

6.85

src/sumo/src/utils/common/IDSupplier.cpp File Reference

#include
#include
#include
#include
#include

6.85.1

<config.h>
<string>
<sstream>
"StdDefs.h"
"IDSupplier.h"

Detailed Description

Author
Daniel Krajzewicz
Jakob Erdmann
Michael Behrisch
Date
Sept 2002
Version

Id:
IDSupplier.cpp 18095 2015-03-17 09:39:00Z behrisch
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

6.86 src/sumo/src/utils/common/MsgHandler.cpp File Reference

6.86

src/sumo/src/utils/common/MsgHandler.cpp File Reference

#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include

6.86.1

<config.h>
<string>
<cassert>
<vector>
<algorithm>
<iostream>
"MsgHandler.h"
<utils/options/OptionsCont.h>
<utils/iodevices/OutputDevice.h>
<utils/common/UtilExceptions.h>
"AbstractMutex.h"

Detailed Description

Author
Daniel Krajzewicz
Michael Behrisch
Date
Tue, 17 Jun 2003

Version

Id:
MsgHandler.cpp 18095 2015-03-17 09:39:00Z behrisch

6.87

src/sumo/src/utils/common/Parameterised.cpp File Reference

#include <config.h>
#include "Parameterised.h"

6.87.1

Detailed Description

Author
Daniel Krajzewicz

Date
Sept 2002

Version

Id:
Parameterised.cpp 18137 2015-03-24 15:12:38Z behrisch
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

449

450

File Documentation

6.88

src/sumo/src/utils/common/RandHelper.cpp File Reference

#include
#include
#include
#include
#include
#include

6.88.1

<config.h>
<utils/options/OptionsCont.h>
<utils/common/SysUtils.h>
"RandHelper.h"
<ctime>
<cmath>

Detailed Description

Author
Daniel Krajzewicz
Michael Behrisch
Date
Tue, 29.05.2005
Version

Id:
RandHelper.cpp 18095 2015-03-17 09:39:00Z behrisch

6.89

src/sumo/src/utils/common/RGBColor.cpp File Reference

#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include

<config.h>
<cmath>
<cassert>
<string>
<sstream>
<utils/common/StringTokenizer.h>
<utils/common/ToString.h>
<utils/common/TplConvert.h>
<utils/common/MsgHandler.h>
<utils/common/StdDefs.h>
"RGBColor.h"

Functions
std::ostream & operator<< (std::ostream &os, const RGBColor &col)

6.89.1

Detailed Description

Author
Daniel Krajzewicz
Jakob Erdmann
Michael Behrisch
Laura Bieker

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

6.90 src/sumo/src/utils/common/StdDefs.cpp File Reference


Date
Sept 2002
Version

Id:
RGBColor.cpp 18095 2015-03-17 09:39:00Z behrisch

6.89.2

Function Documentation

6.89.2.1

std::ostream& operator<< ( std::ostream & os, const RGBColor & col )

Parameters
os
col

out
in

The stream to write to


The color to write

Returns
The stream

6.90

src/sumo/src/utils/common/StdDefs.cpp File Reference

#include "RGBColor.h"
#include "StdDefs.h"

Functions
const RGBColor & getLinkColor (const LinkState &ls)
const std::string getBuildName (const std::string &version)
attach some build flags to the version string

Variables

const RGBColor SUMO_color_TL_GREEN_MAJOR (0, 255, 0)


const RGBColor SUMO_color_TL_GREEN_MINOR (0, 179, 0)
const RGBColor SUMO_color_TL_RED (255, 0, 0)
const RGBColor SUMO_color_TL_REDYELLOW (255, 128, 0)
const RGBColor SUMO_color_TL_YELLOW_MAJOR (255, 255, 0)
const RGBColor SUMO_color_TL_YELLOW_MINOR (255, 255, 0)
const RGBColor SUMO_color_TL_OFF_BLINKING (128, 64, 0)
const RGBColor SUMO_color_TL_OFF_NOSIGNAL (0, 255, 255)
const RGBColor SUMO_color_MAJOR (255, 255, 255)
const RGBColor SUMO_color_MINOR (51, 51, 51)
const RGBColor SUMO_color_EQUAL (128, 128, 128)
const RGBColor SUMO_color_STOP (128, 0, 128)
const RGBColor SUMO_color_ALLWAY_STOP (0, 0, 192)
const RGBColor SUMO_color_DEADEND (0, 0, 0)
bool gDebugFlag1 = false
global utility flags for debugging

bool gDebugFlag2 = false


Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

451

452

File Documentation

6.90.1

Detailed Description

Author
Jakob Erdmann
Michael Behrisch
Laura Bieker
Date
2014-01-07
Version

Id:
StdDefs.cpp 18095 2015-03-17 09:39:00Z behrisch

6.91

src/sumo/src/utils/common/StringTokenizer.cpp File Reference

#include
#include
#include
#include
#include
#include

6.91.1

<config.h>
<string>
<vector>
<iostream>
"UtilExceptions.h"
"StringTokenizer.h"

Detailed Description

Author
Daniel Krajzewicz
Jakob Erdmann
Michael Behrisch
Date
?
Version

Id:
StringTokenizer.cpp 18095 2015-03-17 09:39:00Z behrisch

6.92

src/sumo/src/utils/common/StringUtils.cpp File Reference

#include
#include
#include
#include
#include
#include
#include
#include

<config.h>
<string>
<iostream>
<cstdio>
<utils/common/UtilExceptions.h>
<utils/common/TplConvert.h>
<utils/common/ToString.h>
"StringUtils.h"
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

6.93 src/sumo/src/utils/common/SUMOVehicleClass.cpp File Reference

6.92.1

453

Detailed Description

Author
Daniel Krajzewicz
Laura Bieker
Michael Behrisch

Date
unknown

Version

Id:
StringUtils.cpp 18095 2015-03-17 09:39:00Z behrisch

6.93

src/sumo/src/utils/common/SUMOVehicleClass.cpp File Reference

#include
#include
#include
#include
#include
#include
#include
#include

<config.h>
<string>
<map>
"SUMOVehicleClass.h"
<utils/common/TplConvert.h>
<utils/common/ToString.h>
<utils/common/MsgHandler.h>
<utils/common/StringTokenizer.h>

Functions
std::string getVehicleClassCompoundName (int id)
std::string getVehicleClassNames (SVCPermissions permissions)
Returns the ids of the given classes, divided using a .

std::vector< std::string > getVehicleClassNamesList (SVCPermissions permissions)


Returns the ids of the given classes, divided using a .

SUMOVehicleClass getVehicleClassID (const std::string &name)


Returns the class id of the abstract class given by its name.

int getVehicleClassCompoundID (const std::string &name)


Returns the ORed id of the compound class given by its name.

SVCPermissions parseVehicleClasses (const std::string &allowedS)


Parses the given definition of allowed vehicle classes into the given containers Deprecated classes go into a separate
container.

bool canParseVehicleClasses (const std::string &classes)


Checks whether the given string contains only known vehicle classes.

SVCPermissions parseVehicleClasses (const std::string &allowedS, const std::string &disallowedS)


Encodes the given vector of allowed and disallowed classes into a bitset.

SVCPermissions parseVehicleClasses (const std::vector< std::string > &allowedS)


Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

454

File Documentation

Encodes the given vector of allowed classs into a bitset Unlike the methods which parse a string it gives immediately
a warning output on deprecated vehicle classes.

SUMOVehicleShape getVehicleShapeID (const std::string &name)


Returns the class id of the shape class given by its name.

std::string getVehicleShapeName (SUMOVehicleShape id)


Returns the class name of the shape class given by its id.

bool isRailway (SVCPermissions permissions)


Returns whether an edge with the given permission is a railway edge.

bool isWaterway (SVCPermissions permissions)


Returns whether an edge with the given permission is a waterway edge.

bool isForbidden (SVCPermissions permissions)


Returns whether an edge with the given permission is a forbidden edge.

const std::string DEFAULT_VTYPE_ID ("DEFAULT_VEHTYPE")


const std::string DEFAULT_PEDTYPE_ID ("DEFAULT_PEDTYPE")
const SUMOReal DEFAULT_VEH_PROB (1.)
const SUMOReal DEFAULT_PEDESTRIAN_SPEED (5./3.6)
const SUMOReal DEFAULT_CONTAINER_TRANSHIP_SPEED (5./3.6)

Variables
StringBijection
< SUMOVehicleClass >::Entry sumoVehicleClassStringInitializer [ ]
StringBijection< SUMOVehicleClass > SumoVehicleClassStrings (sumoVehicleClassStringInitializer, SVC_CUSTOM2, false)
std::set< std::string > deprecatedVehicleClassesSeen
StringBijection
< SUMOVehicleShape >::Entry sumoVehicleShapeStringInitializer [ ]
StringBijection< SUMOVehicleShape > SumoVehicleShapeStrings (sumoVehicleShapeStringInitializer, SVS_UNKNOWN, false)
const int SUMOVehicleClass_MAX = SVC_CUSTOM2
const SVCPermissions SVCAll = 2 SUMOVehicleClass_MAX - 1
const SVCPermissions SVC_UNSPECIFIED = -1

6.93.1

Detailed Description

Author
Daniel Krajzewicz
Jakob Erdmann
Michael Behrisch
Walter Bamberger

Date
2006-01-24

Version

Id:
SUMOVehicleClass.cpp 18095 2015-03-17 09:39:00Z behrisch
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

6.93 src/sumo/src/utils/common/SUMOVehicleClass.cpp File Reference

6.93.2

Function Documentation

6.93.2.1

int getVehicleClassCompoundID ( const std::string & name )

Returns the ORed id of the compound class given by its name.

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

455

456

File Documentation

Parameters
name

in

The name of the abstract vehicle class

Returns
The ORed combination of base enum values

6.93.2.2 SUMOVehicleClass getVehicleClassID ( const std::string & name )


Returns the class id of the abstract class given by its name.
Parameters
name

in

The name of the abstract vehicle class

Returns
The internal representation of this class. Name must not be a compound name

6.93.2.3

std::string getVehicleClassNames ( SVCPermissions permissions )

Returns the ids of the given classes, divided using a .


Parameters
the

in

permissions to encode

Returns
The string representation of these classes

6.93.2.4

std::vector<std::string> getVehicleClassNamesList ( SVCPermissions permissions )

Returns the ids of the given classes, divided using a .


Parameters

in

the

permissions to encode

Returns
The string representation of these classes as a vector
Todo cache values?

6.93.2.5 SUMOVehicleShape getVehicleShapeID ( const std::string & name )


Returns the class id of the shape class given by its name.
Parameters

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

6.93 src/sumo/src/utils/common/SUMOVehicleClass.cpp File Reference

name

in

457

The name of the shape class

Returns
The internal representation of this class

6.93.2.6

std::string getVehicleShapeName ( SUMOVehicleShape id )

Returns the class name of the shape class given by its id.
Parameters
id

in

The id of the shape class

Returns
The string representation of this class

6.93.2.7

bool isForbidden ( SVCPermissions permissions )

Returns whether an edge with the given permission is a forbidden edge.


Parameters
permissions

in

The permissions of the edge

Returns
Whether the edge is forbidden

6.93.2.8

bool isRailway ( SVCPermissions permissions )

Returns whether an edge with the given permission is a railway edge.


Parameters
permissions

in

The permissions of the edge

Returns
Whether the edge is a railway edge

6.93.2.9

bool isWaterway ( SVCPermissions permissions )

Returns whether an edge with the given permission is a waterway edge.


Parameters

in

permissions

The permissions of the edge

Returns
Whether the edge is a waterway edge

6.93.2.10

SVCPermissions parseVehicleClasses ( const std::string & allowedS )

Parses the given definition of allowed vehicle classes into the given containers Deprecated classes go into a separate container.
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

458

File Documentation

Parameters
classNames
container

in
out

6.93.2.11

Space separated class names


The set of vehicle classes to fill throws ProcessError if parsing fails

SVCPermissions parseVehicleClasses ( const std::string & allowedS, const std::string & disallowedS )

Encodes the given vector of allowed and disallowed classes into a bitset.
Parameters
allowedS
disallowedS

in
in

Definition which classes are allowed


Definition which classes are not allowed

SVCPermissions parseVehicleClasses ( const std::vector< std::string > & allowedS )

6.93.2.12

Encodes the given vector of allowed classs into a bitset Unlike the methods which parse a string it gives immediately
a warning output on deprecated vehicle classes.
Parameters
classesS

in

6.94

The names vector to parse

src/sumo/src/utils/common/SystemFrame.cpp File Reference

#include
#include
#include
#include
#include
#include
#include
#include

6.94.1

<config.h>
"SystemFrame.h"
<string>
<utils/xml/XMLSubSys.h>
<utils/common/MsgHandler.h>
<utils/options/OptionsCont.h>
<utils/iodevices/OutputDevice.h>
"RandHelper.h"

Detailed Description

Author
Daniel Krajzewicz
Jakob Erdmann
Michael Behrisch

Date
Mon, 23.06.2003

Version

Id:
SystemFrame.cpp 18095 2015-03-17 09:39:00Z behrisch
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

6.95 src/sumo/src/utils/common/SysUtils.cpp File Reference

6.95

src/sumo/src/utils/common/SysUtils.cpp File Reference

#include
#include
#include
#include

6.95.1

<config.h>
<stdlib.h>
"SysUtils.h"
<sys/time.h>

Detailed Description

Author
Daniel Krajzewicz
Jakob Erdmann

Date
Tue, 29.05.2005

Version

Id:
SysUtils.cpp 18095 2015-03-17 09:39:00Z behrisch

6.96

src/tlc_package/include/tlc_package/control_stream_ddos.hpp File Reference

This file declares the control_stream_ddos class;.

#include "node/Component.hpp"
#include "tlc_package/ryg_control.h"
#include "pnp2/sender.hpp"

Classes
class control_stream_ddos
Component Message and Service Headers.

6.96.1

Detailed Description

This file declares the control_stream_ddos class;.


Author

Date
2016-04-20T18:05:53-05:00
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

459

460

File Documentation

6.97

src/tlc_package/include/tlc_package/controller.hpp File Reference

This file declares the controller class;.

#include
#include
#include
#include

"node/Component.hpp"
"tlc_package/ryg_control.h"
"tlc_package/sensor_state.h"
"tlc_package/ryg_state.h"

Classes
class controller
Component Message and Service Headers.

6.97.1

Detailed Description

This file declares the controller class;.


Author

Date
2016-04-20T18:05:53-05:00

6.98

src/tlc_package/include/tlc_package/e3_sensor.hpp File Reference

This file declares the e3_sensor class;.

#include "node/Component.hpp"
#include "tlc_package/sensor_state.h"
#include "tlc_package/e3_get_vehicle_number.h"

Classes
class e3_sensor
Component Message and Service Headers.

6.98.1

Detailed Description

This file declares the e3_sensor class;.


Author

Date
2016-04-20T18:05:53-05:00
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

6.99 src/tlc_package/include/tlc_package/e3_sensor_stream_ddos.hpp File Reference

6.99

461

src/tlc_package/include/tlc_package/e3_sensor_stream_ddos.hpp File Reference

This file declares the e3_sensor_stream_ddos class;.

#include "node/Component.hpp"
#include "tlc_package/sensor_state.h"
#include "pnp2/sender.hpp"

Classes
class e3_sensor_stream_ddos
Component Message and Service Headers.

6.99.1

Detailed Description

This file declares the e3_sensor_stream_ddos class;.


Author

Date
2016-04-20T18:05:53-05:00

6.100

src/tlc_package/include/tlc_package/sumo_intf.hpp File Reference

This file declares the sumo_intf class;.

#include
#include
#include
#include
#include

"node/Component.hpp"
"tlc_package/tlc_get_ryg_state.h"
"tlc_package/tlc_set_ryg_state.h"
"tlc_package/e3_get_vehicle_number.h"
"sumo/sumo_client.hpp"

Classes
class sumo_intf
Component Message and Service Headers.

6.100.1

Detailed Description

This file declares the sumo_intf class;.


Author

Date
2016-04-20T18:05:53-05:00
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

462

File Documentation

6.101

src/tlc_package/include/tlc_package/tl_actuator.hpp File Reference

This file declares the tl_actuator class;.

#include "node/Component.hpp"
#include "tlc_package/ryg_control.h"
#include "tlc_package/tlc_set_ryg_state.h"

Classes
class tl_actuator
Component Message and Service Headers.

6.101.1

Detailed Description

This file declares the tl_actuator class;.


Author

Date
2016-04-20T18:05:53-05:00

6.102

src/tlc_package/include/tlc_package/tl_sensor.hpp File Reference

This file declares the tl_sensor class;.

#include "node/Component.hpp"
#include "tlc_package/ryg_state.h"
#include "tlc_package/tlc_get_ryg_state.h"

Classes
class tl_sensor
Component Message and Service Headers.

6.102.1

Detailed Description

This file declares the tl_sensor class;.


Author

Date
2016-04-20T18:05:53-05:00
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

6.103 src/tlc_package/include/tlc_package/tl_sensor_stream_ddos.hpp File Reference

6.103

src/tlc_package/include/tlc_package/tl_sensor_stream_ddos.hpp File Reference

This file declares the tl_sensor_stream_ddos class;.

#include "node/Component.hpp"
#include "tlc_package/ryg_state.h"
#include "pnp2/sender.hpp"

Classes
class tl_sensor_stream_ddos
Component Message and Service Headers.

6.103.1

Detailed Description

This file declares the tl_sensor_stream_ddos class;.


Author

Date
2016-04-20T18:05:53-05:00

6.104

src/tlc_package/src/tlc_package/control_stream_ddos.cpp File Reference

This file contains definitions for the control_stream_ddos class;.

#include "tlc_package/control_stream_ddos.hpp"

Functions
Component maker (ComponentConfig &config, int argc, char argv)

6.104.1

Detailed Description

This file contains definitions for the control_stream_ddos class;.


Author

Date
2016-04-20T18:05:53-05:00

6.105

463

src/tlc_package/src/tlc_package/controller.cpp File Reference

This file contains definitions for the controller class;.

#include "tlc_package/controller.hpp"

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

464

File Documentation

Functions
Component maker (ComponentConfig &config, int argc, char argv)

Variables
std::string NSGREEN
std::string WEGREEN
int step = 0

6.105.1

Detailed Description

This file contains definitions for the controller class;.


Author

Date
2016-04-20T18:05:53-05:00

6.106

src/tlc_package/src/tlc_package/e3_sensor.cpp File Reference

This file contains definitions for the e3_sensor class;.

#include "tlc_package/e3_sensor.hpp"

Functions
Component maker (ComponentConfig &config, int argc, char argv)

6.106.1

Detailed Description

This file contains definitions for the e3_sensor class;.


Author

Date
2016-04-20T18:05:53-05:00

6.107

src/tlc_package/src/tlc_package/e3_sensor_stream_ddos.cpp File Reference

This file contains definitions for the e3_sensor_stream_ddos class;.

#include "tlc_package/e3_sensor_stream_ddos.hpp"

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

6.108 src/tlc_package/src/tlc_package/sumo_intf.cpp File Reference

Functions
Component maker (ComponentConfig &config, int argc, char argv)

6.107.1

Detailed Description

This file contains definitions for the e3_sensor_stream_ddos class;.


Author

Date
2016-04-20T18:05:53-05:00

6.108

src/tlc_package/src/tlc_package/sumo_intf.cpp File Reference

This file contains definitions for the sumo_intf class;.

#include "tlc_package/sumo_intf.hpp"

Functions
Component maker (ComponentConfig &config, int argc, char argv)

Variables
SUMO_CLIENT sumo_client
bool sumo_client_operational = false
std::string sumo_host
int sumo_port

6.108.1

Detailed Description

This file contains definitions for the sumo_intf class;.


Author

Date
2016-04-20T18:05:53-05:00

6.109

src/tlc_package/src/tlc_package/tl_actuator.cpp File Reference

This file contains definitions for the tl_actuator class;.

#include "tlc_package/tl_actuator.hpp"

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

465

466

File Documentation

Functions
Component maker (ComponentConfig &config, int argc, char argv)

6.109.1

Detailed Description

This file contains definitions for the tl_actuator class;.


Author

Date
2016-04-20T18:05:53-05:00

6.110

src/tlc_package/src/tlc_package/tl_sensor.cpp File Reference

This file contains definitions for the tl_sensor class;.

#include "tlc_package/tl_sensor.hpp"

Functions
Component maker (ComponentConfig &config, int argc, char argv)

6.110.1

Detailed Description

This file contains definitions for the tl_sensor class;.


Author

Date
2016-04-20T18:05:53-05:00

6.111

src/tlc_package/src/tlc_package/tl_sensor_stream_ddos.cpp File Reference

This file contains definitions for the tl_sensor_stream_ddos class;.

#include "tlc_package/tl_sensor_stream_ddos.hpp"

Functions
Component maker (ComponentConfig &config, int argc, char argv)
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

6.111 src/tlc_package/src/tlc_package/tl_sensor_stream_ddos.cpp File Reference

6.111.1

Detailed Description

This file contains definitions for the tl_sensor_stream_ddos class;.


Author

Date
2016-04-20T18:05:53-05:00

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

467

Index
memory_pool
rapidxml::memory_pool, 75
AGEN_ATTR_INHABITANTS
SUMOXMLDefinitions.h, 446
AGEN_TAG_GENERAL
SUMOXMLDefinitions.h, 447
AbstractMutex, 17
AbstractMutex::ScopedLocker, 224
ScopedLocker, 225
add
NamedObjectCont, 92
RandomDistributor, 211
ValueTimeLine, 337
addCallExample
OptionsCont, 141
addConfigurationOptions
SystemFrame, 290
addCopyrightNotice
OptionsCont, 141
addDescription
OptionsCont, 141
addEdgeWeight
SAXWeightsHandler::EdgeFloatTimeLineRetriever,
47
addOptionSubTopic
OptionsCont, 142
addParameter
Parameterised, 200
addReportOptions
SystemFrame, 290
addSynonyme
OptionsCont, 142
addTo
Named, 90
allocate_attribute
rapidxml::memory_pool, 75
rapidxml::xml_document, 352
allocate_node
rapidxml::memory_pool, 76
rapidxml::xml_document, 353
allocate_string
rapidxml::memory_pool, 76
rapidxml::xml_document, 353
alpha
RGBColor, 215
append_attribute
rapidxml::xml_document, 353
rapidxml::xml_node, 364
append_node

rapidxml::xml_document, 354
rapidxml::xml_node, 364
beginProcessMsg
MsgHandler, 80
beginVTypeParsing
SUMOVehicleParserHelper, 285
BiArc, 18
BiArcParams, 19
BinaryFormatter, 19
closeTag, 21
openTag, 21
writeAttr, 22
writeHeader, 22
writePreformattedTag, 22
writeXMLHeader, 22
BinaryInputDevice, 24
BinaryInputDevice, 25
BinaryInputDevice, 25
good, 25
operator>>, 2629
peek, 25
putback, 25
read, 26
blue
RGBColor, 215
BoolFormatException, 29
buildErrorMessage
GenericSAXHandler, 61
SAXWeightsHandler, 221
SUMORouteHandler, 246
SUMOSAXHandler, 281
CSVIterator, 41
CSVRow, 41
changedBrightness
RGBColor, 215
characters
GenericSAXHandler, 61
OptionsLoader, 153
SAXWeightsHandler, 222
SUMORouteHandler, 247
SUMOSAXHandler, 281
check_resultState
SUMO_CLIENT, 238
TraCIAPI, 306
checkDependingSuboptions
OptionsCont, 142
checkForRelativity
FileHelpers, 54

INDEX

clear
rapidxml::memory_pool, 76
rapidxml::xml_document, 354
clone_node
rapidxml::memory_pool, 77
rapidxml::xml_document, 354
close
SystemFrame, 290
XMLSubSys, 372
closeRoute
SUMORouteHandler, 247
closeTag
BinaryFormatter, 21
MsgRetrievingFunction, 83
OutputDevice, 157
OutputDevice_CERR, 164
OutputDevice_COUT, 171
OutputDevice_File, 178
OutputDevice_Network, 185
OutputDevice_String, 192
OutputFormatter, 198
PlainXMLFormatter, 203
closeVTypeParsing
SUMOVehicleParserHelper, 285
Command, 30
execute, 31
comp_queue
Component, 33
control_stream_ddos, 37
controller, 40
e3_sensor, 43
e3_sensor_stream_ddos, 46
sumo_intf, 243
tl_actuator, 294
tl_sensor, 297
tl_sensor_stream_ddos, 300
comp_sync_pub
Component, 33
control_stream_ddos, 37
controller, 40
e3_sensor, 44
e3_sensor_stream_ddos, 46
sumo_intf, 243
tl_actuator, 294
tl_sensor, 297
tl_sensor_stream_ddos, 300
comp_sync_sub
Component, 33
control_stream_ddos, 37
controller, 40
e3_sensor, 44
e3_sensor_stream_ddos, 46
sumo_intf, 243
tl_actuator, 294
tl_sensor, 297
tl_sensor_stream_ddos, 300
Component, 31
comp_queue, 33

469

comp_sync_pub, 33
comp_sync_sub, 33
Component, 33
component_sync_operation, 33
config, 34
init_timer, 34
init_timer_operation, 33
logger, 34
node_argc, 34
node_argv, 34
startUp, 33
component_sync_operation
Component, 33
control_stream_ddos, 36
controller, 39
e3_sensor, 43
e3_sensor_stream_ddos, 45
sumo_intf, 241
tl_actuator, 293
tl_sensor, 296
tl_sensor_stream_ddos, 300
ComponentConfig, 34
config
Component, 34
control_stream_ddos, 37
controller, 40
e3_sensor, 44
e3_sensor_stream_ddos, 46
sumo_intf, 243
tl_actuator, 294
tl_sensor, 297
tl_sensor_stream_ddos, 300
connect
SUMO_CLIENT, 239
TraCIAPI, 306
Connection, 35
control_stream_ddos, 35
comp_queue, 37
comp_sync_pub, 37
comp_sync_sub, 37
component_sync_operation, 36
config, 37
control_stream_ddos, 36
control_stream_ddos, 36
init_timer, 37
init_timer_operation, 37
logger, 37
node_argc, 37
node_argv, 38
startUp, 37
controller, 38
comp_queue, 40
comp_sync_pub, 40
comp_sync_sub, 40
component_sync_operation, 39
config, 40
controller, 39
controller_timer_operation, 39

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

470

init_timer, 40
init_timer_operation, 39
logger, 41
node_argc, 41
node_argv, 41
ryg_state_sub_operation, 40
sensor_state_sub_operation, 40
startUp, 40
controller_timer_operation
controller, 39
convertCartesianToRoadMap
TraCIServerAPI_Simulation, 331
create_file
Logger, 72
createDeviceByOption
MsgRetrievingFunction, 83
OutputDevice, 157
OutputDevice_CERR, 164
OutputDevice_COUT, 171
OutputDevice_File, 178
OutputDevice_Network, 185
OutputDevice_String, 192
data
rapidxml::file, 52
Delay
Network::NetworkProfile, 97
deschedule
StaticCommand, 229
WrappingCommand, 341
describesTime
ValueTimeLine, 337
doRegister
OptionsCont, 143
document
rapidxml::xml_attribute, 344
rapidxml::xml_document, 354
rapidxml::xml_node, 365
e3_get_vehicle_number_server_operation
sumo_intf, 241
e3_sensor, 42
comp_queue, 43
comp_sync_pub, 44
comp_sync_sub, 44
component_sync_operation, 43
config, 44
e3_sensor, 43
e3_update_timer_operation, 43
e3_sensor, 43
init_timer, 44
init_timer_operation, 43
logger, 44
node_argc, 44
node_argv, 44
startUp, 43
e3_sensor_stream_ddos, 44
comp_queue, 46
comp_sync_pub, 46

INDEX

comp_sync_sub, 46
component_sync_operation, 45
config, 46
e3_sensor_stream_ddos, 45
e3_sensor_stream_ddos, 45
init_timer, 46
init_timer_operation, 46
logger, 46
node_argc, 46
node_argv, 47
startUp, 46
e3_update_timer_operation
e3_sensor, 43
EmptyData, 49
endElement
GenericSAXHandler, 61
OptionsLoader, 153
SAXWeightsHandler, 222
SUMORouteHandler, 247
SUMOSAXHandler, 281
erase
NamedObjectCont, 92
error
GenericSAXHandler, 62
OptionsLoader, 153
SAXWeightsHandler, 222
SUMORouteHandler, 247
SUMOSAXHandler, 281
escapeXML
StringUtils, 235
EulerSpiral, 49
EulerSpiralLookupTable, 50
EulerSpiralParams, 50
execute
Command, 31
StaticCommand, 229
WrappingCommand, 341
exists
OptionsCont, 143
fatalError
GenericSAXHandler, 62
OptionsLoader, 153
SAXWeightsHandler, 222
SUMORouteHandler, 248
SUMOSAXHandler, 282
file
rapidxml::file, 52
FileHelpers, 53
checkForRelativity, 54
getConfigurationRelative, 54
getFilePath, 54
isAbsolute, 54
isReadable, 55
isSocket, 55
readEdgeVector, 55
writeByte, 55
writeEdgeVector, 57
writeFloat, 57
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

INDEX

writeInt, 57
writeString, 57
writeTime, 58
writeUInt, 58
fillGaps
ValueTimeLine, 338
first_attribute
rapidxml::xml_document, 354
rapidxml::xml_node, 365
first_node
rapidxml::xml_document, 355
rapidxml::xml_node, 365
FormatException, 58
fromHSV
RGBColor, 215
GenericSAXHandler, 59
buildErrorMessage, 61
characters, 61
endElement, 61
error, 62
fatalError, 62
GenericSAXHandler, 61
GenericSAXHandler, 61
getFileName, 62
myCharacters, 62
myEndElement, 62
myStartElement, 63
setFileName, 63
startElement, 63
warning, 63
get
NamedObjectCont, 93
RandomDistributor, 211
SUMOSAXAttributes, 253
SUMOSAXAttributesImpl_Binary, 263
SUMOSAXAttributesImpl_Xerces, 272
getBool
Option, 100
Option_Bool, 106
Option_FileName, 112
Option_Float, 117
Option_Integer, 123
Option_IntVector, 128
Option_String, 133
OptionsCont, 143
SUMOSAXAttributes, 254
SUMOSAXAttributesImpl_Binary, 263
SUMOSAXAttributesImpl_Xerces, 273
getBoundary
SUMOSAXAttributes, 254
SUMOSAXAttributesImpl_Binary, 264
SUMOSAXAttributesImpl_Xerces, 273
getColor
SUMOSAXAttributes, 254
SUMOSAXAttributesImpl_Binary, 264
SUMOSAXAttributesImpl_Xerces, 273
getConfigurationRelative
FileHelpers, 54

471

getCurrentInterval
Network::NetworkProfile, 97
getCurrentMillis
SysUtils, 291
getDataAtTime
Network::NetworkProfile, 97
getDescription
Option, 100
Option_Bool, 106
Option_FileName, 112
Option_Float, 117
Option_Integer, 123
Option_IntVector, 128
Option_String, 134
getDevice
MsgRetrievingFunction, 83
OutputDevice, 158
OutputDevice_CERR, 164
OutputDevice_COUT, 171
OutputDevice_File, 179
OutputDevice_Network, 186
OutputDevice_String, 192
getDeviceByOption
MsgRetrievingFunction, 84
OutputDevice, 158
OutputDevice_CERR, 165
OutputDevice_COUT, 172
OutputDevice_File, 179
OutputDevice_Network, 186
OutputDevice_String, 193
getEdgeFunc
SUMOSAXAttributes, 254
SUMOSAXAttributesImpl_Binary, 264
SUMOSAXAttributesImpl_Xerces, 273
getFileName
GenericSAXHandler, 62
SAXWeightsHandler, 223
SUMORouteHandler, 248
SUMOSAXHandler, 282
getFilePath
FileHelpers, 54
getFloat
Option, 101
Option_Bool, 106
Option_FileName, 112
Option_Float, 117
Option_Integer, 123
Option_IntVector, 128
Option_String, 134
OptionsCont, 144
SUMOSAXAttributes, 255
SUMOSAXAttributesImpl_Binary, 264, 265
SUMOSAXAttributesImpl_Xerces, 274
getID
Named, 91
getInt
Option, 101
Option_Bool, 106

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

472

Option_FileName, 112
Option_Float, 117
Option_Integer, 123
Option_IntVector, 129
Option_String, 134
OptionsCont, 144
SUMOSAXAttributes, 256
SUMOSAXAttributesImpl_Binary, 265
SUMOSAXAttributesImpl_Xerces, 274
getIntVector
Option, 101
Option_Bool, 107
Option_FileName, 113
Option_Float, 118
Option_Integer, 123
Option_IntVector, 129
Option_String, 134
OptionsCont, 144
getLaneChecking
TraCIServerAPI_Simulation, 331
getLong
SUMOSAXAttributes, 256
SUMOSAXAttributesImpl_Binary, 266
SUMOSAXAttributesImpl_Xerces, 275
getMap
Parameterised, 200
getName
SUMOSAXAttributes, 256
SUMOSAXAttributesImpl_Binary, 266
SUMOSAXAttributesImpl_Xerces, 275
getNextInterval
Network::NetworkProfile, 97
getNodeType
SUMOSAXAttributes, 257
SUMOSAXAttributesImpl_Binary, 266
SUMOSAXAttributesImpl_Xerces, 275
getOStream
MsgRetrievingFunction, 84
OutputDevice_CERR, 165
OutputDevice_COUT, 172
OutputDevice_File, 180
OutputDevice_Network, 186
OutputDevice_String, 193
getOpt
SUMOSAXAttributes, 257
SUMOSAXAttributesImpl_Binary, 266
SUMOSAXAttributesImpl_Xerces, 276
getOptSUMOTimeReporting
SUMOSAXAttributes, 257
SUMOSAXAttributesImpl_Binary, 267
SUMOSAXAttributesImpl_Xerces, 276
getOptions
OptionsIO, 152
getOverallProb
RandomDistributor, 211
getParameter
Parameterised, 201
getPosition

INDEX

TraCIServerAPI_InductionLoop, 319
TraCIServerAPI_Junction, 321
TraCIServerAPI_Person, 325
TraCIServerAPI_POI, 326
TraCIServerAPI_Vehicle, 333
getProbs
RandomDistributor, 211
getSAXReader
XMLSubSys, 372
getSUMOTimeReporting
SUMOSAXAttributes, 259
SUMOSAXAttributesImpl_Binary, 269
SUMOSAXAttributesImpl_Xerces, 278
getShape
SUMOSAXAttributes, 258
SUMOSAXAttributesImpl_Binary, 267
SUMOSAXAttributesImpl_Xerces, 276
TraCIServerAPI_Edge, 318
TraCIServerAPI_Lane, 323
TraCIServerAPI_Polygon, 328
getSplitTime
ValueTimeLine, 338
getString
Option, 101
Option_Bool, 107
Option_FileName, 113
Option_Float, 118
Option_Integer, 124
Option_IntVector, 129
Option_String, 135
OptionsCont, 145
OutputDevice_String, 193
SUMOSAXAttributes, 258
SUMOSAXAttributesImpl_Binary, 267
SUMOSAXAttributesImpl_Xerces, 277
getStringSecure
SUMOSAXAttributes, 258, 259
SUMOSAXAttributesImpl_Binary, 268
SUMOSAXAttributesImpl_Xerces, 277
getStringVector
OptionsCont, 145
SUMOSAXAttributes, 259
SUMOSAXAttributesImpl_Binary, 268
SUMOSAXAttributesImpl_Xerces, 278
getSynonymes
OptionsCont, 145
getTree
TraCIServerAPI_InductionLoop, 319
TraCIServerAPI_Junction, 321
TraCIServerAPI_POI, 326
TraCIServerAPI_Polygon, 329
getTypeName
Option, 102
Option_Bool, 107
Option_FileName, 113
Option_Float, 118
Option_Integer, 124
Option_IntVector, 129
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

INDEX

Option_String, 135
getVals
RandomDistributor, 212
getValue
ValueTimeLine, 338
getValueString
Option, 102
Option_Bool, 107
Option_FileName, 113
Option_Float, 118
Option_Integer, 124
Option_IntVector, 130
Option_String, 135
getVariable
TraCIServerAPI_VehicleType, 334
getVehicleClassCompoundID
SUMOVehicleClass.cpp, 455
SUMOVehicleClass.h, 412
getVehicleClassID
SUMOVehicleClass.cpp, 456
SUMOVehicleClass.h, 413
getVehicleClassNames
SUMOVehicleClass.cpp, 456
SUMOVehicleClass.h, 413
getVehicleClassNamesList
SUMOVehicleClass.cpp, 456
SUMOVehicleClass.h, 413
getVehicleShapeID
SUMOVehicleClass.cpp, 456
SUMOVehicleClass.h, 413
getVehicleShapeName
SUMOVehicleClass.cpp, 457
SUMOVehicleClass.h, 414
good
BinaryInputDevice, 25
green
RGBColor, 217
hasAttribute
SUMOSAXAttributes, 260
SUMOSAXAttributesImpl_Binary, 269
SUMOSAXAttributesImpl_Xerces, 278
IDSupplier, 65
IDSupplier, 65
IDSupplier, 65
IOError, 67
IPV4_Connection, 67
IPV6_Connection, 68
inform
MsgRetrievingFunction, 84
OutputDevice, 158
OutputDevice_CERR, 165
OutputDevice_COUT, 172
OutputDevice_File, 180
OutputDevice_Network, 187
OutputDevice_String, 193
init
XMLSubSys, 372

473

init_timer
Component, 34
control_stream_ddos, 37
controller, 40
e3_sensor, 44
e3_sensor_stream_ddos, 46
sumo_intf, 243
tl_actuator, 294
tl_sensor, 297
tl_sensor_stream_ddos, 301
init_timer_operation
Component, 33
control_stream_ddos, 37
controller, 39
e3_sensor, 43
e3_sensor_stream_ddos, 46
sumo_intf, 242
tl_actuator, 294
tl_sensor, 296
tl_sensor_stream_ddos, 300
Insert
NamedRTree, 94
insert_attribute
rapidxml::xml_document, 355
rapidxml::xml_node, 365
insert_node
rapidxml::xml_document, 355
rapidxml::xml_node, 366
interpolate
RGBColor, 217
invalid_return< X >, 66
InvalidArgument, 66
isAbsolute
FileHelpers, 54
isBinary
MsgRetrievingFunction, 85
OutputDevice, 158
OutputDevice_CERR, 166
OutputDevice_COUT, 173
OutputDevice_File, 180
OutputDevice_Network, 187
OutputDevice_String, 194
isBool
Option, 102
Option_Bool, 108
Option_FileName, 113
Option_Float, 119
Option_Integer, 124
Option_IntVector, 130
Option_String, 135
OptionsCont, 146
isDefault
Option, 102
Option_Bool, 108
Option_FileName, 114
Option_Float, 119
Option_Integer, 125
Option_IntVector, 130

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

474

Option_String, 135
OptionsCont, 146
isFileName
Option, 102
Option_Bool, 108
Option_FileName, 114
Option_Float, 119
Option_Integer, 125
Option_IntVector, 130
Option_String, 136
isForbidden
SUMOVehicleClass.cpp, 457
SUMOVehicleClass.h, 414
isInStringVector
OptionsCont, 146
isRailway
SUMOVehicleClass.cpp, 457
SUMOVehicleClass.h, 414
isReadable
FileHelpers, 55
isSet
Option, 103
Option_Bool, 108
Option_FileName, 114
Option_Float, 119
Option_Integer, 125
Option_IntVector, 130
Option_String, 136
OptionsCont, 147
isSocket
FileHelpers, 55
isUsableFileList
OptionsCont, 147
isWaterway
SUMOVehicleClass.cpp, 457
SUMOVehicleClass.h, 414
isWriteable
Option, 103
Option_Bool, 108
Option_FileName, 114
Option_Float, 119
Option_Integer, 125
Option_IntVector, 130
Option_String, 136
OptionsCont, 148
knowsParameter
Parameterised, 201
LINKDIR_LEFT
SUMOXMLDefinitions.h, 444
LINKDIR_NODIR
SUMOXMLDefinitions.h, 444
LINKDIR_PARTLEFT
SUMOXMLDefinitions.h, 444
LINKDIR_PARTRIGHT
SUMOXMLDefinitions.h, 444
LINKDIR_RIGHT
SUMOXMLDefinitions.h, 444

INDEX

LINKDIR_STRAIGHT
SUMOXMLDefinitions.h, 444
LINKDIR_TURN
SUMOXMLDefinitions.h, 444
LINKSTATE_ALLWAY_STOP
SUMOXMLDefinitions.h, 445
LINKSTATE_DEADEND
SUMOXMLDefinitions.h, 445
LINKSTATE_EQUAL
SUMOXMLDefinitions.h, 445
LINKSTATE_MAJOR
SUMOXMLDefinitions.h, 445
LINKSTATE_MINOR
SUMOXMLDefinitions.h, 445
LINKSTATE_STOP
SUMOXMLDefinitions.h, 445
LINKSTATE_TL_GREEN_MAJOR
SUMOXMLDefinitions.h, 445
LINKSTATE_TL_GREEN_MINOR
SUMOXMLDefinitions.h, 445
LINKSTATE_TL_OFF_BLINKING
SUMOXMLDefinitions.h, 445
LINKSTATE_TL_OFF_NOSIGNAL
SUMOXMLDefinitions.h, 445
LINKSTATE_TL_RED
SUMOXMLDefinitions.h, 445
LINKSTATE_TL_REDYELLOW
SUMOXMLDefinitions.h, 445
LINKSTATE_TL_YELLOW_MAJOR
SUMOXMLDefinitions.h, 445
LINKSTATE_TL_YELLOW_MINOR
SUMOXMLDefinitions.h, 445
last_attribute
rapidxml::xml_document, 355
rapidxml::xml_node, 366
last_node
rapidxml::xml_document, 356
rapidxml::xml_node, 366
LinkDirection
SUMOXMLDefinitions.h, 444
LinkState
SUMOXMLDefinitions.h, 444
loadConfiguration
OptionsIO, 152
log
Logger, 73
Logger, 71
create_file, 72
log, 73
set_is_periodic, 73
set_logs_to_file, 73
set_max_log_unit, 73
logger
Component, 34
control_stream_ddos, 37
controller, 41
e3_sensor, 44
e3_sensor_stream_ddos, 46
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

INDEX

sumo_intf, 243
tl_actuator, 295
tl_sensor, 297
tl_sensor_stream_ddos, 301
MT_ERROR
MsgHandler, 80
MT_MESSAGE
MsgHandler, 80
MT_WARNING
MsgHandler, 80
MTRand, 88
markSet
Option, 103
Option_Bool, 108
Option_FileName, 114
Option_Float, 120
Option_Integer, 125
Option_IntVector, 131
Option_String, 136
MsgHandler
MT_ERROR, 80
MT_MESSAGE, 80
MT_WARNING, 80
MsgHandler, 79
beginProcessMsg, 80
MsgType, 80
operator<<, 80
MsgRetrievingFunction
closeTag, 83
createDeviceByOption, 83
getDevice, 83
getDeviceByOption, 84
getOStream, 84
inform, 84
isBinary, 85
MsgRetrievingFunction, 82
MsgRetrievingFunction, 82
ok, 85
openTag, 85
operator<<, 85
realString, 85
setPrecision, 87
writeAttr, 87
writeNonEmptyAttr, 87
writePreformattedTag, 88
writeXMLHeader, 88
MsgRetrievingFunction< T >, 81
MsgType
MsgHandler, 80
myCharacters
GenericSAXHandler, 62
SAXWeightsHandler, 223
SUMORouteHandler, 248
SUMOSAXHandler, 282
myEndElement
GenericSAXHandler, 62
SAXWeightsHandler, 223
SUMORouteHandler, 248

475

SUMOSAXHandler, 282
myStartElement
GenericSAXHandler, 63
SAXWeightsHandler, 223
SUMORouteHandler, 248
SUMOSAXHandler, 282
name
rapidxml::xml_attribute, 344
rapidxml::xml_base, 348
rapidxml::xml_document, 356, 357
rapidxml::xml_node, 366, 367
name_size
rapidxml::xml_attribute, 344
rapidxml::xml_base, 348
rapidxml::xml_document, 357
rapidxml::xml_node, 367
Named, 90
addTo, 90
getID, 91
Named, 90
setID, 91
Named::ComparatorIdLess, 31
Named::NamedLikeComparatorIdLess< NamedLike >,
91
Named::StoringVisitor, 231
NamedObjectCont
add, 92
erase, 92
get, 93
remove, 93
size, 93
NamedObjectCont< T >, 91
NamedRTree, 93
Insert, 94
Remove, 94
RemoveAll, 95
Search, 95
Network::Buffer_Empty, 30
Network::Exceeded_Production_Profile, 51
Network::Exceeded_Production_profile, 51
Network::Message, 77
Network::NetworkProfile, 96
Delay, 97
getCurrentInterval, 97
getDataAtTime, 97
getNextInterval, 97
resources, 97
Network::ResourceEntry, 213
Network::message_buffer< T >, 78
Network::profileMemBuf, 208
Network::receiver, 212
Network::sender, 225
NetworkBuffer, 95
next
StringTokenizer, 234
next_attribute
rapidxml::xml_attribute, 345
next_sibling

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

476

rapidxml::xml_document, 357
rapidxml::xml_node, 367
node_argc
Component, 34
control_stream_ddos, 37
controller, 41
e3_sensor, 44
e3_sensor_stream_ddos, 46
sumo_intf, 243
tl_actuator, 295
tl_sensor, 297
tl_sensor_stream_ddos, 301
node_argv
Component, 34
control_stream_ddos, 38
controller, 41
e3_sensor, 44
e3_sensor_stream_ddos, 47
sumo_intf, 243
tl_actuator, 295
tl_sensor, 297
tl_sensor_stream_ddos, 301
NumberFormatException, 98
ok
MsgRetrievingFunction, 85
OutputDevice, 159
OutputDevice_CERR, 166
OutputDevice_COUT, 173
OutputDevice_File, 180
OutputDevice_Network, 187
OutputDevice_String, 194
openSocket
TraCIServer, 313
openTag
BinaryFormatter, 21
MsgRetrievingFunction, 85
OutputDevice, 159
OutputDevice_CERR, 166
OutputDevice_COUT, 173
OutputDevice_File, 180, 181
OutputDevice_Network, 187
OutputDevice_String, 194
OutputFormatter, 198
PlainXMLFormatter, 204
operator<<
MsgHandler, 80
MsgRetrievingFunction, 85
OptionsCont, 151
OutputDevice, 159
OutputDevice_CERR, 166
OutputDevice_COUT, 173
OutputDevice_File, 181
OutputDevice_Network, 188
OutputDevice_String, 194
RGBColor, 218
RGBColor.cpp, 451
operator>>
BinaryInputDevice, 2629

INDEX

Option, 98
getBool, 100
getDescription, 100
getFloat, 101
getInt, 101
getIntVector, 101
getString, 101
getTypeName, 102
getValueString, 102
isBool, 102
isDefault, 102
isFileName, 102
isSet, 103
isWriteable, 103
markSet, 103
Option, 100
resetWritable, 103
set, 103
setDescription, 104
Option_Bool, 104
getBool, 106
getDescription, 106
getFloat, 106
getInt, 106
getIntVector, 107
getString, 107
getTypeName, 107
getValueString, 107
isBool, 108
isDefault, 108
isFileName, 108
isSet, 108
isWriteable, 108
markSet, 108
Option_Bool, 105
Option_Bool, 105
resetWritable, 109
setDescription, 109
Option_FileName, 109
getBool, 112
getDescription, 112
getFloat, 112
getInt, 112
getIntVector, 113
getString, 113
getTypeName, 113
getValueString, 113
isBool, 113
isDefault, 114
isFileName, 114
isSet, 114
isWriteable, 114
markSet, 114
Option_FileName, 111
Option_FileName, 111
resetWritable, 114
set, 115
setDescription, 115
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

INDEX

Option_Float, 115
getBool, 117
getDescription, 117
getFloat, 117
getInt, 117
getIntVector, 118
getString, 118
getTypeName, 118
getValueString, 118
isBool, 119
isDefault, 119
isFileName, 119
isSet, 119
isWriteable, 119
markSet, 120
Option_Float, 117
Option_Float, 117
resetWritable, 120
set, 120
setDescription, 120
Option_IntVector, 126
getBool, 128
getDescription, 128
getFloat, 128
getInt, 129
getIntVector, 129
getString, 129
getTypeName, 129
getValueString, 130
isBool, 130
isDefault, 130
isFileName, 130
isSet, 130
isWriteable, 130
markSet, 131
Option_IntVector, 128
Option_IntVector, 128
resetWritable, 131
set, 131
setDescription, 131
Option_Integer, 121
getBool, 123
getDescription, 123
getFloat, 123
getInt, 123
getIntVector, 123
getString, 124
getTypeName, 124
getValueString, 124
isBool, 124
isDefault, 125
isFileName, 125
isSet, 125
isWriteable, 125
markSet, 125
Option_Integer, 122
Option_Integer, 122
resetWritable, 125

477

set, 126
setDescription, 126
Option_String, 132
getBool, 133
getDescription, 134
getFloat, 134
getInt, 134
getIntVector, 134
getString, 135
getTypeName, 135
getValueString, 135
isBool, 135
isDefault, 135
isFileName, 136
isSet, 136
isWriteable, 136
markSet, 136
Option_String, 133
Option_String, 133
resetWritable, 136
set, 136
setDescription, 137
Options, 137
OptionsCont, 138
addCallExample, 141
addCopyrightNotice, 141
addDescription, 141
addOptionSubTopic, 142
addSynonyme, 142
checkDependingSuboptions, 142
doRegister, 143
exists, 143
getBool, 143
getFloat, 144
getInt, 144
getIntVector, 144
getString, 145
getStringVector, 145
getSynonymes, 145
isBool, 146
isDefault, 146
isInStringVector, 146
isSet, 147
isUsableFileList, 147
isWriteable, 148
operator<<, 151
printHelp, 148
processMetaOptions, 148
relocateFiles, 149
resetWritable, 149
set, 149
setAdditionalHelpMessage, 149
setApplicationDescription, 150
setApplicationName, 150
unSet, 150
writeConfiguration, 150
writeSchema, 150
writeXMLHeader, 151

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

478

OptionsIO, 151
getOptions, 152
loadConfiguration, 152
OptionsLoader, 152
characters, 153
endElement, 153
error, 153
fatalError, 153
startElement, 153
warning, 153
OptionsParser, 154
parse, 154
OutOfBoundsException, 155
OutputDevice, 155
closeTag, 157
createDeviceByOption, 157
getDevice, 158
getDeviceByOption, 158
inform, 158
isBinary, 158
ok, 159
openTag, 159
operator<<, 159
postWriteHook, 159
realString, 159
setPrecision, 161
writeAttr, 161
writeNonEmptyAttr, 161
writePreformattedTag, 161
writeXMLHeader, 162
OutputDevice_CERR, 162
closeTag, 164
createDeviceByOption, 164
getDevice, 164
getDeviceByOption, 165
getOStream, 165
inform, 165
isBinary, 166
ok, 166
openTag, 166
operator<<, 166
postWriteHook, 166
realString, 167
setPrecision, 167
writeAttr, 167
writeNonEmptyAttr, 167
writePreformattedTag, 169
writeXMLHeader, 169
OutputDevice_COUT, 169
closeTag, 171
createDeviceByOption, 171
getDevice, 171
getDeviceByOption, 172
getOStream, 172
inform, 172
isBinary, 173
ok, 173
openTag, 173

INDEX

operator<<, 173
postWriteHook, 173
realString, 174
setPrecision, 174
writeAttr, 174
writeNonEmptyAttr, 174
writePreformattedTag, 176
writeXMLHeader, 176
OutputDevice_File, 176
closeTag, 178
createDeviceByOption, 178
getDevice, 179
getDeviceByOption, 179
getOStream, 180
inform, 180
isBinary, 180
ok, 180
openTag, 180, 181
operator<<, 181
OutputDevice_File, 178
OutputDevice_File, 178
postWriteHook, 181
realString, 181
setPrecision, 181
writeAttr, 182
writeNonEmptyAttr, 182
writePreformattedTag, 182
writeXMLHeader, 183
OutputDevice_Network, 183
closeTag, 185
createDeviceByOption, 185
getDevice, 186
getDeviceByOption, 186
getOStream, 186
inform, 187
isBinary, 187
ok, 187
openTag, 187
operator<<, 188
OutputDevice_Network, 185
OutputDevice_Network, 185
postWriteHook, 188
realString, 188
setPrecision, 188
writeAttr, 188, 189
writeNonEmptyAttr, 189
writePreformattedTag, 189
writeXMLHeader, 189
OutputDevice_String, 190
closeTag, 192
createDeviceByOption, 192
getDevice, 192
getDeviceByOption, 193
getOStream, 193
getString, 193
inform, 193
isBinary, 194
ok, 194
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

INDEX

openTag, 194
operator<<, 194
postWriteHook, 194
realString, 195
setPrecision, 195
writeAttr, 195
writeNonEmptyAttr, 195
writePreformattedTag, 197
writeXMLHeader, 197
OutputFormatter, 197
closeTag, 198
openTag, 198
writeXMLHeader, 199
Parameterised, 199
addParameter, 200
getMap, 200
getParameter, 201
knowsParameter, 201
Parameterised, 200
parent
rapidxml::xml_attribute, 345
rapidxml::xml_base, 349
rapidxml::xml_document, 357
rapidxml::xml_node, 368
parse
OptionsParser, 154
rapidxml::xml_document, 357
parseColor
RGBColor, 217
parseColorReporting
RGBColor, 218
parseEmissionClass
SUMOVehicleParserHelper, 286
parseFlowAttributes
SUMOVehicleParserHelper, 286
parseGuiShape
SUMOVehicleParserHelper, 287
parseStringSet
SUMOSAXAttributes, 260
SUMOSAXAttributesImpl_Binary, 269
SUMOSAXAttributesImpl_Xerces, 278
parseStringVector
SUMOSAXAttributes, 260
SUMOSAXAttributesImpl_Binary, 270
SUMOSAXAttributesImpl_Xerces, 279
parseVTypeEmbedded
SUMOVehicleParserHelper, 288
parseVehicleAttributes
SUMOVehicleParserHelper, 287
parseVehicleClass
SUMOVehicleParserHelper, 288
parseVehicleClasses
SUMOVehicleClass.cpp, 457, 458
SUMOVehicleClass.h, 414, 415
peek
BinaryInputDevice, 25
PlainXMLFormatter, 202
closeTag, 203

479

openTag, 204
writeAttr, 204
writeHeader, 205
writePreformattedTag, 205
writeXMLHeader, 205
Point2D< coord_type >, 205
postWriteHook
OutputDevice, 159
OutputDevice_CERR, 166
OutputDevice_COUT, 173
OutputDevice_File, 181
OutputDevice_Network, 188
OutputDevice_String, 194
prepend_attribute
rapidxml::xml_document, 358
rapidxml::xml_node, 368
prepend_node
rapidxml::xml_document, 358
rapidxml::xml_node, 368
previous_attribute
rapidxml::xml_attribute, 345
previous_sibling
rapidxml::xml_document, 358
rapidxml::xml_node, 368
printHelp
OptionsCont, 148
ProcessError, 208
processGet
TraCIServerAPI_ArealDetector, 317
TraCIServerAPI_Edge, 318
TraCIServerAPI_InductionLoop, 319
TraCIServerAPI_Junction, 321
TraCIServerAPI_Lane, 323
TraCIServerAPI_MeMeDetector, 324
TraCIServerAPI_Person, 325
TraCIServerAPI_POI, 326
TraCIServerAPI_Polygon, 329
TraCIServerAPI_Route, 330
TraCIServerAPI_Simulation, 331
TraCIServerAPI_TLS, 332
TraCIServerAPI_Vehicle, 333
TraCIServerAPI_VehicleType, 334
processMetaOptions
OptionsCont, 148
processSet
TraCIServerAPI_Edge, 318
TraCIServerAPI_Lane, 324
TraCIServerAPI_Person, 325
TraCIServerAPI_POI, 328
TraCIServerAPI_Polygon, 329
TraCIServerAPI_Route, 330
TraCIServerAPI_Simulation, 331
TraCIServerAPI_TLS, 332
TraCIServerAPI_Vehicle, 333
TraCIServerAPI_VehicleType, 334
putback
BinaryInputDevice, 25
RGBColor, 213

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

480

alpha, 215
blue, 215
changedBrightness, 215
fromHSV, 215
green, 217
interpolate, 217
operator<<, 218
parseColor, 217
parseColorReporting, 218
RGBColor, 215
red, 218
RGBColor, 215
set, 218
RGBColor.cpp
operator<<, 451
RandHelper, 209
RandomDistributor
add, 211
get, 211
getOverallProb, 211
getProbs, 211
getVals, 212
RandomDistributor, 210
RandomDistributor, 210
RandomDistributor< T >, 210
rapidxml::file
data, 52
file, 52
size, 52
rapidxml::file< Ch >, 51
rapidxml::memory_pool
memory_pool, 75
allocate_attribute, 75
allocate_node, 76
allocate_string, 76
clear, 76
clone_node, 77
set_allocator, 77
rapidxml::memory_pool< Ch >, 74
rapidxml::parse_error, 201
what, 202
where, 202
rapidxml::xml_attribute
document, 344
name, 344
name_size, 344
next_attribute, 345
parent, 345
previous_attribute, 345
value, 345, 346
value_size, 346
xml_attribute, 343
rapidxml::xml_attribute< Ch >, 342
rapidxml::xml_base
name, 348
name_size, 348
parent, 349
value, 349

INDEX

value_size, 350
rapidxml::xml_base< Ch >, 347
rapidxml::xml_document
allocate_attribute, 352
allocate_node, 353
allocate_string, 353
append_attribute, 353
append_node, 354
clear, 354
clone_node, 354
document, 354
first_attribute, 354
first_node, 355
insert_attribute, 355
insert_node, 355
last_attribute, 355
last_node, 356
name, 356, 357
name_size, 357
next_sibling, 357
parent, 357
parse, 357
prepend_attribute, 358
prepend_node, 358
previous_sibling, 358
remove_attribute, 358
remove_first_attribute, 360
remove_first_node, 360
remove_last_attribute, 360
remove_last_node, 360
set_allocator, 360
type, 360, 361
value, 361
value_size, 362
rapidxml::xml_document< Ch >, 350
rapidxml::xml_node
append_attribute, 364
append_node, 364
document, 365
first_attribute, 365
first_node, 365
insert_attribute, 365
insert_node, 366
last_attribute, 366
last_node, 366
name, 366, 367
name_size, 367
next_sibling, 367
parent, 368
prepend_attribute, 368
prepend_node, 368
previous_sibling, 368
remove_attribute, 369
remove_first_attribute, 369
remove_first_node, 369
remove_last_attribute, 369
remove_last_node, 369
type, 369
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

INDEX

value, 369, 370


value_size, 370
xml_node, 364
rapidxml::xml_node< Ch >, 362
read
BinaryInputDevice, 26
readEdgeVector
FileHelpers, 55
readTypeCheckingBoundary
TraCIServer, 313
readTypeCheckingByte
TraCIServer, 314
readTypeCheckingColor
TraCIServer, 314
readTypeCheckingDouble
TraCIServer, 314
readTypeCheckingInt
TraCIServer, 314
readTypeCheckingPolygon
TraCIServer, 315
readTypeCheckingPosition2D
TraCIServer, 315
readTypeCheckingString
TraCIServer, 315
readTypeCheckingStringList
TraCIServer, 315
readTypeCheckingUnsignedByte
TraCIServer, 316
realString
MsgRetrievingFunction, 85
OutputDevice, 159
OutputDevice_CERR, 167
OutputDevice_COUT, 174
OutputDevice_File, 181
OutputDevice_Network, 188
OutputDevice_String, 195
red
RGBColor, 218
relocateFiles
OptionsCont, 149
Remove
NamedRTree, 94
remove
NamedObjectCont, 93
remove_attribute
rapidxml::xml_document, 358
rapidxml::xml_node, 369
remove_first_attribute
rapidxml::xml_document, 360
rapidxml::xml_node, 369
remove_first_node
rapidxml::xml_document, 360
rapidxml::xml_node, 369
remove_last_attribute
rapidxml::xml_document, 360
rapidxml::xml_node, 369
remove_last_node
rapidxml::xml_document, 360

481

rapidxml::xml_node, 369
RemoveAll
NamedRTree, 95
resetWritable
Option, 103
Option_Bool, 109
Option_FileName, 114
Option_Float, 120
Option_Integer, 125
Option_IntVector, 131
Option_String, 136
OptionsCont, 149
resources
Network::NetworkProfile, 97
runParser
XMLSubSys, 372
ryg_control_sub_operation
tl_actuator, 294
ryg_state_sub_operation
controller, 40
SUMO_ATTR_BEGIN
SUMOXMLDefinitions.h, 445
SUMO_ATTR_COLOR
SUMOXMLDefinitions.h, 446
SUMO_ATTR_CONT
SUMOXMLDefinitions.h, 446
SUMO_ATTR_CUSTOMSHAPE
SUMOXMLDefinitions.h, 445
SUMO_ATTR_DIR
SUMOXMLDefinitions.h, 446
SUMO_ATTR_EDGES
SUMOXMLDefinitions.h, 445
SUMO_ATTR_END
SUMOXMLDefinitions.h, 445
SUMO_ATTR_FILL
SUMOXMLDefinitions.h, 446
SUMO_ATTR_FOES
SUMOXMLDefinitions.h, 446
SUMO_ATTR_LAYER
SUMOXMLDefinitions.h, 446
SUMO_ATTR_MAXDURATION
SUMOXMLDefinitions.h, 446
SUMO_ATTR_MINDURATION
SUMOXMLDefinitions.h, 446
SUMO_ATTR_NODES
SUMOXMLDefinitions.h, 446
SUMO_ATTR_NOTHING
SUMOXMLDefinitions.h, 445
SUMO_ATTR_RADIUS
SUMOXMLDefinitions.h, 445
SUMO_ATTR_SHAPE
SUMOXMLDefinitions.h, 445
SUMO_ATTR_SPREADTYPE
SUMOXMLDefinitions.h, 445
SUMO_ATTR_STATE
SUMOXMLDefinitions.h, 446
SUMO_ATTR_TIME
SUMOXMLDefinitions.h, 445

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

482

SUMO_ATTR_TLID
SUMOXMLDefinitions.h, 445
SUMO_ATTR_TLLINKINDEX
SUMOXMLDefinitions.h, 445
SUMO_ATTR_TLTYPE
SUMOXMLDefinitions.h, 445
SUMO_ATTR_WEIGHT
SUMOXMLDefinitions.h, 445
SUMO_TAG_BUS_STOP
SUMOXMLDefinitions.h, 446
SUMO_TAG_CALIBRATOR
SUMOXMLDefinitions.h, 446
SUMO_TAG_CONTAINER_STOP
SUMOXMLDefinitions.h, 446
SUMO_TAG_DET_ENTRY
SUMOXMLDefinitions.h, 446
SUMO_TAG_DET_EXIT
SUMOXMLDefinitions.h, 446
SUMO_TAG_E1DETECTOR
SUMOXMLDefinitions.h, 446
SUMO_TAG_E2DETECTOR
SUMOXMLDefinitions.h, 446
SUMO_TAG_E3DETECTOR
SUMOXMLDefinitions.h, 446
SUMO_TAG_EDGE
SUMOXMLDefinitions.h, 446
SUMO_TAG_EDGEFOLLOWDETECTOR
SUMOXMLDefinitions.h, 446
SUMO_TAG_FLOW
SUMOXMLDefinitions.h, 447
SUMO_TAG_FROMEDGE
SUMOXMLDefinitions.h, 447
SUMO_TAG_INSTANT_INDUCTION_LOOP
SUMOXMLDefinitions.h, 446
SUMO_TAG_INTERVAL
SUMOXMLDefinitions.h, 447
SUMO_TAG_JUNCTION
SUMOXMLDefinitions.h, 446
SUMO_TAG_LANE
SUMOXMLDefinitions.h, 446
SUMO_TAG_MEANDATA_EDGE
SUMOXMLDefinitions.h, 446
SUMO_TAG_MEANDATA_LANE
SUMOXMLDefinitions.h, 446
SUMO_TAG_NET
SUMOXMLDefinitions.h, 446
SUMO_TAG_NOTHING
SUMOXMLDefinitions.h, 446
SUMO_TAG_PHASE
SUMOXMLDefinitions.h, 447
SUMO_TAG_POI
SUMOXMLDefinitions.h, 446
SUMO_TAG_POLY
SUMOXMLDefinitions.h, 446
SUMO_TAG_REQUEST
SUMOXMLDefinitions.h, 447
SUMO_TAG_REROUTER
SUMOXMLDefinitions.h, 446

INDEX

SUMO_TAG_ROUTE
SUMOXMLDefinitions.h, 447
SUMO_TAG_ROUTEPROBE
SUMOXMLDefinitions.h, 446
SUMO_TAG_ROUTES
SUMOXMLDefinitions.h, 446
SUMO_TAG_SINK
SUMOXMLDefinitions.h, 447
SUMO_TAG_SOURCE
SUMOXMLDefinitions.h, 447
SUMO_TAG_STEP
SUMOXMLDefinitions.h, 447
SUMO_TAG_TAZ
SUMOXMLDefinitions.h, 447
SUMO_TAG_TAZSINK
SUMOXMLDefinitions.h, 447
SUMO_TAG_TAZSOURCE
SUMOXMLDefinitions.h, 447
SUMO_TAG_TIMEDEVENT
SUMOXMLDefinitions.h, 447
SUMO_TAG_TLLOGIC
SUMOXMLDefinitions.h, 447
SUMO_TAG_TOEDGE
SUMOXMLDefinitions.h, 447
SUMO_TAG_TRIP
SUMOXMLDefinitions.h, 447
SUMO_TAG_VEHICLE
SUMOXMLDefinitions.h, 447
SUMO_TAG_VSS
SUMOXMLDefinitions.h, 446
SUMO_TAG_VTYPE
SUMOXMLDefinitions.h, 447
SUMO_TAG_VTYPEPROBE
SUMOXMLDefinitions.h, 446
SUMOVehicleClass.h
SVC_ARMY, 411
SVC_AUTHORITY, 411
SVC_BICYCLE, 412
SVC_BUS, 411
SVC_COACH, 411
SVC_CUSTOM1, 412
SVC_CUSTOM2, 412
SVC_DELIVERY, 411
SVC_E_VEHICLE, 412
SVC_EMERGENCY, 411
SVC_HOV, 411
SVC_IGNORING, 411
SVC_MOPED, 412
SVC_MOTORCYCLE, 412
SVC_PASSENGER, 411
SVC_PEDESTRIAN, 412
SVC_PRIVATE, 411
SVC_RAIL, 412
SVC_RAIL_ELECTRIC, 412
SVC_RAIL_URBAN, 412
SVC_SHIP, 412
SVC_TAXI, 411
SVC_TRAILER, 412
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

INDEX

SVC_TRAM, 412
SVC_TRUCK, 411
SVC_VIP, 411
SVS_ANT, 412
SVS_BICYCLE, 412
SVS_BUS, 412
SVS_BUS_COACH, 412
SVS_BUS_FLEXIBLE, 412
SVS_BUS_TROLLEY, 412
SVS_DELIVERY, 412
SVS_E_VEHICLE, 412
SVS_MOPED, 412
SVS_MOTORCYCLE, 412
SVS_PASSENGER, 412
SVS_PASSENGER_HATCHBACK, 412
SVS_PASSENGER_SEDAN, 412
SVS_PASSENGER_VAN, 412
SVS_PASSENGER_WAGON, 412
SVS_PEDESTRIAN, 412
SVS_RAIL, 412
SVS_RAIL_CAR, 412
SVS_RAIL_CARGO, 412
SVS_SHIP, 412
SVS_TRUCK, 412
SVS_TRUCK_1TRAILER, 412
SVS_TRUCK_SEMITRAILER, 412
SVS_UNKNOWN, 412
SUMOXMLDefinitions.h
AGEN_ATTR_INHABITANTS, 446
AGEN_TAG_GENERAL, 447
LINKDIR_LEFT, 444
LINKDIR_NODIR, 444
LINKDIR_PARTLEFT, 444
LINKDIR_PARTRIGHT, 444
LINKDIR_RIGHT, 444
LINKDIR_STRAIGHT, 444
LINKDIR_TURN, 444
LINKSTATE_ALLWAY_STOP, 445
LINKSTATE_DEADEND, 445
LINKSTATE_EQUAL, 445
LINKSTATE_MAJOR, 445
LINKSTATE_MINOR, 445
LINKSTATE_STOP, 445
LINKSTATE_TL_GREEN_MAJOR, 445
LINKSTATE_TL_GREEN_MINOR, 445
LINKSTATE_TL_OFF_BLINKING, 445
LINKSTATE_TL_OFF_NOSIGNAL, 445
LINKSTATE_TL_RED, 445
LINKSTATE_TL_REDYELLOW, 445
LINKSTATE_TL_YELLOW_MAJOR, 445
LINKSTATE_TL_YELLOW_MINOR, 445
SUMO_ATTR_BEGIN, 445
SUMO_ATTR_COLOR, 446
SUMO_ATTR_CONT, 446
SUMO_ATTR_CUSTOMSHAPE, 445
SUMO_ATTR_DIR, 446
SUMO_ATTR_EDGES, 445
SUMO_ATTR_END, 445
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

483

SUMO_ATTR_FILL, 446
SUMO_ATTR_FOES, 446
SUMO_ATTR_LAYER, 446
SUMO_ATTR_MAXDURATION, 446
SUMO_ATTR_MINDURATION, 446
SUMO_ATTR_NODES, 446
SUMO_ATTR_NOTHING, 445
SUMO_ATTR_RADIUS, 445
SUMO_ATTR_SHAPE, 445
SUMO_ATTR_SPREADTYPE, 445
SUMO_ATTR_STATE, 446
SUMO_ATTR_TIME, 445
SUMO_ATTR_TLID, 445
SUMO_ATTR_TLLINKINDEX, 445
SUMO_ATTR_TLTYPE, 445
SUMO_ATTR_WEIGHT, 445
SUMO_TAG_BUS_STOP, 446
SUMO_TAG_CALIBRATOR, 446
SUMO_TAG_CONTAINER_STOP, 446
SUMO_TAG_DET_ENTRY, 446
SUMO_TAG_DET_EXIT, 446
SUMO_TAG_E1DETECTOR, 446
SUMO_TAG_E2DETECTOR, 446
SUMO_TAG_E3DETECTOR, 446
SUMO_TAG_EDGE, 446
SUMO_TAG_EDGEFOLLOWDETECTOR, 446
SUMO_TAG_FLOW, 447
SUMO_TAG_FROMEDGE, 447
SUMO_TAG_INSTANT_INDUCTION_LOOP, 446
SUMO_TAG_INTERVAL, 447
SUMO_TAG_JUNCTION, 446
SUMO_TAG_LANE, 446
SUMO_TAG_MEANDATA_EDGE, 446
SUMO_TAG_MEANDATA_LANE, 446
SUMO_TAG_NET, 446
SUMO_TAG_NOTHING, 446
SUMO_TAG_PHASE, 447
SUMO_TAG_POI, 446
SUMO_TAG_POLY, 446
SUMO_TAG_REQUEST, 447
SUMO_TAG_REROUTER, 446
SUMO_TAG_ROUTE, 447
SUMO_TAG_ROUTEPROBE, 446
SUMO_TAG_ROUTES, 446
SUMO_TAG_SINK, 447
SUMO_TAG_SOURCE, 447
SUMO_TAG_STEP, 447
SUMO_TAG_TAZ, 447
SUMO_TAG_TAZSINK, 447
SUMO_TAG_TAZSOURCE, 447
SUMO_TAG_TIMEDEVENT, 447
SUMO_TAG_TLLOGIC, 447
SUMO_TAG_TOEDGE, 447
SUMO_TAG_TRIP, 447
SUMO_TAG_VEHICLE, 447
SUMO_TAG_VSS, 446
SUMO_TAG_VTYPE, 447
SUMO_TAG_VTYPEPROBE, 446

484

SVC_ARMY
SUMOVehicleClass.h, 411
SVC_AUTHORITY
SUMOVehicleClass.h, 411
SVC_BICYCLE
SUMOVehicleClass.h, 412
SVC_BUS
SUMOVehicleClass.h, 411
SVC_COACH
SUMOVehicleClass.h, 411
SVC_CUSTOM1
SUMOVehicleClass.h, 412
SVC_CUSTOM2
SUMOVehicleClass.h, 412
SVC_DELIVERY
SUMOVehicleClass.h, 411
SVC_E_VEHICLE
SUMOVehicleClass.h, 412
SVC_EMERGENCY
SUMOVehicleClass.h, 411
SVC_HOV
SUMOVehicleClass.h, 411
SVC_IGNORING
SUMOVehicleClass.h, 411
SVC_MOPED
SUMOVehicleClass.h, 412
SVC_MOTORCYCLE
SUMOVehicleClass.h, 412
SVC_PASSENGER
SUMOVehicleClass.h, 411
SVC_PEDESTRIAN
SUMOVehicleClass.h, 412
SVC_PRIVATE
SUMOVehicleClass.h, 411
SVC_RAIL
SUMOVehicleClass.h, 412
SVC_RAIL_ELECTRIC
SUMOVehicleClass.h, 412
SVC_RAIL_URBAN
SUMOVehicleClass.h, 412
SVC_SHIP
SUMOVehicleClass.h, 412
SVC_TAXI
SUMOVehicleClass.h, 411
SVC_TRAILER
SUMOVehicleClass.h, 412
SVC_TRAM
SUMOVehicleClass.h, 412
SVC_TRUCK
SUMOVehicleClass.h, 411
SVC_VIP
SUMOVehicleClass.h, 411
SVS_ANT
SUMOVehicleClass.h, 412
SVS_BICYCLE
SUMOVehicleClass.h, 412
SVS_BUS
SUMOVehicleClass.h, 412

INDEX

SVS_BUS_COACH
SUMOVehicleClass.h, 412
SVS_BUS_FLEXIBLE
SUMOVehicleClass.h, 412
SVS_BUS_TROLLEY
SUMOVehicleClass.h, 412
SVS_DELIVERY
SUMOVehicleClass.h, 412
SVS_E_VEHICLE
SUMOVehicleClass.h, 412
SVS_MOPED
SUMOVehicleClass.h, 412
SVS_MOTORCYCLE
SUMOVehicleClass.h, 412
SVS_PASSENGER
SUMOVehicleClass.h, 412
SVS_PASSENGER_HATCHBACK
SUMOVehicleClass.h, 412
SVS_PASSENGER_SEDAN
SUMOVehicleClass.h, 412
SVS_PASSENGER_VAN
SUMOVehicleClass.h, 412
SVS_PASSENGER_WAGON
SUMOVehicleClass.h, 412
SVS_PEDESTRIAN
SUMOVehicleClass.h, 412
SVS_RAIL
SUMOVehicleClass.h, 412
SVS_RAIL_CAR
SUMOVehicleClass.h, 412
SVS_RAIL_CARGO
SUMOVehicleClass.h, 412
SVS_SHIP
SUMOVehicleClass.h, 412
SVS_TRUCK
SUMOVehicleClass.h, 412
SVS_TRUCK_1TRAILER
SUMOVehicleClass.h, 412
SVS_TRUCK_SEMITRAILER
SUMOVehicleClass.h, 412
SVS_UNKNOWN
SUMOVehicleClass.h, 412
SAXWeightsHandler, 220
buildErrorMessage, 221
characters, 222
endElement, 222
error, 222
fatalError, 222
getFileName, 223
myCharacters, 223
myEndElement, 223
myStartElement, 223
SAXWeightsHandler, 221
SAXWeightsHandler, 221
setFileName, 224
startElement, 224
warning, 224
SAXWeightsHandler::EdgeFloatTimeLineRetriever, 47
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

INDEX

addEdgeWeight, 47
SAXWeightsHandler::ToRetrieveDefinition, 301
SUMO_CLIENT, 235
check_resultState, 238
connect, 239
send_commandGetVariable, 239
send_commandSetValue, 239
send_commandSubscribeObjectContext, 239
send_commandSubscribeObjectVariable, 240
SUMORouteHandler, 244
buildErrorMessage, 246
characters, 247
closeRoute, 247
endElement, 247
error, 247
fatalError, 248
getFileName, 248
myCharacters, 248
myEndElement, 248
myStartElement, 248
setFileName, 250
startElement, 250
warning, 250
SUMORouteLoader, 250
SUMORouteLoaderControl, 251
SUMOSAXAttributes, 252
get, 253
getBool, 254
getBoundary, 254
getColor, 254
getEdgeFunc, 254
getFloat, 255
getInt, 256
getLong, 256
getName, 256
getNodeType, 257
getOpt, 257
getOptSUMOTimeReporting, 257
getSUMOTimeReporting, 259
getShape, 258
getString, 258
getStringSecure, 258, 259
getStringVector, 259
hasAttribute, 260
parseStringSet, 260
parseStringVector, 260
serialize, 261
SUMOSAXAttributesImpl_Binary, 261
get, 263
getBool, 263
getBoundary, 264
getColor, 264
getEdgeFunc, 264
getFloat, 264, 265
getInt, 265
getLong, 266
getName, 266
getNodeType, 266

485

getOpt, 266
getOptSUMOTimeReporting, 267
getSUMOTimeReporting, 269
getShape, 267
getString, 267
getStringSecure, 268
getStringVector, 268
hasAttribute, 269
parseStringSet, 269
parseStringVector, 270
serialize, 270
SUMOSAXAttributesImpl_Binary, 263
SUMOSAXAttributesImpl_Xerces, 270
get, 272
getBool, 273
getBoundary, 273
getColor, 273
getEdgeFunc, 273
getFloat, 274
getInt, 274
getLong, 275
getName, 275
getNodeType, 275
getOpt, 276
getOptSUMOTimeReporting, 276
getSUMOTimeReporting, 278
getShape, 276
getString, 277
getStringSecure, 277
getStringVector, 278
hasAttribute, 278
parseStringSet, 278
parseStringVector, 279
serialize, 279
SUMOSAXAttributesImpl_Xerces, 272
SUMOSAXHandler, 279
buildErrorMessage, 281
characters, 281
endElement, 281
error, 281
fatalError, 282
getFileName, 282
myCharacters, 282
myEndElement, 282
myStartElement, 282
SUMOSAXHandler, 280
setFileName, 283
startElement, 283
SUMOSAXHandler, 280
warning, 283
SUMOSAXReader, 283
SUMOSAXReader, 284
setHandler, 284
SUMOSAXReader, 284
SUMOVehicleClass
SUMOVehicleClass.h, 411
SUMOVehicleClass.cpp
getVehicleClassCompoundID, 455

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

486

getVehicleClassID, 456
getVehicleClassNames, 456
getVehicleClassNamesList, 456
getVehicleShapeID, 456
getVehicleShapeName, 457
isForbidden, 457
isRailway, 457
isWaterway, 457
parseVehicleClasses, 457, 458
SUMOVehicleClass.h
getVehicleClassCompoundID, 412
getVehicleClassID, 413
getVehicleClassNames, 413
getVehicleClassNamesList, 413
getVehicleShapeID, 413
getVehicleShapeName, 414
isForbidden, 414
isRailway, 414
isWaterway, 414
parseVehicleClasses, 414, 415
SUMOVehicleClass, 411
SUMOVehicleShape, 412
SUMOVehicleParserHelper, 284
beginVTypeParsing, 285
closeVTypeParsing, 285
parseEmissionClass, 286
parseFlowAttributes, 286
parseGuiShape, 287
parseVTypeEmbedded, 288
parseVehicleAttributes, 287
parseVehicleClass, 288
SUMOVehicleShape
SUMOVehicleClass.h, 412
SUMOXMLDefinitions, 289
SUMOXMLDefinitions.h
LinkDirection, 444
LinkState, 444
SumoXMLAttr, 445
SumoXMLTag, 446
ScopedLocker
AbstractMutex::ScopedLocker, 225
Search
NamedRTree, 95
send_commandGetVariable
SUMO_CLIENT, 239
TraCIAPI, 307
send_commandSetValue
SUMO_CLIENT, 239
TraCIAPI, 307
send_commandSubscribeObjectContext
SUMO_CLIENT, 239
TraCIAPI, 307
send_commandSubscribeObjectVariable
SUMO_CLIENT, 240
TraCIAPI, 307
sensor_state_sub_operation
controller, 40
serialize

INDEX

SUMOSAXAttributes, 261
SUMOSAXAttributesImpl_Binary, 270
SUMOSAXAttributesImpl_Xerces, 279
set
Option, 103
Option_FileName, 115
Option_Float, 120
Option_Integer, 126
Option_IntVector, 131
Option_String, 136
OptionsCont, 149
RGBColor, 218
set_allocator
rapidxml::memory_pool, 77
rapidxml::xml_document, 360
set_is_periodic
Logger, 73
set_logs_to_file
Logger, 73
set_max_log_unit
Logger, 73
setAdditionalHelpMessage
OptionsCont, 149
setApplicationDescription
OptionsCont, 150
setApplicationName
OptionsCont, 150
setDescription
Option, 104
Option_Bool, 109
Option_FileName, 115
Option_Float, 120
Option_Integer, 126
Option_IntVector, 131
Option_String, 137
setFileName
GenericSAXHandler, 63
SAXWeightsHandler, 224
SUMORouteHandler, 250
SUMOSAXHandler, 283
setHandler
SUMOSAXReader, 284
XMLSubSys, 373
setID
Named, 91
setPrecision
MsgRetrievingFunction, 87
OutputDevice, 161
OutputDevice_CERR, 167
OutputDevice_COUT, 174
OutputDevice_File, 181
OutputDevice_Network, 188
OutputDevice_String, 195
setValidation
XMLSubSys, 373
size
NamedObjectCont, 93
rapidxml::file, 52
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

INDEX

487

src/sumo/include/utils/common/StringBijection.h, 406
src/node/include/node/Component.hpp, 375
src/sumo/include/utils/common/StringTokenizer.h, 406
src/node/include/node/rapidxml.hpp, 375
src/sumo/include/utils/common/StringUtils.h, 407
src/node/include/node/rapidxml_utils.hpp, 377
src/sumo/include/utils/common/SysUtils.h, 416
src/node/src/node/Component.cpp, 378
src/sumo/include/utils/common/SystemFrame.h, 415
src/node/src/node/node_main.cpp, 378
src/sumo/include/utils/common/ToString.h, 416
src/pnp2/include/pnp2/NetworkProfile.hpp, 379
src/sumo/include/utils/common/TplConvert.h, 418
src/pnp2/include/pnp2/receiver.hpp, 379
src/sumo/include/utils/common/UtilExceptions.h, 418
src/pnp2/include/pnp2/sender.hpp, 380
src/sumo/include/utils/common/ValueRetriever.h, 419
src/sumo/include/traci-server/TraCIConstants.h, 380
src/sumo/include/utils/common/ValueSource.h, 420
src/sumo/include/traci-server/TraCIException.h, 386
src/sumo/include/utils/common/ValueTimeLine.h, 420
src/sumo/include/traci-server/TraCIServer.h, 387
src/sumo/include/utils/common/VectorHelper.h, 421
src/sumo/include/traci-server/TraCIServerAPI_Edge.h,
src/sumo/include/utils/common/WrappingCommand.h,
388
422
src/sumo/include/traci-server/TraCIServerAPI_Inductionsrc/sumo/include/utils/iodevices/BinaryFormatter.h, 422
Loop.h, 388
src/sumo/include/traci-server/TraCIServerAPI_Junction.- src/sumo/include/utils/iodevices/BinaryInputDevice.h,
423
h, 389
src/sumo/include/utils/iodevices/OutputDevice.h, 424
src/sumo/include/traci-server/TraCIServerAPI_Lane.h,
389
src/sumo/include/utils/iodevices/OutputDevice_CERR.h, 424
src/sumo/include/traci-server/TraCIServerAPI_MeMeDetector.h, 390
src/sumo/include/utils/iodevices/OutputDevice_COUT.h,
425
src/sumo/include/traci-server/TraCIServerAPI_POI.h,
src/sumo/include/utils/iodevices/OutputDevice_File.h,
391
425
src/sumo/include/traci-server/TraCIServerAPI_Person.src/sumo/include/utils/iodevices/OutputDevice_Network.h, 391
h, 426
src/sumo/include/traci-server/TraCIServerAPI_Polygon.src/sumo/include/utils/iodevices/OutputDevice_String.h,
h, 392
427
src/sumo/include/traci-server/TraCIServerAPI_Route.h,
src/sumo/include/utils/iodevices/OutputFormatter.h, 427
392
src/sumo/include/traci-server/TraCIServerAPI_Simulation.- src/sumo/include/utils/iodevices/PlainXMLFormatter.h,
428
h, 393
src/sumo/include/utils/options/Option.h,
428
src/sumo/include/traci-server/TraCIServerAPI_TLS.h,
394
src/sumo/include/utils/options/OptionsCont.h, 429
src/sumo/include/traci-server/TraCIServerAPI_Vehicle.src/sumo/include/utils/options/OptionsIO.h, 430
h, 394
src/sumo/include/utils/options/OptionsLoader.h, 430
src/sumo/include/traci-server/TraCIServerAPI_Vehiclesrc/sumo/include/utils/options/OptionsParser.h, 431
Type.h, 395
src/sumo/include/utils/traci/TraCIAPI.h, 431
src/sumo/include/utils/common/AbstractMutex.h, 395
src/sumo/include/utils/xml/GenericSAXHandler.h, 433
src/sumo/include/utils/common/Command.h, 396
src/sumo/include/utils/xml/SAXWeightsHandler.h, 434
src/sumo/include/utils/common/FileHelpers.h, 397
src/sumo/include/utils/xml/SUMORouteHandler.h, 435
src/sumo/include/utils/common/IDSupplier.h, 397
src/sumo/include/utils/xml/SUMORouteLoader.h, 435
src/sumo/include/utils/common/MsgHandler.h, 398
src/sumo/include/utils/xml/SUMORouteLoaderControl.src/sumo/include/utils/common/MsgRetrievingFunction.h, 436
h, 399
src/sumo/include/utils/xml/SUMOSAXAttributes.h, 436
src/sumo/include/utils/common/Named.h, 399
src/sumo/include/utils/xml/SUMOSAXAttributesImpl_src/sumo/include/utils/common/NamedObjectCont.h,
Binary.h, 437
400
src/sumo/include/utils/xml/SUMOSAXAttributesImpl_Xerces.h, 438
src/sumo/include/utils/common/NamedRTree.h, 401
src/sumo/include/utils/xml/SUMOSAXHandler.h, 438
src/sumo/include/utils/common/Parameterised.h, 401
src/sumo/include/utils/xml/SUMOSAXReader.h, 439
src/sumo/include/utils/common/RGBColor.h, 403
src/sumo/include/utils/xml/SUMOVehicleParserHelper.src/sumo/include/utils/common/RandHelper.h, 402
h, 440
src/sumo/include/utils/common/RandomDistributor.h,
src/sumo/include/utils/xml/SUMOXMLDefinitions.h, 440
403
src/sumo/include/utils/xml/XMLSubSys.h, 447
src/sumo/include/utils/common/SUMOTime.h, 407
src/sumo/src/utils/common/FileHelpers.cpp, 448
src/sumo/include/utils/common/SUMOVehicleClass.h,
409
src/sumo/src/utils/common/IDSupplier.cpp, 448
src/sumo/include/utils/common/StaticCommand.h, 404
src/sumo/src/utils/common/MsgHandler.cpp, 449
src/sumo/src/utils/common/Parameterised.cpp, 449
src/sumo/include/utils/common/StdDefs.h, 404
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

488

INDEX

src/sumo/src/utils/common/RGBColor.cpp, 450
src/sumo/src/utils/common/RandHelper.cpp, 450
src/sumo/src/utils/common/SUMOVehicleClass.cpp,
453
src/sumo/src/utils/common/StdDefs.cpp, 451
src/sumo/src/utils/common/StringTokenizer.cpp, 452
src/sumo/src/utils/common/StringUtils.cpp, 452
src/sumo/src/utils/common/SysUtils.cpp, 459
src/sumo/src/utils/common/SystemFrame.cpp, 458
src/tlc_package/include/tlc_package/control_stream_ddos.hpp, 459
src/tlc_package/include/tlc_package/controller.hpp, 460
src/tlc_package/include/tlc_package/e3_sensor.hpp,
460
src/tlc_package/include/tlc_package/e3_sensor_stream_ddos.hpp, 461
src/tlc_package/include/tlc_package/sumo_intf.hpp, 461
src/tlc_package/include/tlc_package/tl_actuator.hpp,
462
src/tlc_package/include/tlc_package/tl_sensor.hpp, 462
src/tlc_package/include/tlc_package/tl_sensor_stream_ddos.hpp, 463
src/tlc_package/src/tlc_package/control_stream_ddos.cpp, 463
src/tlc_package/src/tlc_package/controller.cpp, 463
src/tlc_package/src/tlc_package/e3_sensor.cpp, 464
src/tlc_package/src/tlc_package/e3_sensor_stream_ddos.cpp, 464
src/tlc_package/src/tlc_package/sumo_intf.cpp, 465
src/tlc_package/src/tlc_package/tl_actuator.cpp, 465
src/tlc_package/src/tlc_package/tl_sensor.cpp, 466
src/tlc_package/src/tlc_package/tl_sensor_stream_ddos.cpp, 466
startElement
GenericSAXHandler, 63
OptionsLoader, 153
SAXWeightsHandler, 224
SUMORouteHandler, 250
SUMOSAXHandler, 283
startUp
Component, 33
control_stream_ddos, 37
controller, 40
e3_sensor, 43
e3_sensor_stream_ddos, 46
sumo_intf, 242
tl_actuator, 294
tl_sensor, 296
tl_sensor_stream_ddos, 300
StaticCommand
deschedule, 229
execute, 229
StaticCommand, 229
StaticCommand, 229
StaticCommand< T >, 228
StringBijection< T >, 232
StringBijection< T >::Entry, 49
StringTokenizer, 232

next, 234
StringTokenizer, 234
StringTokenizer, 234
StringUtils, 234
escapeXML, 235
sumo_intf, 240
comp_queue, 243
comp_sync_pub, 243
comp_sync_sub, 243
component_sync_operation, 241
config, 243
e3_get_vehicle_number_server_operation, 241
init_timer, 243
init_timer_operation, 242
logger, 243
node_argc, 243
node_argv, 243
startUp, 242
sumo_intf, 241
sumo_step_timer_operation, 242
sumo_intf, 241
tlc_get_ryg_state_server_operation, 242
tlc_set_ryg_state_server_operation, 242
sumo_step_timer_operation
sumo_intf, 242
SumoXMLAttr
SUMOXMLDefinitions.h, 445
SumoXMLTag
SUMOXMLDefinitions.h, 446
SysUtils, 291
getCurrentMillis, 291
SystemFrame, 289
addConfigurationOptions, 290
addReportOptions, 290
close, 290
tcpip::Socket, 227
tcpip::SocketException, 228
tcpip::Storage, 230
tl_actuator, 291
comp_queue, 294
comp_sync_pub, 294
comp_sync_sub, 294
component_sync_operation, 293
config, 294
init_timer, 294
init_timer_operation, 294
logger, 295
node_argc, 295
node_argv, 295
ryg_control_sub_operation, 294
startUp, 294
tl_actuator, 292
tl_actuator, 292
tl_sensor, 295
comp_queue, 297
comp_sync_pub, 297
comp_sync_sub, 297
component_sync_operation, 296

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

INDEX

config, 297
init_timer, 297
init_timer_operation, 296
logger, 297
node_argc, 297
node_argv, 297
startUp, 296
tl_sensor, 296
tl_update_timer_operation, 297
tl_sensor, 296
tl_sensor_stream_ddos, 298
comp_queue, 300
comp_sync_pub, 300
comp_sync_sub, 300
component_sync_operation, 300
config, 300
init_timer, 301
init_timer_operation, 300
logger, 301
node_argc, 301
node_argv, 301
startUp, 300
tl_sensor_stream_ddos, 299
tl_sensor_stream_ddos, 299
tl_update_timer_operation
tl_sensor, 297
tlc_get_ryg_state_server_operation
sumo_intf, 242
tlc_set_ryg_state_server_operation
sumo_intf, 242
TplConvert, 302
TraCIAPI, 303
check_resultState, 306
connect, 306
send_commandGetVariable, 307
send_commandSetValue, 307
send_commandSubscribeObjectContext, 307
send_commandSubscribeObjectVariable, 307
TraCIAPI::AreaScope, 18
TraCIAPI::EdgeScope, 48
TraCIAPI::GUIScope, 64
TraCIAPI::InductionLoopScope, 65
TraCIAPI::JunctionScope, 69
TraCIAPI::LaneScope, 70
TraCIAPI::MeMeScope, 73
TraCIAPI::POIScope, 206
TraCIAPI::PolygonScope, 207
TraCIAPI::RouteScope, 219
TraCIAPI::SimulationScope, 226
TraCIAPI::TraCIBoundary, 308
TraCIAPI::TraCIColor, 308
TraCIAPI::TraCILink, 309
TraCIAPI::TraCILogic, 309
TraCIAPI::TraCIPhase, 310
TraCIAPI::TraCIPosition, 310
TraCIAPI::TraCIScopeWrapper, 311
TraCIScopeWrapper, 312
TraCIAPI::TrafficLightScope, 335

489

TraCIAPI::VehicleTypeScope, 339
TraCIException, 309
TraCIPositionVector, 310
TraCIScopeWrapper
TraCIAPI::TraCIScopeWrapper, 312
TraCIServer, 312
openSocket, 313
readTypeCheckingBoundary, 313
readTypeCheckingByte, 314
readTypeCheckingColor, 314
readTypeCheckingDouble, 314
readTypeCheckingInt, 314
readTypeCheckingPolygon, 315
readTypeCheckingPosition2D, 315
readTypeCheckingString, 315
readTypeCheckingStringList, 315
readTypeCheckingUnsignedByte, 316
wasClosed, 316
writeErrorStatusCmd, 316
writeStatusCmd, 316, 317
TraCIServerAPI_AreaDetector, 317
TraCIServerAPI_ArealDetector, 317
processGet, 317
TraCIServerAPI_Edge, 318
getShape, 318
processGet, 318
processSet, 318
TraCIServerAPI_InductionLoop, 319
getPosition, 319
getTree, 319
processGet, 319
TraCIServerAPI_Junction, 321
getPosition, 321
getTree, 321
processGet, 321
TraCIServerAPI_Lane, 323
getShape, 323
processGet, 323
processSet, 324
TraCIServerAPI_Lane::StoringVisitor, 231
TraCIServerAPI_MeMeDetector, 324
processGet, 324
TraCIServerAPI_POI, 326
getPosition, 326
getTree, 326
processGet, 326
processSet, 328
TraCIServerAPI_Person, 325
getPosition, 325
processGet, 325
processSet, 325
TraCIServerAPI_Polygon, 328
getShape, 328
getTree, 329
processGet, 329
processSet, 329
TraCIServerAPI_Route, 329
processGet, 330

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

490

processSet, 330
TraCIServerAPI_Simulation, 330
convertCartesianToRoadMap, 331
getLaneChecking, 331
processGet, 331
processSet, 331
TraCIServerAPI_TLS, 332
processGet, 332
processSet, 332
TraCIServerAPI_Vehicle, 332
getPosition, 333
processGet, 333
processSet, 333
TraCIServerAPI_VehicleType, 334
getVariable, 334
processGet, 334
processSet, 334
type
rapidxml::xml_document, 360, 361
rapidxml::xml_node, 369
unSet
OptionsCont, 150
UnknownElement, 336
value
rapidxml::xml_attribute, 345, 346
rapidxml::xml_base, 349
rapidxml::xml_document, 361
rapidxml::xml_node, 369, 370
value_size
rapidxml::xml_attribute, 346
rapidxml::xml_base, 350
rapidxml::xml_document, 362
rapidxml::xml_node, 370
ValueRetriever< T >, 336
ValueSource< T >, 336
ValueTimeLine
add, 337
describesTime, 337
fillGaps, 338
getSplitTime, 338
getValue, 338
ValueTimeLine< T >, 337
VectorHelper< T >, 339
warning
GenericSAXHandler, 63
OptionsLoader, 153
SAXWeightsHandler, 224
SUMORouteHandler, 250
SUMOSAXHandler, 283
wasClosed
TraCIServer, 316
what
rapidxml::parse_error, 202
where
rapidxml::parse_error, 202
WrappingCommand

INDEX

deschedule, 341
execute, 341
WrappingCommand, 341
WrappingCommand, 341
WrappingCommand< T >, 340
writeAttr
BinaryFormatter, 22
MsgRetrievingFunction, 87
OutputDevice, 161
OutputDevice_CERR, 167
OutputDevice_COUT, 174
OutputDevice_File, 182
OutputDevice_Network, 188, 189
OutputDevice_String, 195
PlainXMLFormatter, 204
writeByte
FileHelpers, 55
writeConfiguration
OptionsCont, 150
writeEdgeVector
FileHelpers, 57
writeErrorStatusCmd
TraCIServer, 316
writeFloat
FileHelpers, 57
writeHeader
BinaryFormatter, 22
PlainXMLFormatter, 205
writeInt
FileHelpers, 57
writeNonEmptyAttr
MsgRetrievingFunction, 87
OutputDevice, 161
OutputDevice_CERR, 167
OutputDevice_COUT, 174
OutputDevice_File, 182
OutputDevice_Network, 189
OutputDevice_String, 195
writePreformattedTag
BinaryFormatter, 22
MsgRetrievingFunction, 88
OutputDevice, 161
OutputDevice_CERR, 169
OutputDevice_COUT, 176
OutputDevice_File, 182
OutputDevice_Network, 189
OutputDevice_String, 197
PlainXMLFormatter, 205
writeSchema
OptionsCont, 150
writeStatusCmd
TraCIServer, 316, 317
writeString
FileHelpers, 57
writeTime
FileHelpers, 58
writeUInt
FileHelpers, 58
Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

INDEX

writeXMLHeader
BinaryFormatter, 22
MsgRetrievingFunction, 88
OptionsCont, 151
OutputDevice, 162
OutputDevice_CERR, 169
OutputDevice_COUT, 176
OutputDevice_File, 183
OutputDevice_Network, 189
OutputDevice_String, 197
OutputFormatter, 199
PlainXMLFormatter, 205
XMLParser, 371
XMLSubSys, 371
close, 372
getSAXReader, 372
init, 372
runParser, 372
setHandler, 373
setValidation, 373
xml_attribute
rapidxml::xml_attribute, 343
xml_node
rapidxml::xml_node, 364

Generated on Wed Apr 20 2016 18:16:52 for Traffic Light Controller by Doxygen

491

Das könnte Ihnen auch gefallen