Classes | Variables
README_gen Namespace Reference

Classes

class  README_gen
 

Variables

string configuration
 
string inport
 
string module
 
string outport
 
string readme
 
string service
 

Variable Documentation

string README_gen.configuration
Initial value:
1 = """Configuration:
2 [for config in configurationSet.configuration]
3  Name: [config.name]
4 
5  Description: [config.rtcDoc::doc.description]
6 
7  Type: [config.type]
8 
9  DefaultValue: [config.defaultValue]
10 
11  Range: [config.rtcDoc::doc.range]
12 
13  Unit: [config.rtcDoc::doc.unit]
14 
15  Constraint: [config.rtcDoc::doc.constraint]
16 
17 
18 [endfor]"""

Definition at line 171 of file README_gen.py.

string README_gen.inport
Initial value:
1 = """InPorts:
2 [for inport in dataPorts]
3 [if inport.portType is DataInPort]
4  Name: [inport.name]
5 
6  VarName: [inport.rtcExt::varname]
7 
8  PortNumber: [inport.rtcDoc::doc.number]
9 
10  Description: [inport.rtcDoc::doc.description]
11 
12  Type: [inport.type]
13 
14  InterfaceType: [inport.interfaceType]
15 
16  DataflowType: [inport.dataflowType]
17 
18  SubscriptionType: [inport.subscriptionType]
19 
20  MaxOut:
21 
22 [endif]
23 [endfor]
24 """

Definition at line 90 of file README_gen.py.

string README_gen.module
Initial value:
1 = """Basic Information:
2  Description: [basicInfo.description]
3 
4  Version: [basicInfo.version]
5 
6  Author: [basicInfo.vendor]
7 
8  Category: [basicInfo.category]
9 
10  Comp. Type: [basicInfo.componentType]
11 
12  Act. Type: [basicInfo.activityType]
13 
14  MAX Inst.: [basicInfo.maxInstances]
15 
16  Lang:
17  Lang Type:
18 """

Definition at line 71 of file README_gen.py.

string README_gen.outport
Initial value:
1 = """OutPorts:
2 [for outport in dataPorts]
3 [if outport.portType is DataOutPort]
4  Name: [outport.name]
5 
6  VarName: [outport.rtcExt::varname]
7 
8  PortNumber: [outport.rtcDoc::doc.number]
9 
10  Description: [outport.rtcDoc::doc.description]
11 
12  Type: [outport.type]
13 
14  InterfaceType: [outport.interfaceType]
15 
16  DataflowType: [outport.dataflowType]
17 
18  SubscriptionType: [outport.subscriptionType]
19 
20  MaxOut:
21 
22 [endif]
23 [endfor]
24 """

Definition at line 115 of file README_gen.py.

string README_gen.readme

Definition at line 24 of file README_gen.py.

string README_gen.service

Definition at line 139 of file README_gen.py.



openrtm_aist
Author(s): Noriaki Ando
autogenerated on Mon Jun 10 2019 14:08:02