carputils
Doxygen code documentation for the python framework controlling openCARP
Public Member Functions | Static Public Attributes | List of all members
carputils.model.lat.Lat Class Reference

Represents a single LAT argument to openCARP. More...

Inheritance diagram for carputils.model.lat.Lat:
carputils.model.general.AbstractModelComponent

Public Member Functions

def __init__ (self, ID, **kwargs)
 
def opts_formatted (self, index)
 Return the command line options for this model component. More...
 
- Public Member Functions inherited from carputils.model.general.AbstractModelComponent
def __init__ (self, **fields)
 
def update_opts (self, **fields)
 
def opts (self)
 Generator that yields field name - value pairs for the command line. More...
 

Static Public Attributes

string PRM_ARRAY = 'lats'
 
string PRM_LENGTH = 'num_LATs'
 
list FIELDS = ['ID', 'measurand', 'all', 'mode', 'threshold', 'method']
 
- Static Public Attributes inherited from carputils.model.general.AbstractModelComponent
 PRM_ARRAY = None
 
 PRM_LENGTH = None
 
list FIELDS = []
 

Detailed Description

Represents a single LAT argument to openCARP.

Parameters
IDlat file name **kwargs The remaining fields for the lats

Constructor & Destructor Documentation

◆ __init__()

def carputils.model.lat.Lat.__init__ (   self,
  ID,
**  kwargs 
)

Member Function Documentation

◆ opts_formatted()

def carputils.model.lat.Lat.opts_formatted (   self,
  index 
)

Return the command line options for this model component.

   Parameters
   ----------

index int The array index to use in generating the option list

Reimplemented from carputils.model.general.AbstractModelComponent.

Member Data Documentation

◆ FIELDS

list carputils.model.lat.Lat.FIELDS = ['ID', 'measurand', 'all', 'mode', 'threshold', 'method']
static

◆ PRM_ARRAY

string carputils.model.lat.Lat.PRM_ARRAY = 'lats'
static

◆ PRM_LENGTH

string carputils.model.lat.Lat.PRM_LENGTH = 'num_LATs'
static

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