Skip to content

Material Controller

material_controller special

clear_errors()

clear errors

Returns:

Type Description
None

None

Source code in material_controller/__init__.py
def clear_errors() -> None:
    """clear errors
    Args:

    Returns:
        None
    """

create_material(name)

Creates new material

Parameters:

Name Type Description Default
name str

name

required

Returns:

Type Description
int

material ID (int)

Source code in material_controller/__init__.py
def create_material(name: str) -> int:
    """Creates new material 
    Args:
        name ( str): name

    Returns:
        material ID (int)
    """

get_all_materials()

Gets all the materials

Returns:

Type Description
List[int]

material ID list (List[int])

Source code in material_controller/__init__.py
def get_all_materials() -> List[int]:
    """Gets all the materials 
    Args:

    Returns:
        material ID list (List[int])
    """

get_burn_off_rate(material_id)

Gets the material burn-off rate

Parameters:

Name Type Description Default
material_id int

material_id

required

Returns:

Type Description
float

material burn off rate (float)

Source code in material_controller/__init__.py
def get_burn_off_rate(material_id: int) -> float:
    """Gets the material burn-off rate 
    Args:
        material_id ( int): material_id

    Returns:
        material burn off rate (float)
    """

get_code(material_id)

Gets the material code

Parameters:

Name Type Description Default
material_id int

material_id

required

Returns:

Type Description
str

material code (str)

Source code in material_controller/__init__.py
def get_code(material_id: int) -> str:
    """Gets the material code 
    Args:
        material_id ( int): material_id

    Returns:
        material code (str)
    """

get_composition(a0)

get composition

Parameters:

Name Type Description Default
a0 int

a0

required

Returns:

Type Description
str

str

Source code in material_controller/__init__.py
def get_composition(a0: int) -> str:
    """get composition
    Args:
        a0 ( int): a0

    Returns:
        str
    """

get_drop_forming_class(material_id)

Gets the material drop forming class

Parameters:

Name Type Description Default
material_id int

material_id

required

Returns:

Type Description
str

material drop forming class (str)

Source code in material_controller/__init__.py
def get_drop_forming_class(material_id: int) -> str:
    """Gets the material drop forming class 
    Args:
        material_id ( int): material_id

    Returns:
        material drop forming class (str)
    """

get_fire_resistance_class(material_id)

Gets the material fire resistance class

Parameters:

Name Type Description Default
material_id int

material_id

required

Returns:

Type Description
str

material fire resistance class (str)

Source code in material_controller/__init__.py
def get_fire_resistance_class(material_id: int) -> str:
    """Gets the material fire resistance class 
    Args:
        material_id ( int): material_id

    Returns:
        material fire resistance class (str)
    """

get_grade(a0)

get grade

Parameters:

Name Type Description Default
a0 int

a0

required

Returns:

Type Description
str

str

Source code in material_controller/__init__.py
def get_grade(a0: int) -> str:
    """get grade
    Args:
        a0 ( int): a0

    Returns:
        str
    """

get_group(material_id)

Gets the material group

Parameters:

Name Type Description Default
material_id int

material_id

required

Returns:

Type Description
str

material group (str)

Source code in material_controller/__init__.py
def get_group(material_id: int) -> str:
    """Gets the material group 
    Args:
        material_id ( int): material_id

    Returns:
        material group (str)
    """

get_heat_capacity(material_id)

Gets the material heat capacity

Parameters:

Name Type Description Default
material_id int

material_id

required

Returns:

Type Description
float

material heat capacity (float)

Source code in material_controller/__init__.py
def get_heat_capacity(material_id: int) -> float:
    """Gets the material heat capacity 
    Args:
        material_id ( int): material_id

    Returns:
        material heat capacity (float)
    """

get_last_error(error_code)

Gets the last error

Parameters:

Name Type Description Default
error_code int

error_code

required

Returns:

Type Description
str

error string (str)

Source code in material_controller/__init__.py
def get_last_error(error_code: int) -> str:
    """Gets the last error 
    Args:
        error_code ( int): error_code

    Returns:
        error string (str)
    """

get_material_id(material_name)

Gets the material with a given name

Parameters:

Name Type Description Default
material_name str

material_name

required

Returns:

Type Description
int

material ID (int)

