Comments update

Author: fabiomolinar

crates/powerlink-rs-xdc/src/model/app_layers.rs

@@ -1,14 +1,13 @@
-// crates/powerlink-rs-xdc/src/model/app_layers.rs
-
 //! Contains model structs related to `<ApplicationLayers>`.
+//!
 //! (Schema: `ProfileBody_CommunicationNetwork_Powerlink.xsd`)
 
 use super::modular::ModuleManagementComm;
 use alloc::string::String;
 use alloc::vec::Vec;
-use serde::{Deserialize, Serialize}; // Added import
+use serde::{Deserialize, Serialize};
 
-/// Contains the ObjectList and DataTypeList.
+/// Contains the Object Dictionary definition (`ObjectList`) and Data Type definitions (`DataTypeList`).
 #[derive(Debug, Serialize, Deserialize, Default)]
 pub struct ApplicationLayers {
     /// This optional list defines the mapping from hex ID to type name.
@@ -42,7 +41,8 @@ pub struct ObjectList {
 
 // --- Enums for Object/SubObject Attributes ---
 
-/// Access types of an object / subobject (from XSD `t_ObjectAccessType`).
+/// Access types of an object / subobject.
+/// (from XSD `t_ObjectAccessType`)
 #[derive(Debug, Serialize, Deserialize, Clone, Copy, PartialEq, Eq)]
 pub enum ObjectAccessType {
     #[serde(rename = "ro")]
@@ -55,7 +55,8 @@ pub enum ObjectAccessType {
     Constant,
 }
 
-/// Ability to map an object / subobject to a PDO (from XSD `t_ObjectPDOMapping`).
+/// Ability to map an object / subobject to a PDO.
+/// (from XSD `t_ObjectPDOMapping`)
 #[derive(Debug, Serialize, Deserialize, Clone, Copy, PartialEq, Eq)]
 pub enum ObjectPdoMapping {
     #[serde(rename = "no")]
@@ -70,84 +71,79 @@ pub enum ObjectPdoMapping {
     Rpdo,
 }
 
-/// Represents an Object Dictionary index (e.g., <Object index="1F22"...>).
-/// This struct includes attributes from the `ag_Powerlink_Object` group.
+/// Represents an Object Dictionary index.
+///
+/// This struct includes attributes from the `ag_Powerlink_Object` attribute group.
 #[derive(Debug, Serialize, Deserialize, Default)]
 pub struct Object {
     /// The OD index as a hex string (e.g., "1F22").
     #[serde(rename = "@index")]
     pub index: String,
 
     // --- Fields from ag_Powerlink_Object ---
-    /// The name of the object.
+
     #[serde(rename = "@name")]
     pub name: String,
 
-    /// The object type (e.g., "9" for RECORD).
+    /// The object type (e.g., "7" for VAR, "8" for ARRAY, "9" for RECORD).
     #[serde(rename = "@objectType")]
     pub object_type: String,
 
-    /// The POWERLINK data type (e.g., "0006" for Unsigned16).
+    /// The POWERLINK data type ID (e.g., "0006" for Unsigned16).
     #[serde(rename = "@dataType", default, skip_serializing_if = "Option::is_none")]
     pub data_type: Option<String>,
 
-    /// The lower limit of the object's value.
     #[serde(rename = "@lowLimit", default, skip_serializing_if = "Option::is_none")]
     pub low_limit: Option<String>,
 
-    /// The upper limit of the object's value.
     #[serde(
         rename = "@highLimit",
         default,
         skip_serializing_if = "Option::is_none"
     )]
     pub high_limit: Option<String>,
 
-    /// The access type (e.g., "ro", "rw").
     #[serde(
         rename = "@accessType",
         default,
         skip_serializing_if = "Option::is_none"
     )]
     pub access_type: Option<ObjectAccessType>,
 
-    /// The default value of the object.
+    /// The default value of the object. Used primarily in Device Description (XDD) files.
     #[serde(
         rename = "@defaultValue",
         default,
         skip_serializing_if = "Option::is_none"
     )]
     pub default_value: Option<String>,
 
-    /// The actual value of the object (used in XDC).
+    /// The actual value of the object. Used primarily in Configuration (XDC) files.
     #[serde(
         rename = "@actualValue",
         default,
         skip_serializing_if = "Option::is_none"
     )]
     pub actual_value: Option<String>,
 
-    /// A denotation for the object.
     #[serde(
         rename = "@denotation",
         default,
         skip_serializing_if = "Option::is_none"
     )]
     pub denotation: Option<String>,
 
-    /// The PDO mapping capability of the object.
     #[serde(
         rename = "@PDOmapping",
         default,
         skip_serializing_if = "Option::is_none"
     )]
     pub pdo_mapping: Option<ObjectPdoMapping>,
 
-    /// Object flags.
     #[serde(rename = "@objFlags", default, skip_serializing_if = "Option::is_none")]
     pub obj_flags: Option<String>,
 
