README_gen Namespace Reference

Classes
class	README_gen

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

Variable Documentation

configuration

string README_gen.configuration

Initial value:

=  """Configuration:
[for config in configurationSet.configuration]
  Name:         [config.name]

  Description:  [config.rtcDoc::doc.description]

  Type:         [config.type]

  DefaultValue: [config.defaultValue]

  Range:        [config.rtcDoc::doc.range]

  Unit:         [config.rtcDoc::doc.unit]

  Constraint:   [config.rtcDoc::doc.constraint]


[endfor]"""

Definition at line 171 of file README_gen.py.

inport

string README_gen.inport

Initial value:

=  """InPorts:
[for inport in dataPorts]
[if inport.portType is DataInPort]
  Name:             [inport.name]

  VarName:          [inport.rtcExt::varname]

  PortNumber:       [inport.rtcDoc::doc.number]

  Description:      [inport.rtcDoc::doc.description]

  Type:             [inport.type]

  InterfaceType:    [inport.interfaceType]

  DataflowType:     [inport.dataflowType]

  SubscriptionType: [inport.subscriptionType]

  MaxOut: 

[endif]
[endfor]
"""

Definition at line 90 of file README_gen.py.

module

string README_gen.module

Initial value:

=  """Basic Information:
  Description: [basicInfo.description]

  Version:     [basicInfo.version]

  Author:      [basicInfo.vendor]

  Category:    [basicInfo.category]

  Comp. Type:  [basicInfo.componentType]

  Act. Type:   [basicInfo.activityType]

  MAX Inst.:   [basicInfo.maxInstances]

  Lang:        
  Lang Type:   
"""

Definition at line 71 of file README_gen.py.

outport

string README_gen.outport

Initial value:

=  """OutPorts:
[for outport in dataPorts]
[if outport.portType is DataOutPort]
  Name:             [outport.name]

  VarName:          [outport.rtcExt::varname]

  PortNumber:       [outport.rtcDoc::doc.number]

  Description:      [outport.rtcDoc::doc.description]

  Type:             [outport.type]

  InterfaceType:    [outport.interfaceType]

  DataflowType:     [outport.dataflowType]

  SubscriptionType: [outport.subscriptionType]

  MaxOut: 

[endif]
[endfor]
"""

Definition at line 115 of file README_gen.py.

readme

string README_gen.readme

Definition at line 24 of file README_gen.py.

service

string README_gen.service

Definition at line 139 of file README_gen.py.