Material Controller
create_material(name)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str |
material name |
required |
Returns:
Type | Description |
---|---|
int |
material ID |
Source code in material_controller/__init__.py
def create_material(name: str) -> int:
"""
Args:
name (str): material name
Returns:
int: material ID
"""
get_all_materials()
Available for script filled attributes
Returns:
Type | Description |
---|---|
List[int] |
all materials |
Source code in material_controller/__init__.py
def get_all_materials() -> List[int]:
"""
[:information_source: Available for script filled attributes](#){.mark-text}
Returns:
List[int]: all materials
"""
get_burn_off_rate(material_id)
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
material_id |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
float |
value |
Source code in material_controller/__init__.py
def get_burn_off_rate(material_id: int) -> float:
"""
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
material_id (int): element ID
Returns:
float: value
"""
get_code(material_id)
get material code
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
material_id |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
str |
material code |
Source code in material_controller/__init__.py
def get_code(material_id: int) -> str:
"""get material code
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
material_id (int): element ID
Returns:
str: material code
"""
get_composition(material_id)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
material_id |
int |
material ID |
required |
Returns:
Type | Description |
---|---|
str |
composition |
Source code in material_controller/__init__.py
def get_composition(material_id: int) -> str:
"""
Args:
material_id int: material ID
Returns:
str: composition
"""
get_drop_forming_class(material_id)
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
material_id |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
str |
description |
Source code in material_controller/__init__.py
def get_drop_forming_class(material_id: int) -> str:
"""
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
material_id (int): element ID
Returns:
str: _description_
"""
get_fire_resistance_class(material_id)
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
material_id |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
str |
description |
Source code in material_controller/__init__.py
def get_fire_resistance_class(material_id: int) -> str:
"""
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
material_id (int): element ID
Returns:
str: _description_
"""
get_grade(material_id)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
material_id |
int |
material ID |
required |
Returns:
Type | Description |
---|---|
str |
grade |
Source code in material_controller/__init__.py
def get_grade(material_id: int) -> str:
"""
Args:
material_id int: material ID
Returns:
str: grade
"""
get_group(material_id)
get material group
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
material_id |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
str |
material group |
Source code in material_controller/__init__.py
def get_group(material_id: int) -> str:
"""get material group
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
material_id (int): element ID
Returns:
str: material group
"""
get_heat_capacity(material_id)
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
material_id |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
float |
value |
Source code in material_controller/__init__.py
def get_heat_capacity(material_id: int) -> float:
"""
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
material_id (int): element ID
Returns:
float: value
"""
get_material_id(name)
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str |
material name |
required |
Source code in material_controller/__init__.py
def get_material_id(name: str) -> None:
"""
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
name (str): material name
"""
get_modulus_elasticity_1(material_id)
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
material_id |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
float |
value |
Source code in material_controller/__init__.py
def get_modulus_elasticity_1(material_id: int) -> float:
"""
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
material_id (int): element ID
Returns:
float: value
"""
get_modulus_elasticity_2(material_id)
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
material_id |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
float |
value |
Source code in material_controller/__init__.py
def get_modulus_elasticity_2(material_id: int) -> float:
"""
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
material_id (int): element ID
Returns:
float: value
"""
get_modulus_elasticity_3(material_id)
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
material_id |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
float |
value |
Source code in material_controller/__init__.py
def get_modulus_elasticity_3(material_id: int) -> float:
"""
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
material_id (int): element ID
Returns:
float: value
"""
get_name(material_id)
Get material name
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
material_id |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
str |
material name |
Source code in material_controller/__init__.py
def get_name(material_id: int) -> str:
"""Get material name
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
material_id (int): element ID
Returns:
str: material name
"""
get_price(material_id)
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
material_id |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
float |
value |
Source code in material_controller/__init__.py
def get_price(material_id: int) -> float:
"""
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
material_id (int): element ID
Returns:
float: value
"""
get_price_type(material_id)
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
material_id |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
str |
description |
Source code in material_controller/__init__.py
def get_price_type(material_id: int) -> str:
"""
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
material_id (int): element ID
Returns:
str: _description_
"""
get_quality(material_id)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
material_id |
int |
material ID |
required |
Returns:
Type | Description |
---|---|
str |
quality |
Source code in material_controller/__init__.py
def get_quality(material_id: int) -> str:
"""
Args:
material_id int: material ID
Returns:
str: quality
"""
get_shear_modulus_1(material_id)
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
material_id |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
float |
value |
Source code in material_controller/__init__.py
def get_shear_modulus_1(material_id: int) -> float:
"""
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
material_id (int): element ID
Returns:
float: value
"""
get_shear_modulus_2(material_id)
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
material_id |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
float |
value |
Source code in material_controller/__init__.py
def get_shear_modulus_2(material_id: int) -> float:
"""
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
material_id (int): element ID
Returns:
float: value
"""
get_smoke_class(material_id)
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
material_id |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
str |
description |
Source code in material_controller/__init__.py
def get_smoke_class(material_id: int) -> str:
"""
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
material_id (int): element ID
Returns:
str: _description_
"""
get_thermal_conductivity(material_id)
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
material_id |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
float |
value |
Source code in material_controller/__init__.py
def get_thermal_conductivity(material_id: int) -> float:
"""
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
material_id (int): element ID
Returns:
float: value
"""
get_u_max(material_id)
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
material_id |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
float |
value |
Source code in material_controller/__init__.py
def get_u_max(material_id: int) -> float:
"""
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
material_id (int): element ID
Returns:
float: value
"""
get_u_min(material_id)
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
material_id |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
float |
value |
Source code in material_controller/__init__.py
def get_u_min(material_id: int) -> float:
"""
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
material_id (int): element ID
Returns:
float: value
"""
get_weight(material_id)
get material weight
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
material_id |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
float |
value |
Source code in material_controller/__init__.py
def get_weight(material_id: int) -> float:
"""get material weight
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
material_id (int): element ID
Returns:
float: value
"""
get_weight_type(material_id)
gets the material weight type
Available for script filled attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
material_id |
int |
element ID |
required |
Returns:
Type | Description |
---|---|
str |
weight type |
Source code in material_controller/__init__.py
def get_weight_type(material_id: int) -> str:
"""gets the material weight type
[:information_source: Available for script filled attributes](#){.mark-text}
Args:
material_id (int): element ID
Returns:
str: weight type
"""
set_burn_off_rate(material_id, value)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
material_id |
int |
element ID |
required |
value |
float |
value |
required |
Source code in material_controller/__init__.py
def set_burn_off_rate(material_id: int, value: float) -> None:
"""
Args:
material_id (int): element ID
value (float): value
"""
set_code(material_id, value)
set material code
Parameters:
Name | Type | Description | Default |
---|---|---|---|
material_id |
int |
element ID |
required |
value |
str |
material code |
required |
Source code in material_controller/__init__.py
def set_code(material_id: int, value: str) -> None:
"""set material code
Args:
material_id (int): element ID
value (str): material code
"""
set_composition(material_id, composition)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
material_id |
int |
material ID |
required |
composition |
str |
composition |
required |
Source code in material_controller/__init__.py
def set_composition(material_id: int, composition: str) -> None:
"""
Args:
material_id int: material ID
composition (str): composition
"""
set_drop_forming_class(material_id, value)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
material_id |
int |
element ID |
required |
value |
str |
description |
required |
Source code in material_controller/__init__.py
def set_drop_forming_class(material_id: int, value: str) -> None:
"""
Args:
material_id (int): element ID
value (str): _description_
"""
set_fire_resistance_class(material_id, value)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
material_id |
int |
element ID |
required |
value |
str |
description |
required |
Source code in material_controller/__init__.py
def set_fire_resistance_class(material_id: int, value: str) -> None:
"""
Args:
material_id (int): element ID
value (str): _description_
"""
set_grade(material_id, grade)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
material_id |
int |
material ID |
required |
grade |
str |
grade |
required |
Source code in material_controller/__init__.py
def set_grade(material_id: int, grade: str) -> None:
"""
Args:
material_id int: material ID
grade (str): grade
"""
set_group(material_id, value)
set material group
Parameters:
Name | Type | Description | Default |
---|---|---|---|
material_id |
int |
element ID |
required |
value |
str |
material group (name) |
required |
Source code in material_controller/__init__.py
def set_group(material_id: int, value: str) -> None:
"""set material group
Args:
material_id (int): element ID
value (str): material group (name)
"""
set_heat_capacity(material_id, value)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
material_id |
int |
element ID |
required |
value |
float |
value |
required |
Source code in material_controller/__init__.py
def set_heat_capacity(material_id: int, value: float) -> None:
"""
Args:
material_id (int): element ID
value (float): value
"""
set_modulus_elasticity_1(material_id, value)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
material_id |
int |
element ID |
required |
value |
float |
value |
required |
Source code in material_controller/__init__.py
def set_modulus_elasticity_1(material_id: int, value: float) -> None:
"""
Args:
material_id (int): element ID
value (float): value
"""
set_modulus_elasticity_2(material_id, value)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
material_id |
int |
element ID |
required |
value |
float |
value |
required |
Source code in material_controller/__init__.py
def set_modulus_elasticity_2(material_id: int, value: float) -> None:
"""
Args:
material_id (int): element ID
value (float): value
"""
set_modulus_elasticity_3(material_id, value)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
material_id |
int |
element ID |
required |
value |
float |
value |
required |
Source code in material_controller/__init__.py
def set_modulus_elasticity_3(material_id: int, value: float) -> None:
"""
Args:
material_id (int): element ID
value (float): value
"""
set_name(material_id, value)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
material_id |
int |
element ID |
required |
value |
str |
a material name |
required |
Source code in material_controller/__init__.py
def set_name(material_id: int, value: str) -> None:
"""
Args:
material_id (int): element ID
value (str): a material name
"""
set_price(material_id, value)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
material_id |
int |
element ID |
required |
value |
float |
value |
required |
Source code in material_controller/__init__.py
def set_price(material_id: int, value: float) -> None:
"""
Args:
material_id (int): element ID
value (float): value
"""
set_price_type(material_id, value)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
material_id |
int |
element ID |
required |
value |
str |
description |
required |
Source code in material_controller/__init__.py
def set_price_type(material_id: int, value: str) -> None:
"""
Args:
material_id (int): element ID
value (str): _description_
"""
set_quality(material_id, quality)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
material_id |
int |
material ID |
required |
quality |
str |
quality |
required |
Source code in material_controller/__init__.py
def set_quality(material_id: int, quality: str) -> None:
"""
Args:
material_id int: material ID
quality (str): quality
"""
set_shear_modulus_1(material_id, value)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
material_id |
int |
element ID |
required |
value |
float |
value |
required |
Source code in material_controller/__init__.py
def set_shear_modulus_1(material_id: int, value: float) -> None:
"""
Args:
material_id (int): element ID
value (float): value
"""
set_shear_modulus_2(material_id, value)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
material_id |
int |
element ID |
required |
value |
float |
value |
required |
Source code in material_controller/__init__.py
def set_shear_modulus_2(material_id: int, value: float) -> None:
"""
Args:
material_id (int): element ID
value (float): value
"""
set_smoke_class(material_id, value)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
material_id |
int |
element ID |
required |
value |
str |
description |
required |
Source code in material_controller/__init__.py
def set_smoke_class(material_id: int, value: str) -> None:
"""
Args:
material_id (int): element ID
value (str): _description_
"""
set_thermal_conductivity(material_id, value)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
material_id |
int |
element ID |
required |
value |
float |
value |
required |
Source code in material_controller/__init__.py
def set_thermal_conductivity(material_id: int, value: float) -> None:
"""
Args:
material_id (int): element ID
value (float): value
"""
set_u_max(material_id, value)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
material_id |
int |
element ID |
required |
value |
float |
value |
required |
Source code in material_controller/__init__.py
def set_u_max(material_id: int, value: float) -> None:
"""
Args:
material_id (int): element ID
value (float): value
"""
set_u_min(material_id, value)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
material_id |
int |
element ID |
required |
value |
float |
value |
required |
Source code in material_controller/__init__.py
def set_u_min(material_id: int, value: float) -> None:
"""
Args:
material_id (int): element ID
value (float): value
"""
set_weight(material_id, value)
set material weight
Parameters:
Name | Type | Description | Default |
---|---|---|---|
material_id |
int |
element ID |
required |
value |
float |
value |
required |
Source code in material_controller/__init__.py
def set_weight(material_id: int, value: float) -> None:
"""set material weight
Args:
material_id (int): element ID
value (float): value
"""
set_weight_type(element, value)
sets the material weight type
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
int |
element ID |
required |
value |
str |
weight type |
required |
Source code in material_controller/__init__.py
def set_weight_type(element: int, value: str) -> None:
"""sets the material weight type
Args:
element (int): element ID
value (str): weight type
"""