core.utils.ParametersWrapper Class Reference

A pythonic wrapper to KratosMultiphysics.Parameters. More...

Inheritance diagram for core.utils.ParametersWrapper:

Collaboration diagram for core.utils.ParametersWrapper:

Public Member Functions
def	__init__ (self, params="{}")
def	__getitem__ (self, key)
def	__setitem__ (self, key, value)
def	__iter__ (self)
	Return an iterator over keys or indices. More...
def	__len__ (self)
def	__str__ (self)
def	__getattr__ (self, name)
	Expose methods defined in KratosMultiphysics.Parameters. More...
def	Get (self)
def	SetDefault (self, key, value=KratosMultiphysics.Parameters())

Detailed Description

A pythonic wrapper to KratosMultiphysics.Parameters.

The idea is to reduce boilerplate and improve call-site readability by
making Parameters more pythonic without breaking existing code.

Constructor & Destructor Documentation

__init__()

def core.utils.ParametersWrapper.__init__	(		self,
			params = "{}"
	)

Member Function Documentation

__getattr__()

def core.utils.ParametersWrapper.__getattr__	(		self,
			name
	)

Expose methods defined in KratosMultiphysics.Parameters.

__getitem__()

def core.utils.ParametersWrapper.__getitem__	(		self,
			key
	)

__iter__()

def core.utils.ParametersWrapper.__iter__

(

self

)

Return an iterator over keys or indices.

    This iterates over keys or indices, depending on if the Parameters
    instance is an array.

__len__()

def core.utils.ParametersWrapper.__len__

(

self

)

__setitem__()

def core.utils.ParametersWrapper.__setitem__	(		self,
			key,
			value
	)

__str__()

def core.utils.ParametersWrapper.__str__

(

self

)

Get()

def core.utils.ParametersWrapper.Get

(

self

)

SetDefault()

def core.utils.ParametersWrapper.SetDefault	(		self,
			key,
			value = KratosMultiphysics.Parameters()
	)

---

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

• /home/runner/work/Documentation/Documentation/master/applications/HDF5Application/python_scripts/core/utils.py