carputils
Doxygen code documentation for the python framework controlling openCARP
Public Member Functions | List of all members
carputils.bundle.parfileadjustment._OCParam Class Reference

An object of this class represents an OpenCARP parameter. More...

Public Member Functions

def __init__ (self, param_line)
 A parameter object is initialized from the string used in the parameter list provided by OpenCARP. More...
 
def get_type_info (self)
 Get information about the type of the parameter. More...
 
def get_ext (self)
 Get the extension linked to the parameters if it exists. More...
 

Detailed Description

An object of this class represents an OpenCARP parameter.

Constructor & Destructor Documentation

◆ __init__()

def carputils.bundle.parfileadjustment._OCParam.__init__ (   self,
  param_line 
)

A parameter object is initialized from the string used in the parameter list provided by OpenCARP.

Member Function Documentation

◆ get_ext()

def carputils.bundle.parfileadjustment._OCParam.get_ext (   self)

Get the extension linked to the parameters if it exists.

Returns
the extension of the parameter if it exists, None if not

◆ get_type_info()

def carputils.bundle.parfileadjustment._OCParam.get_type_info (   self)

Get information about the type of the parameter.

Returns
Type of the parameter(s) and whether it is a list of
parameters

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