Source code in material_controller/__init__.py
def get_material_id(material_name: str) -> int:
    """Gets the material with a given name 
    Args:
        material_name ( str): material_name

    Returns:
        material ID (int)
    """

get_modulus_elasticity_1(material_id)

Gets the material modulus of elasticity 1

Parameters:

Name Type Description Default
material_id int

material_id

required

Returns:

Type Description
float

material modulus of elasticity 1 (float)

Source code in material_controller/__init__.py
def get_modulus_elasticity_1(material_id: int) -> float:
    """Gets the material modulus of elasticity 1 
    Args:
        material_id ( int): material_id

    Returns:
        material modulus of elasticity 1 (float)
    """

get_modulus_elasticity_2(material_id)

Gets the material modulus of elasticity 2

Parameters:

Name Type Description Default
material_id int

material_id

required

Returns:

Type Description
float

material modulus of elasticity 2 (float)

Source code in material_controller/__init__.py
def get_modulus_elasticity_2(material_id: int) -> float:
    """Gets the material modulus of elasticity 2 
    Args:
        material_id ( int): material_id

    Returns:
        material modulus of elasticity 2 (float)
    """

get_modulus_elasticity_3(material_id)

Gets the material modulus of elasticity 3

Parameters:

Name Type Description Default
material_id int

material_id

required

Returns:

Type Description
float

material modulus of elasticity 3 (float)

Source code in material_controller/__init__.py
def get_modulus_elasticity_3(material_id: int) -> float:
    """Gets the material modulus of elasticity 3 
    Args:
        material_id ( int): material_id

    Returns:
        material modulus of elasticity 3 (float)
    """

get_name(material_id)

Gets the material name

Parameters:

Name Type Description Default
material_id int

material_id

required

Returns:

Type Description
str

material name (str)

Source code in material_controller/__init__.py
def get_name(material_id: int) -> str:
    """Gets the material name 
    Args:
        material_id ( int): material_id

    Returns:
        material name (str)
    """

get_price(material_id)

Gets the material price

Parameters:

Name Type Description Default
material_id int

material_id

required

Returns:

Type Description
float

material price (float)

Source code in material_controller/__init__.py
def get_price(material_id: int) -> float:
    """Gets the material price 
    Args:
        material_id ( int): material_id

    Returns:
        material price (float)
    """

get_price_type(material_id)

Sets the material price type

Parameters:

Name Type Description Default
material_id int

material_id

required

Returns:

Type Description
str

material price type (str)

Source code in material_controller/__init__.py
def get_price_type(material_id: int) -> str:
    """Sets the material price type 
    Args:
        material_id ( int): material_id

    Returns:
        material price type (str)
    """

get_quality(a0)

get quality

Parameters:

Name Type Description Default
a0 int

a0

required

Returns:

Type Description
str

str

Source code in material_controller/__init__.py
def get_quality(a0: int) -> str:
    """get quality
    Args:
        a0 ( int): a0

    Returns:
        str
    """

get_shear_modulus_1(material_id)

Gets the material shear modulus 1

Parameters:

Name Type Description Default
material_id int

material_id

required

Returns:

Type Description
float

material shear modulus 1 (float)

Source code in material_controller/__init__.py
def get_shear_modulus_1(material_id: int) -> float:
    """Gets the material shear modulus 1 
    Args:
        material_id ( int): material_id

    Returns:
        material shear modulus 1 (float)
    """

get_shear_modulus_2(material_id)

Gets the material shear modulus 2

Parameters:

Name Type Description Default
material_id int

material_id

required

Returns:

Type Description
float

material shear modulus 2 (float)

Source code in material_controller/__init__.py
def get_shear_modulus_2(material_id: int) -> float:
    """Gets the material shear modulus 2 
    Args:
        material_id ( int): material_id

    Returns:
        material shear modulus 2 (float)
    """

get_short_name(a0)

get short name

Parameters:

Name Type Description Default
a0 int

a0

required

Returns:

Type Description
str

str

Source code in material_controller/__init__.py
def get_short_name(a0: int) -> str:
    """get short name
    Args:
        a0 ( int): a0

    Returns:
        str
    """

get_smoke_class(material_id)

Gets the material smoke class

Parameters:

Name Type Description Default
material_id int

