idmtools.core.interfaces.entity_container module

EntityContainer definition. EntityContainer provides an envelope for a Parent to container a list of sub-items.

Copyright 2021, Bill & Melinda Gates Foundation. All rights reserved.

class idmtools.core.interfaces.entity_container.EntityContainer(children: List[IEntity] = None)

Bases: list

EntityContainer is a wrapper classes used by Experiments and Suites to wrap their children.

It provides utilities to set status on entities

__init__(children: List[IEntity] = None)

Initialize the EntityContainer.

Parameters:

children – Children to initialize with

set_status(status: EntityStatus)

Set status on all the children.

Parameters:

status – Status to set

Returns:

None

set_status_for_item(item_id, status: EntityStatus)

Set status for specific sub-item.

Parameters:

• item_id – Item id to set status for

• status – Status to set

Returns:

None

Raises:

ValueError when the item_id is not in the children list –