-    /// This attribute references a Parameter's uniqueID in the ApplicationProcess.
+    /// References a Parameter's `uniqueID` in the `ApplicationProcess`.
     #[serde(
         rename = "@uniqueIDRef",
         default,
@@ -156,6 +152,7 @@ pub struct Object {
     pub unique_id_ref: Option<String>,
 
     // --- End of fields from ag_Powerlink_Object ---
+
     /// This attribute is used by modular devices to reference an index range.
     /// (from `t_Object_Extension_Head` and `t_Object_Extension`)
     #[serde(
@@ -165,99 +162,86 @@ pub struct Object {
     )]
     pub range_selector: Option<String>,
 
-    /// A list of SubObjects (e.g., <SubObject subIndex="01"...>).
+    /// A list of SubObjects (e.g., `<SubObject subIndex="01"...>`).
     #[serde(rename = "SubObject", default)]
     pub sub_object: Vec<SubObject>,
 }
 
 /// Represents an Object Dictionary sub-index.
-/// This struct includes attributes from the `ag_Powerlink_Object` group.
 #[derive(Debug, Serialize, Deserialize, Default)]
 pub struct SubObject {
     /// The OD sub-index as a hex string (e.g., "01").
     #[serde(rename = "@subIndex")]
     pub sub_index: String,
 
     // --- Fields from ag_Powerlink_Object ---
-    /// The name of the sub-object.
+
     #[serde(rename = "@name")]
     pub name: String,
 
-    /// The object type (e.t., "7" for VAR).
     #[serde(rename = "@objectType")]
     pub object_type: String,
 
-    /// The POWERLINK data type (e.g., "0006" for Unsigned16).
     #[serde(rename = "@dataType", default, skip_serializing_if = "Option::is_none")]
     pub data_type: Option<String>,
 
-    /// The lower limit of the sub-object's value.
     #[serde(rename = "@lowLimit", default, skip_serializing_if = "Option::is_none")]
     pub low_limit: Option<String>,
 
-    /// The upper limit of the sub-object's value.
     #[serde(
         rename = "@highLimit",
         default,
         skip_serializing_if = "Option::is_none"
     )]
     pub high_limit: Option<String>,
 
-    /// The access type (e.g., "ro", "rw").
     #[serde(
         rename = "@accessType",
         default,
         skip_serializing_if = "Option::is_none"
     )]
     pub access_type: Option<ObjectAccessType>,
 
-    /// The `defaultValue` is the key data for an XDD file.
     #[serde(
         rename = "@defaultValue",
         default,
         skip_serializing_if = "Option::is_none"
     )]
     pub default_value: Option<String>,
 
-    /// The `actualValue` is the key data for an XDC file.
     #[serde(
         rename = "@actualValue",
         default,
         skip_serializing_if = "Option::is_none"
     )]
     pub actual_value: Option<String>,
 
-    /// A denotation for the sub-object.
     #[serde(
         rename = "@denotation",
         default,
         skip_serializing_if = "Option::is_none"
     )]
     pub denotation: Option<String>,
 
-    /// The PDO mapping capability of the sub-object.
     #[serde(
         rename = "@PDOmapping",
         default,
         skip_serializing_if = "Option::is_none"
     )]
     pub pdo_mapping: Option<ObjectPdoMapping>,
 
-    /// Object flags.
     #[serde(rename = "@objFlags", default, skip_serializing_if = "Option::is_none")]
     pub obj_flags: Option<String>,
 
-    /// This attribute references a Parameter's uniqueID in the ApplicationProcess.
     #[serde(
         rename = "@uniqueIDRef",
         default,
         skip_serializing_if = "Option::is_none"
     )]
     pub unique_id_ref: Option<String>,
-    // --- End of fields from ag_Powerlink_Object ---
 }
 
-// --- STRUCTS for DataTypeList (Comm Profile) ---
+// --- STRUCTS for DataTypeList ---
 
 /// Represents `<DataTypeList>` (EPSG 311, 7.5.4.3).
 #[derive(Debug, Serialize, Deserialize, Default)]
@@ -278,7 +262,7 @@ pub struct DefType {
     pub type_name: DataTypeName,
 }
 
-/// Represents the tag name of the child of `<defType>`.
+/// Enumeration of standard POWERLINK data type tags.
 /// (Based on EPSG 311, Table 56).
 #[derive(Debug, Serialize, Deserialize, Clone, Copy, PartialEq, Eq)]
 pub enum DataTypeName {
@@ -317,4 +301,4 @@ pub enum DataTypeName {
     #[serde(rename = "IP_ADDRESS")]
     IpAddress,
     NETTIME,
-}
+}

crates/powerlink-rs-xdc/src/model/app_process.rs

@@ -1,17 +1,15 @@
-// crates/powerlink-rs-xdc/src/model/app_process.rs
-
 //! Contains model structs related to `<ApplicationProcess>`.
+//!
 //! (Schema: `ProfileBody_Device_Powerlink.xsd`)
 