material_id

required

Returns:

Type Description
str

material smoke class (str)

Source code in material_controller/__init__.py
def get_smoke_class(material_id: int) -> str:
    """Gets the material smoke class 
    Args:
        material_id ( int): material_id

    Returns:
        material smoke class (str)
    """

get_thermal_conductivity(material_id)

Gets the material thermal conductivity

Parameters:

Name Type Description Default
material_id int

material_id

required

Returns:

Type Description
float

material thermal conductivity (float)

Source code in material_controller/__init__.py
def get_thermal_conductivity(material_id: int) -> float:
    """Gets the material thermal conductivity 
    Args:
        material_id ( int): material_id

    Returns:
        material thermal conductivity (float)
    """

get_u_max(material_id)

Gets the material U max

Parameters:

Name Type Description Default
material_id int

material_id

required

Returns:

Type Description
float

material U max (float)

Source code in material_controller/__init__.py
def get_u_max(material_id: int) -> float:
    """Gets the material U max 
    Args:
        material_id ( int): material_id

    Returns:
        material U max (float)
    """

get_u_min(material_id)

Gets the material U min

Parameters:

Name Type Description Default
material_id int

material_id

required

Returns:

Type Description
float

material U min (float)

Source code in material_controller/__init__.py
def get_u_min(material_id: int) -> float:
    """Gets the material U min 
    Args:
        material_id ( int): material_id

    Returns:
        material U min (float)
    """

get_weight(material_id)

Gets the material weight

Parameters:

Name Type Description Default
material_id int

material_id

required

Returns:

Type Description
float

material weight (float)

Source code in material_controller/__init__.py
def get_weight(material_id: int) -> float:
    """Gets the material weight 
    Args:
        material_id ( int): material_id

    Returns:
        material weight (float)
    """

get_weight_type(material_id)

Gets the material weight type

Parameters:

Name Type Description Default
material_id int

material_id

required

Returns:

Type Description
str

material weight type (str)

Source code in material_controller/__init__.py
def get_weight_type(material_id: int) -> str:
    """Gets the material weight type 
    Args:
        material_id ( int): material_id

    Returns:
        material weight type (str)
    """

set_burn_off_rate(material_id, burn_off_rate)

Sets the material burn-off rate

Parameters:

Name Type Description Default
material_id int

material_id

required
burn_off_rate float

burn_off_rate

required

Returns:

Type Description
None

None

Source code in material_controller/__init__.py
def set_burn_off_rate(material_id: int, burn_off_rate: float) -> None:
    """Sets the material burn-off rate 
    Args:
        material_id ( int): material_id
        burn_off_rate ( float): burn_off_rate

    Returns:
        None
    """

set_code(material_id, code)

Sets the material code

Parameters:

Name Type Description Default
material_id int

material_id

required
code str

code

required

Returns:

Type Description
None

None

Source code in material_controller/__init__.py
def set_code(material_id: int, code: str) -> None:
    """Sets the material code 
    Args:
        material_id ( int): material_id
        code ( str): code

    Returns:
        None
    """

set_composition(a0, a1)

set composition

Parameters:

Name Type Description Default
a0 int

a0

required
a1 str

a1

required

Returns:

Type Description
None

None

Source code in material_controller/__init__.py
def set_composition(a0: int, a1: str) -> None:
    """set composition
    Args:
        a0 ( int): a0
        a1 ( str): a1

    Returns:
        None
    """

set_drop_forming_class(material_id, drop_forming_class)

Sets the material drop forming class

Parameters:

Name Type Description Default
material_id int

material_id

required
drop_forming_class str

drop_forming_class

required

Returns:

Type Description
None

None

Source code in material_controller/__init__.py
def set_drop_forming_class(material_id: int, drop_forming_class: str) -> None:
    """Sets the material drop forming class 
    Args:
        material_id ( int): material_id
        drop_forming_class ( str): drop_forming_class

    Returns:
        None
    """

set_fire_resistance_class(material_id, fire_resistance_class)

Sets the material fire resistance class

Parameters:

Name Type Description Default
material_id int

material_id

required
fire_resistance_class str

fire_resistance_class

required

Returns:

Type Description
None

None

