carputils.settings.solver.SolverOptions Class Reference

A container class with some convenience methods for setting up openCARP options. More...

Public Member Functions
def	__init__ (self)
def	__setattr__ (self, attr, value)
	Custom attribute access code providing order logging. More...
def	__getattr__ (self, attr)
def	args (self)
	Return list of arguments for use in subprocess. More...
def	update_from_args (self, args)
	Update entries from a provided argument list. More...
def	add_parfile (self, path)
	Add a parfile to the argument list. More...

Detailed Description

A container class with some convenience methods for setting up openCARP options.

To add options:

>>> opts = SolverOptions()
>>> # Set directly
>>> opts.option_1 = 10
>>> opts.option_2 = 100
>>> # Set from arg list
>>> opts.update_from_args(['-opt3', 1000, '-opt4', 0.1])
>>> # Add parfile to command line
>>> opts.add_parfile('new.par')

To generate the argument list:

>>> opts.args()
['+F', 'new.par',
 '-option_1', 10,
 '-option_2', 100,
 '-opt3', 1000,
 '-opt4', 0.1]

Constructor & Destructor Documentation

__init__()

def carputils.settings.solver.SolverOptions.__init__

(

self

)

Member Function Documentation

__getattr__()

def carputils.settings.solver.SolverOptions.__getattr__	(		self,
			attr
	)

__setattr__()

def carputils.settings.solver.SolverOptions.__setattr__	(		self,
			attr,
			value
	)

Custom attribute access code providing order logging.

add_parfile()

def carputils.settings.solver.SolverOptions.add_parfile	(		self,
			path
	)

Add a parfile to the argument list.

args()

def carputils.settings.solver.SolverOptions.args

(

self

)

Return list of arguments for use in subprocess.

update_from_args()

def carputils.settings.solver.SolverOptions.update_from_args	(		self,
			args
	)

Update entries from a provided argument list.

It is expected that even entries in the provided list are the argument names, and start with a '-', and that odd entries are the corresponding values.

---

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

• carputils/settings/solver.py