Merge pull request #352 from python-accelerator-middle-layer/new-combined-function-magnet-holder-api

Implemented new CFM holder API

Author: JeanLucPons

pyaml/accelerator.py

@@ -6,8 +6,8 @@
 
 from .arrays.array import ArrayConfig
 from .common.element import Element, __pyaml_repr__
-from .common.element_holder import ElementHolder
 from .common.exception import PyAMLConfigException
+from .common.holders.element_holder import ElementHolder
 from .configuration import ConfigurationManager, UnsupportedConfigurationRootError
 from .configuration.factory import Factory
 from .control.controlsystem import ControlSystem

pyaml/apidoc/gen_api.py

@@ -26,23 +26,25 @@
     "pyaml.common.abstract_aggregator",
     "pyaml.common.constants",
     "pyaml.common.element",
-    "pyaml.common.element_holder",
     "pyaml.common.exception",
-    "pyaml.magnet.csvcurve",
-    "pyaml.magnet.csvmatrix",
-    "pyaml.magnet.curve",
+    "pyaml.common.holders.element_holder",
+    "pyaml.common.holders.magnet_holder",
+    "pyaml.common.holders.magnets_holder",
+    "pyaml.common.holders.serialized_magnet_holder",
+    "pyaml.common.holders.serialized_magnets_holder",
+    "pyaml.common.holders.combinded_function_magnet_holder",
+    "pyaml.common.holders.combinded_function_magnets_holder",
     "pyaml.configuration.factory",
     "pyaml.configuration.fileloader",
-    "pyaml.magnet.inline_curve",
-    "pyaml.magnet.inline_matrix",
     "pyaml.configuration.manager",
-    "pyaml.magnet.matrix",
+    "pyaml.configuration.restfetcher",
+    "pyaml.configuration.unbound_element",
     "pyaml.control.abstract_impl",
     "pyaml.control.controlsystem",
     "pyaml.control.deviceaccess",
     "pyaml.control.deviceaccesslist",
     "pyaml.control.readback_value",
-    "pyaml.tuning_tools.chromaticity_monitor",
+    "pyaml.diagnostics.atune_monitor",
     "pyaml.diagnostics.tune_monitor",
     "pyaml.external.pySC_interface",
     "pyaml.lattice.abstract_impl",
@@ -52,40 +54,57 @@
     "pyaml.lattice.simulator",
     "pyaml.magnet.cfm_magnet",
     "pyaml.magnet.corrector",
+    "pyaml.magnet.linear_cfm_model",
+    "pyaml.magnet.linear_model",
+    "pyaml.magnet.linear_serialized_model",
     "pyaml.magnet.function_mapping",
     "pyaml.magnet.hcorrector",
     "pyaml.magnet.identity_cfm_model",
     "pyaml.magnet.identity_model",
-    "pyaml.magnet.linear_cfm_model",
-    "pyaml.magnet.linear_model",
-    "pyaml.magnet.linear_serialized_model",
     "pyaml.magnet.magnet",
+    "pyaml.magnet.serialized_magnet",
+    "pyaml.magnet.spline_model",
     "pyaml.magnet.model",
     "pyaml.magnet.octupole",
     "pyaml.magnet.quadrupole",
-    "pyaml.magnet.serialized_magnet",
     "pyaml.magnet.sextupole",
     "pyaml.magnet.skewoctu",
     "pyaml.magnet.skewquad",
     "pyaml.magnet.skewsext",
-    "pyaml.magnet.spline_model",
     "pyaml.magnet.vcorrector",
+    "pyaml.magnet.csvcurve",
+    "pyaml.magnet.csvmatrix",
+    "pyaml.magnet.curve",
+    "pyaml.magnet.inline_curve",
+    "pyaml.magnet.inline_matrix",
+    "pyaml.magnet.matrix",
     "pyaml.rf.rf_plant",
     "pyaml.rf.rf_transmitter",
     # "pyaml.tuning_tools.LOCO.loco",
     # "pyaml.tuning_tools.SOFB.sofb",
