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:

00001 """Configuration:
00002 [for config in configurationSet.configuration]
00003   Name:         [config.name]
00004 
00005   Description:  [config.rtcDoc::doc.description]
00006 
00007   Type:         [config.type]
00008 
00009   DefaultValue: [config.defaultValue]
00010 
00011   Range:        [config.rtcDoc::doc.range]
00012 
00013   Unit:         [config.rtcDoc::doc.unit]
00014 
00015   Constraint:   [config.rtcDoc::doc.constraint]
00016 
00017 
00018 [endfor]"""

Definition at line 171 of file README_gen.py.

string README_gen::inport

Initial value:

00001 """InPorts:
00002 [for inport in dataPorts]
00003 [if inport.portType is DataInPort]
00004   Name:             [inport.name]
00005 
00006   VarName:          [inport.rtcExt::varname]
00007 
00008   PortNumber:       [inport.rtcDoc::doc.number]
00009 
00010   Description:      [inport.rtcDoc::doc.description]
00011 
00012   Type:             [inport.type]
00013 
00014   InterfaceType:    [inport.interfaceType]
00015 
00016   DataflowType:     [inport.dataflowType]
00017 
00018   SubscriptionType: [inport.subscriptionType]
00019 
00020   MaxOut: 
00021 
00022 [endif]
00023 [endfor]
00024 """

Definition at line 90 of file README_gen.py.

string README_gen::module

Initial value:

00001 """Basic Information:
00002   Description: [basicInfo.description]
00003 
00004   Version:     [basicInfo.version]
00005 
00006   Author:      [basicInfo.vendor]
00007 
00008   Category:    [basicInfo.category]
00009 
00010   Comp. Type:  [basicInfo.componentType]
00011 
00012   Act. Type:   [basicInfo.activityType]
00013 
00014   MAX Inst.:   [basicInfo.maxInstances]
00015 
00016   Lang:        
00017   Lang Type:   
00018 """

Definition at line 71 of file README_gen.py.

string README_gen::outport

Initial value:

00001 """OutPorts:
00002 [for outport in dataPorts]
00003 [if outport.portType is DataOutPort]
00004   Name:             [outport.name]
00005 
00006   VarName:          [outport.rtcExt::varname]
00007 
00008   PortNumber:       [outport.rtcDoc::doc.number]
00009 
00010   Description:      [outport.rtcDoc::doc.description]
00011 
00012   Type:             [outport.type]
00013 
00014   InterfaceType:    [outport.interfaceType]
00015 
00016   DataflowType:     [outport.dataflowType]
00017 
00018   SubscriptionType: [outport.subscriptionType]
00019 
00020   MaxOut: 
00021 
00022 [endif]
00023 [endfor]
00024 """

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.

Classes

Variables

Variable Documentation