Reference

ImxSingleFile

Represents an IMX file that contains project situations or just a situation.

Parameters:

Name	Type	Description	Default
imx_file_path	Path | str	Path to the IMX container.	required

Attributes:

Name	Type	Description
file	ImxFile	The IMX file.
situation	ImxSituation | None	The IMX Situation.
new_situation	ImxSituation | None	The IMX NewSituation.
initial_situation	ImxSituation | None	The IMX InitialSituation.

ImxSituation

Bases: ImxRepo

Represents a IMX Situation.

Attributes:

Name	Type	Description
situation_type	ImxSituationEnum	imx situation Type

get_all()

Retrieves all objects in the tree.

Returns:

Type	Description
Iterable[ImxObject]	Iterable[ImxObject]: An iterable of all ImxObjects.

find(key)

Finds an object in the tree by its key or ImxObject.

Parameters:

Name	Type	Description	Default
key	str | ImxObject	The key or ImxObject to find.	required

Returns:

Type	Description
ImxObject | None	ImxObject | None: The found ImxObject, or None if not found.

get_types()

Retrieves all unique object types in the tree.

Returns:

Type	Description
list[str]	list[str]: A list of all unique object types.

get_by_types(object_types)

Retrieves objects of specified types from the tree.

Parameters:

Name	Type	Description	Default
object_types	list[str]	The list of object types to retrieve.	required

Returns:

Type	Description
list[ImxObject]	list[ImxObject]: The list of matching ImxObjects.

get_all_paths()

Retrieves all unique object paths in the tree.

Returns:

Type	Description
list[str]	list[str]: A list of all unique object paths.

get_by_paths(object_paths)

Retrieves objects of specified paths from the tree.

Parameters:

Name	Type	Description	Default
object_paths	list[str]	The list of object paths to retrieve.	required

Returns:

Type	Description
list[ImxObject]	list[ImxObject]: The list of matching ImxObjects.

get_keys()

Returns the set of keys currently in the tree dictionary.

Returns:

Type	Description
list[str]	frozenset[str]: The set of keys in the tree dictionary.

get_build_exceptions()

todo: make docs

get_pandas_df(object_type_or_path=None, puic_as_index=True)

Get Pandas dataframe of one value object type or limited view of all objects.

When using an object type or path, all properties will be flattened. When getting a dataframe of all objects, most attributes will be stripped except for some metadata. In both cases, it will include parent puic, path.

Parameters:

Name	Type	Description	Default
object_type_or_path	str | None	path or imx type to get df of	None
puic_as_index	bool	if true puic value will be the index	True

Returns:

Type	Description
DataFrame	pd.DataFrame: pandas dataframe of the object properties

get_pandas_df_dict(key_based_on_type=False)

Get a dictionary of Pandas dataframe of all type bases on keys or path.

Parameters:

Name	Type	Description	Default
key_based_on_type	bool	if true key based on type, else on path	False

Returns: dictionary of pandas dataframe

ImxSituationEnum

Bases: str, Enum

Valid situations in a imx project file.

InitialSituation = 'InitialSituation' class-attribute instance-attribute

The initial situation in a imx project file.

NewSituation = 'NewSituation' class-attribute instance-attribute

The initial situation in a imx project file.

Situation = 'Situation' class-attribute instance-attribute

A situation in a imx situation file.