+    "pyaml.tuning_tools.chromaticity",
+    "pyaml.tuning_tools.measurement_tool",
+    "pyaml.tuning_tools.chromaticity_response_matrix",
     "pyaml.tuning_tools.dispersion",
+    "pyaml.tuning_tools.response_matrix_data",
     "pyaml.tuning_tools.orbit",
     "pyaml.tuning_tools.orbit_response_matrix",
-    "pyaml.tuning_tools.chromaticity",
-    "pyaml.tuning_tools.tune",
-    "pyaml.tuning_tools.chromaticity_response_matrix",
-    "pyaml.tuning_tools.measurement_tool",
     "pyaml.tuning_tools.orbit_response_matrix_data",
-    "pyaml.tuning_tools.response_matrix_data",
+    "pyaml.tuning_tools.chromaticity_monitor",
+    "pyaml.tuning_tools.tune",
     "pyaml.tuning_tools.tune_response_matrix",
     "pyaml.tuning_tools.tuning_tool",
+    "pyaml.tuning_tools.bba",
+    "pyaml.tuning_tools.bba2",
     "pyaml.yellow_pages",
+    "pyaml._version",
+    "pyaml.validation.configuration_models",
+    "pyaml.validation.errors",
+    "pyaml.validation.generator",
+    "pyaml.validation.registry",
+    "pyaml.validation.schema_builder",
+    "pyaml.validation.validation_models",
+    "pyaml.validation.validator",
 ]
 
 

pyaml/arrays/array.py

@@ -5,7 +5,7 @@
 from pyaml.common.exception import PyAMLException
 
 from ..common.element import __pyaml_repr__
-from ..common.element_holder import ElementHolder
+from ..common.holders.element_holder import ElementHolder
 from ..validation import DynamicValidation, register_schema
 
 

pyaml/arrays/bpm.py

@@ -1,4 +1,4 @@
-from ..common.element_holder import ElementHolder
+from ..common.holders.element_holder import ElementHolder
 from ..validation import DynamicValidation, register_schema
 from .array import ArrayConfig
 

pyaml/arrays/cfm_magnet.py

@@ -1,4 +1,4 @@
-from ..common.element_holder import ElementHolder
+from ..common.holders.element_holder import ElementHolder
 from ..validation import DynamicValidation, register_schema
 from .array import ArrayConfig
 
@@ -36,4 +36,4 @@ def fill_array(self, holder: ElementHolder):
         holder : ElementHolder
             The element holder to populate with combined function magnet array
         """
-        holder.fill_cfm_magnet_array(self._name, self._elements)
+        holder.combined_function_magnets.add(self._name, self._elements)

pyaml/arrays/element.py

@@ -1,4 +1,4 @@
-from ..common.element_holder import ElementHolder
+from ..common.holders.element_holder import ElementHolder
 from ..validation import DynamicValidation, register_schema
 from .array import ArrayConfig
 

pyaml/arrays/element_array.py

@@ -12,7 +12,7 @@
 from ..magnet.serialized_magnet import SerializedMagnets
 
 if TYPE_CHECKING:
-    from ..common.element_holder import ElementHolder
+    from ..common.holders.element_holder import ElementHolder
 
 
 class ElementArray(list[Element]):

pyaml/arrays/magnet.py

@@ -1,4 +1,4 @@
-from ..common.element_holder import ElementHolder
+from ..common.holders.element_holder import ElementHolder
 from ..validation import DynamicValidation, register_schema
 from .array import ArrayConfig
 

pyaml/arrays/serialized_magnet.py

@@ -1,4 +1,4 @@
-from ..common.element_holder import ElementHolder
+from ..common.holders.element_holder import ElementHolder
 from ..validation import DynamicValidation, register_schema
 from .array import ArrayConfig
 

pyaml/common/element.py

@@ -5,7 +5,7 @@
 from .exception import PyAMLException
 
 if TYPE_CHECKING:
-    from ..common.element_holder import ElementHolder
+    from .holders.element_holder import ElementHolder
 
 
 def __pyaml_repr__(obj, exclude: list[str] | None = None):