Source code in material_controller/__init__.py
def set_fire_resistance_class(material_id: int, fire_resistance_class: str) -> None:
    """Sets the material fire resistance class 
    Args:
        material_id ( int): material_id
        fire_resistance_class ( str): fire_resistance_class

    Returns:
        None
    """

set_grade(a0, a1)

set grade

Parameters:

Name Type Description Default
a0 int

a0

required
a1 str

a1

required

Returns:

Type Description
None

None

Source code in material_controller/__init__.py
def set_grade(a0: int, a1: str) -> None:
    """set grade
    Args:
        a0 ( int): a0
        a1 ( str): a1

    Returns:
        None
    """

set_group(material_id, group)

Sets the material group

Parameters:

Name Type Description Default
material_id int

material_id

required
group str

group

required

Returns:

Type Description
None

None

Source code in material_controller/__init__.py
def set_group(material_id: int, group: str) -> None:
    """Sets the material group 
    Args:
        material_id ( int): material_id
        group ( str): group

    Returns:
        None
    """

set_heat_capacity(material_id, heat_capacity)

Sets the material heat capacity

Parameters:

Name Type Description Default
material_id int

material_id

required
heat_capacity float

heat_capacity

required

Returns:

Type Description
None

None

Source code in material_controller/__init__.py
def set_heat_capacity(material_id: int, heat_capacity: float) -> None:
    """Sets the material heat capacity 
    Args:
        material_id ( int): material_id
        heat_capacity ( float): heat_capacity

    Returns:
        None
    """

set_modulus_elasticity_1(material_id, modulus_elasticity1)

Sets the material modulus of elasticity 1

Parameters:

Name Type Description Default
material_id int

material_id

required
modulus_elasticity1 float

modulus_elasticity1

required

Returns:

Type Description
None

None

Source code in material_controller/__init__.py
def set_modulus_elasticity_1(material_id: int, modulus_elasticity1: float) -> None:
    """Sets the material modulus of elasticity 1 
    Args:
        material_id ( int): material_id
        modulus_elasticity1 ( float): modulus_elasticity1

    Returns:
        None
    """

set_modulus_elasticity_2(material_id, modulus_elasticity2)

Sets the material modulus of elasticity 2

Parameters:

Name Type Description Default
material_id int

material_id

required
modulus_elasticity2 float

modulus_elasticity2

required

Returns:

Type Description
None

None

Source code in material_controller/__init__.py
def set_modulus_elasticity_2(material_id: int, modulus_elasticity2: float) -> None:
    """Sets the material modulus of elasticity 2 
    Args:
        material_id ( int): material_id
        modulus_elasticity2 ( float): modulus_elasticity2

    Returns:
        None
    """

set_modulus_elasticity_3(material_id, modulus_elasticity3)

Sets the material modulus of elasticity 3

Parameters:

Name Type Description Default
material_id int

material_id

required
modulus_elasticity3 float

modulus_elasticity3

required

Returns:

Type Description
None

None

Source code in material_controller/__init__.py
def set_modulus_elasticity_3(material_id: int, modulus_elasticity3: float) -> None:
    """Sets the material modulus of elasticity 3 
    Args:
        material_id ( int): material_id
        modulus_elasticity3 ( float): modulus_elasticity3

    Returns:
        None
    """

set_name(material_id, name)

Sets the material name

Parameters:

Name Type Description Default
material_id int

material_id

required
name str

name

required

Returns:

Type Description
None

None

Source code in material_controller/__init__.py
def set_name(material_id: int, name: str) -> None:
    """Sets the material name 
    Args:
        material_id ( int): material_id
        name ( str): name

    Returns:
        None
    """

set_price(material_id, price)

Sets the material price

Parameters:

Name Type Description Default
material_id int

material_id

required
price float

price

required

Returns:

Type Description
None

None

Source code in material_controller/__init__.py
def set_price(material_id: int, price: float) -> None:
    """Sets the material price 
    Args:
        material_id ( int): material_id
        price ( float): price

    Returns:
        None
    """

set_price_type(material_id, price_type)

Sets the material price type

Parameters:

Name Type Description Default
material_id int

material_id

required
price_type str

price_type

required

Returns:

Type Description
None

None