-use super::common::{DataTypeIDRef, Glabels, bool_false, is_false};
+use super::common::{bool_false, is_false, DataTypeIDRef, Glabels};
 use alloc::string::String;
 use alloc::vec::Vec;
 use serde::{Deserialize, Serialize};
 
-// --- STRUCTS for ApplicationProcess (Task 5) ---
-
-/// Represents the `<ApplicationProcess>` block (EPSG 311, 7.4.7).
-/// This contains the device parameters, which are the source of default values.
+/// Represents the `<ApplicationProcess>` block.
+///
+/// This contains the device parameters, which serve as the source of default values.
 #[derive(Debug, Serialize, Deserialize, Default)]
 pub struct ApplicationProcess {
     /// Contains user-defined data types (EPSG 311, 7.4.7.2).
@@ -47,7 +45,7 @@ pub struct ApplicationProcess {
     pub template_list: Option<TemplateList>,
 
     /// Contains parameter definitions (EPSG 311, 7.4.7.7).
-    #[serde(rename = "parameterList")] // Required
+    #[serde(rename = "parameterList")]
     pub parameter_list: ParameterList,
 
     /// Contains parameter groupings (EPSG 311, 7.4.7.8).
@@ -67,7 +65,7 @@ pub struct TemplateList {
         default,
         skip_serializing_if = "Vec::is_empty"
     )]
-    pub parameter_template: Vec<Parameter>, // Use Parameter struct, as it's identical
+    pub parameter_template: Vec<Parameter>, // Identical to Parameter structure
 
     #[serde(
         rename = "allowedValuesTemplate",
@@ -168,10 +166,9 @@ pub struct MemberRef {
 }
 
 /// Represents the choice of data type for a Parameter.
-/// (Fix for serde `flatten` on enum variant error)
 #[derive(Debug, Serialize, Deserialize, Clone)]
 pub enum ParameterDataType {
-    // Variants from GSimple (inlined)
+    // Simple types from GSimple (inlined)
     BOOL,
     BITSTRING,
     BYTE,
@@ -192,14 +189,13 @@ pub enum ParameterDataType {
     STRING,
     WSTRING,
 
-    // Other choices
-    #[serde(rename = "dataTypeIDRef")] // Fix: Add rename attribute
+    // Complex choices
+    #[serde(rename = "dataTypeIDRef")]
     DataTypeIDRef(DataTypeIDRef),
-    #[serde(rename = "variableRef")] // Fix: Add rename attribute
+    #[serde(rename = "variableRef")]
     VariableRef(VariableRef),
 }
 
-// Add Default implementation
 impl Default for ParameterDataType {
     fn default() -> Self {
         ParameterDataType::BOOL
@@ -273,10 +269,9 @@ pub struct Property {
 }
 
 /// Represents a `<parameter>` (EPSG 311, 7.4.7.7.2).
-/// (Updated for Task 5)
 #[derive(Debug, Serialize, Deserialize, Default)]
 pub struct Parameter {
-    /// The unique ID (e.g., "Param1_Vendor_Specific") that `uniqueIDRef` points to.
+    /// The unique ID (e.g., "Param1_Vendor_Specific").
     #[serde(rename = "@uniqueID")]
     pub unique_id: String,
 
@@ -332,15 +327,15 @@ pub struct Parameter {
     )]
     pub denotation: Option<Denotation>,
 
-    /// The `actualValue` element, if present (less common for defaults).
+    /// The `actualValue` element (prioritized in XDC).
     #[serde(
         rename = "actualValue",
         default,
         skip_serializing_if = "Option::is_none"
     )]
     pub actual_value: Option<Value>,
 
-    /// The `defaultValue` element, if present.
+    /// The `defaultValue` element (prioritized in XDD).
     #[serde(
         rename = "defaultValue",
         default,
@@ -371,7 +366,6 @@ pub struct Parameter {
 
 /// Represents a simple value-holding element like `<defaultValue value="0x01"/>`.
 /// (EPSG 311, 7.4.7.7.2.4, 7.4.7.7.2.5).
-/// (Updated for Task 5 to `t_value`)
 #[derive(Debug, Serialize, Deserialize, Default, Clone)]
 pub struct Value {
     #[serde(flatten, default, skip_serializing_if = "Option::is_none")]
@@ -528,7 +522,7 @@ pub struct Count {
     #[serde(rename = "@uniqueID")]
     pub unique_id: String,
     #[serde(rename = "@access", default, skip_serializing_if = "Option::is_none")]
-    pub access: Option<ParameterAccess>, // Simplified from schema's subset
+    pub access: Option<ParameterAccess>,
     #[serde(flatten)]
     pub labels: Glabels,
     #[serde(rename = "defaultValue")]
@@ -763,4 +757,4 @@ pub struct ParameterRef {
         skip_serializing_if = "Option::is_none"
     )]
     pub bit_offset: Option<String>, // xsd:nonNegativeInteger
-}
+}