System

class System

Bases: CommonBaseModel

Represents a system within aircraft systems, detailing its specifications, functionalities, and interrelations.

name

The name of the system, acting as a unique identifier.

Type:: Optional[str]

description

A brief description of the system’s purpose and functionality.

Type:: Optional[str]

parameters

Operational or physical parameters associated with the system.

Type:: Optional[Dict[str, Any]]

diagram

Flow diagram of the system.

Type:: Optional[Dict[str, Any]]

metadata

Additional metadata providing context or details about the system.

Type:: Optional[Metadata]

subsystems

A list of sub-systems, if any, within this system.

Type:: Optional[List[System]]

requirements

Specific requirements associated with this system.

Type:: Optional[List[Requirement]]

performance

List of disciplines analyzing the system.

Type:: Optional[List[Discipline]]

behavior

Specific behaviors for the component.

Type:: Optional[List[Behavior]]

Raises:: ValueError – If any string field is empty, ensuring all systems have meaningful identifiers and descriptions.

Attributes Summary

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

Methods Summary

validate_non_empty_string(value)

Validates that the name and description fields are not empty or whitespace only.

Attributes Documentation

model_config: ClassVar[ConfigDict] = {'arbitrary_types_allowed': True, 'extra': 'allow', 'from_attributes': True, 'protected_namespaces': (), 'validate_assignment': True}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

Methods Documentation

classmethod validate_non_empty_string(value)

Validates that the name and description fields are not empty or whitespace only.

Parameters:: value (Optional[str]) – The value to validate.
Returns:: The validated string value.
Return type:: Optional[str]
Raises:: ValueError – If the input value is empty or consists only of whitespace.

Methods:

validate_non_empty_string(value)

Validates that the name and description fields are not empty or whitespace only.

Attributes:

__pydantic_setattr_handlers__

__setattr__ handlers.

classmethod validate_non_empty_string(value)

Validates that the name and description fields are not empty or whitespace only.

Parameters:: value (Optional[str]) – The value to validate.
Returns:: The validated string value.
Return type:: Optional[str]
Raises:: ValueError – If the input value is empty or consists only of whitespace.

class Config

Bases: object

Pydantic model configuration.

__pydantic_setattr_handlers__: ClassVar[Dict[str, Callable[[BaseModel, str, Any], None]]] = {}: __setattr__ handlers. Memoizing the handlers leads to a dramatic performance improvement in __setattr__