Skip to content

Roof Controller

roof_controller special

clear_errors()

clear errors

Returns:

Type Description
None

None

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

    Returns:
        None
    """

get_all_caddy_element_ids()

Gets all caddy elements

Returns:

Type Description
List[int]

element ID list (List[int])

Source code in roof_controller/__init__.py
def get_all_caddy_element_ids() -> List[int]:
    """Gets all caddy elements 
    Args:

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

get_edge_length(element_id, edge_type)

Gets the edge length

Parameters:

Name Type Description Default
element_id int

element_id

required
edge_type str

edge_type

required

Returns:

Type Description
float

edge length (float)

Source code in roof_controller/__init__.py
def get_edge_length(element_id: int, edge_type: str) -> float:
    """Gets the edge length 
    Args:
        element_id ( int): element_id
        edge_type ( str): edge_type

    Returns:
        edge length (float)
    """

get_last_error(a0)

get last error

Parameters:

Name Type Description Default
a0 int

a0

required

Returns:

Type Description
str

str

Source code in roof_controller/__init__.py
def get_last_error(a0: int) -> str:
    """get last error
    Args:
        a0 ( int): a0

    Returns:
        str
    """

get_profile_length(element_id)

Gets the profile length

Parameters:

Name Type Description Default
element_id int

element_id

required

Returns:

Type Description
float

profile length (float)

Source code in roof_controller/__init__.py
def get_profile_length(element_id: int) -> float:
    """Gets the profile length 
    Args:
        element_id ( int): element_id

    Returns:
        profile length (float)
    """