Source code in material_controller/__init__.py
def set_price_type(material_id: int, price_type: str) -> None:
    """Sets the material price type 
    Args:
        material_id ( int): material_id
        price_type ( str): price_type

    Returns:
        None
    """

set_quality(a0, a1)

set quality

Parameters:

Name Type Description Default
a0 int

a0

required
a1 str

a1

required

Returns:

Type Description
None

None

Source code in material_controller/__init__.py
def set_quality(a0: int, a1: str) -> None:
    """set quality
    Args:
        a0 ( int): a0
        a1 ( str): a1

    Returns:
        None
    """

set_shear_modulus_1(material_id, shear_modulus1)

Sets the material shear modulus 1

Parameters:

Name Type Description Default
material_id int

material_id

required
shear_modulus1 float

shear_modulus1

required

Returns:

Type Description
None

None

Source code in material_controller/__init__.py
def set_shear_modulus_1(material_id: int, shear_modulus1: float) -> None:
    """Sets the material shear modulus 1 
    Args:
        material_id ( int): material_id
        shear_modulus1 ( float): shear_modulus1

    Returns:
        None
    """

set_shear_modulus_2(material_id, shear_modulus2)

Sets the material shear modulus 2

Parameters:

Name Type Description Default
material_id int

material_id

required
shear_modulus2 float

shear_modulus2

required

Returns:

Type Description
None

None

Source code in material_controller/__init__.py
def set_shear_modulus_2(material_id: int, shear_modulus2: float) -> None:
    """Sets the material shear modulus 2 
    Args:
        material_id ( int): material_id
        shear_modulus2 ( float): shear_modulus2

    Returns:
        None
    """

set_smoke_class(material_id, smoke_class)

Sets the material smoke class

Parameters:

Name Type Description Default
material_id int

material_id

required
smoke_class str

smoke_class

required

Returns:

Type Description
None

None

Source code in material_controller/__init__.py
def set_smoke_class(material_id: int, smoke_class: str) -> None:
    """Sets the material smoke class 
    Args:
        material_id ( int): material_id
        smoke_class ( str): smoke_class

    Returns:
        None
    """

set_thermal_conductivity(material_id, thermal_conductivity)

Sets the material thermal conductivity

Parameters:

Name Type Description Default
material_id int

material_id

required
thermal_conductivity float

thermal_conductivity

required

Returns:

Type Description
None

None

Source code in material_controller/__init__.py
def set_thermal_conductivity(material_id: int, thermal_conductivity: float) -> None:
    """Sets the material thermal conductivity 
    Args:
        material_id ( int): material_id
        thermal_conductivity ( float): thermal_conductivity

    Returns:
        None
    """

set_u_max(material_id, u_max)

Sets the material U max

Parameters:

Name Type Description Default
material_id int

material_id

required
u_max float

u_max

required

Returns:

Type Description
None

None

Source code in material_controller/__init__.py
def set_u_max(material_id: int, u_max: float) -> None:
    """Sets the material U max 
    Args:
        material_id ( int): material_id
        u_max ( float): u_max

    Returns:
        None
    """

set_u_min(material_id, u_min)

Sets the material U min

Parameters:

Name Type Description Default
material_id int

material_id

required
u_min float

u_min

required

Returns:

Type Description
None

None

Source code in material_controller/__init__.py
def set_u_min(material_id: int, u_min: float) -> None:
    """Sets the material U min 
    Args:
        material_id ( int): material_id
        u_min ( float): u_min

    Returns:
        None
    """

set_weight(material_id, weight)

Sets the material weight

Parameters:

Name Type Description Default
material_id int

material_id

required
weight float

weight

required

Returns:

Type Description
None

None

Source code in material_controller/__init__.py
def set_weight(material_id: int, weight: float) -> None:
    """Sets the material weight 
    Args:
        material_id ( int): material_id
        weight ( float): weight

    Returns:
        None
    """

set_weight_type(material_id, weight_type)

Sets the material weight type

Parameters:

Name Type Description Default
material_id int

material_id

required
weight_type str

weight_type

required

Returns:

Type Description
None

None

Source code in material_controller/__init__.py
def set_weight_type(material_id: int, weight_type: str) -> None:
    """Sets the material weight type 
    Args:
        material_id ( int): material_id
        weight_type ( str): weight_type

    Returns:
        None
    """