CADETProcess.dataStructure.dataStructure.Structure

class CADETProcess.dataStructure.dataStructure.Structure

Bases: object

A class representing a structured data entity.

This class is designed to work in conjunction with the StructMeta metaclass to handle descriptors and related parameters.

Attributes:

_parametersdict

Dictionary of parameters associated with the instance.

_sized_parameterslist

List of parameters that have a size attribute.

_polynomial_parameterslist

List of parameters with fill_values attribute.

_required_parameterslist

List of parameters that have a default value of None.

property aggregated_parameters: Dict

dict: Aggregated parameters of the instance.

check_required_parameters() → bool

Verify if all required parameters are set.

Returns:

bool

True if all required parameters are set. False otherwise.

Warning:

If any of the required parameters are missing.

property missing_parameters: list

list: Parameters that are required but not set.

property parameters: dict

dict: Parameters of the instance.

property polynomial_parameters: Dict

dict: Polynomial parameters of the instance.

property required_parameters: list

list: Parameters that have no default value.

property sized_parameters: Dict

dict: Sized parameters of the instance.