report.GetAttribute

class GetAttribute

Bases: GenericOperation

Retrieve an attribute from a data object.

This operation extracts the attribute specified by attr_name from the provided data object using Python’s built-in getattr function. If the attribute is not found, an AttributeError is raised, providing a clear error message.

Attributes

attr_name: str

The name of the attribute to retrieve from the data object.

Additional Constructors

classmethod from_file(filename)

Loads a Flow360BaseModel from .json, or .yaml file.

Parameters:

filename (str) – Full path to the .yaml or .json file to load the Flow360BaseModel from.

Returns:

An instance of the component class calling load.

Return type:

Flow360BaseModel

Example

>>> params = Flow360BaseModel.from_file(filename='folder/sim.json') 

Methods

calculate(data, case, cases, variables, new_variable_name)

Retrieves the attribute specified by attr_name from the given data object. Returns a tuple containing the original data, the cases list, and the extracted attribute value.

help(methods=False)

Prints message describing the fields and methods of a Flow360BaseModel.

Parameters:

methods (bool = False) – Whether to also print out information about object’s methods.

Return type:

None

Example

>>> params.help(methods=True) 

to_file(filename, **kwargs)

Exports Flow360BaseModel instance to .json or .yaml file

Parameters:

filename (str) – Full path to the .json or .yaml or file to save the Flow360BaseModel to.

Return type:

None

Example

>>> params.to_file(filename='folder/flow360.json')