Fixes: [OPSTATE] specific phase in the list should not null

examples/all-clusters-app/all-clusters-common/include/operational-state-delegate-impl.h

@@ -50,14 +50,16 @@ class GenericOperationalStateDelegateImpl : public Delegate
  CHIP_ERROR GetOperationalStateAtIndex(size_t index, GenericOperationalState & operationalState) override;
 
  /**
- * Fills in the provided GenericOperationalPhase with the phase at index `index` if there is one,
+ * Fills in the provided MutableCharSpan with the phase at index `index` if there is one,
  * or returns CHIP_ERROR_NOT_FOUND if the index is out of range for the list of phases.
+ * If fills in the provided MutableCharSpan with the phase at index `0` and returns CHIP_ERROR_NOT_FOUND,
+ * it represents PhaseList attribute is an empty list, the SDK will set PhaseList attribute value to null.
  * Note: This is used by the SDK to populate the phase list attribute. If the contents of this list changes, the
  * device SHALL call the Instance's ReportPhaseListChange method to report that this attribute has changed.
  * @param index The index of the phase, with 0 representing the first phase.
- * @param operationalPhase The GenericOperationalPhase is filled.
+ * @param operationalPhase The MutableCharSpan is filled.
  */
- CHIP_ERROR GetOperationalPhaseAtIndex(size_t index, GenericOperationalPhase & operationalPhase) override;
+ CHIP_ERROR GetOperationalPhaseAtIndex(size_t index, MutableCharSpan & operationalPhase) override;
 
  // command callback
  /**
@@ -86,7 +88,7 @@ class GenericOperationalStateDelegateImpl : public Delegate
 
 protected:
  Span<const GenericOperationalState> mOperationalStateList;
- Span<const GenericOperationalPhase> mOperationalPhaseList;
+ Span<const CharSpan> mOperationalPhaseList;
 };
 
 // This is an application level delegate to handle operational state commands according to the specific business logic.
@@ -100,16 +102,10 @@ class OperationalStateDelegate : public GenericOperationalStateDelegateImpl
  GenericOperationalState(to_underlying(OperationalStateEnum::kError)),
  };
 
- const GenericOperationalPhase opPhaseList[1] = {
- // Phase List is null
- GenericOperationalPhase(DataModel::Nullable<CharSpan>()),
- };
-
 public:
  OperationalStateDelegate()
  {
  GenericOperationalStateDelegateImpl::mOperationalStateList = Span<const GenericOperationalState>(opStateList);
- GenericOperationalStateDelegateImpl::mOperationalPhaseList = Span<const GenericOperationalPhase>(opPhaseList);
  }
 };
 
@@ -134,18 +130,11 @@ class RvcOperationalStateDelegate : public OperationalState::GenericOperationalS
  OperationalState::GenericOperationalState(to_underlying(Clusters::RvcOperationalState::OperationalStateEnum::kDocked)),
  };
 
- const OperationalState::GenericOperationalPhase rvcOpPhaseList[1] = {
- // Phase List is null
- OperationalState::GenericOperationalPhase(DataModel::Nullable<CharSpan>()),
- };
-
 public:
  RvcOperationalStateDelegate()
  {
  GenericOperationalStateDelegateImpl::mOperationalStateList =
  Span<const OperationalState::GenericOperationalState>(rvcOpStateList);
- GenericOperationalStateDelegateImpl::mOperationalPhaseList =
- Span<const OperationalState::GenericOperationalPhase>(rvcOpPhaseList);
  }
 };
 

examples/all-clusters-app/all-clusters-common/src/operational-state-delegate-impl.cpp

@@ -33,14 +33,13 @@ CHIP_ERROR GenericOperationalStateDelegateImpl::GetOperationalStateAtIndex(size_
  return CHIP_NO_ERROR;
 }
 
-CHIP_ERROR GenericOperationalStateDelegateImpl::GetOperationalPhaseAtIndex(size_t index, GenericOperationalPhase & operationalPhase)
+CHIP_ERROR GenericOperationalStateDelegateImpl::GetOperationalPhaseAtIndex(size_t index, MutableCharSpan & operationalPhase)
 {
  if (index >= mOperationalPhaseList.size())
  {
  return CHIP_ERROR_NOT_FOUND;
  }
- operationalPhase = mOperationalPhaseList[index];
- return CHIP_NO_ERROR;
+ return CopyCharSpanToMutableCharSpan(mOperationalPhaseList[index], operationalPhase);
 }
 
 void GenericOperationalStateDelegateImpl::HandlePauseStateCallback(GenericOperationalError & err)

examples/all-clusters-app/ameba/main/OperationalStateManager.cpp

@@ -33,14 +33,13 @@ CHIP_ERROR GenericOperationalStateDelegateImpl::GetOperationalStateAtIndex(size_
  return CHIP_NO_ERROR;
 }
 
-CHIP_ERROR GenericOperationalStateDelegateImpl::GetOperationalPhaseAtIndex(size_t index, GenericOperationalPhase & operationalPhase)
+CHIP_ERROR GenericOperationalStateDelegateImpl::GetOperationalPhaseAtIndex(size_t index, MutableCharSpan & operationalPhase)
 {
  if (index >= mOperationalPhaseList.size())
  {
  return CHIP_ERROR_NOT_FOUND;
  }
- operationalPhase = mOperationalPhaseList[index];
- return CHIP_NO_ERROR;
+ return CopyCharSpanToMutableCharSpan(mOperationalPhaseList[index], operationalPhase);
 }
 
 void GenericOperationalStateDelegateImpl::HandlePauseStateCallback(GenericOperationalError & err)

examples/all-clusters-app/ameba/main/include/OperationalStateManager.h

@@ -54,14 +54,16 @@ class GenericOperationalStateDelegateImpl : public Delegate
  CHIP_ERROR GetOperationalStateAtIndex(size_t index, GenericOperationalState & operationalState) override;
 
  /**
- * Fills in the provided GenericOperationalPhase with the phase at index `index` if there is one,
+ * Fills in the provided MutableCharSpan with the phase at index `index` if there is one,
  * or returns CHIP_ERROR_NOT_FOUND if the index is out of range for the list of phases.
+ * If fills in the provided MutableCharSpan with the phase at index `0` and returns CHIP_ERROR_NOT_FOUND,
+ * it represents PhaseList attribute is an empty list, the SDK will set PhaseList attribute value to null.
  * Note: This is used by the SDK to populate the phase list attribute. If the contents of this list changes, the
  * device SHALL call the Instance's ReportPhaseListChange method to report that this attribute has changed.
  * @param index The index of the phase, with 0 representing the first phase.
- * @param operationalPhase The GenericOperationalPhase is filled.
+ * @param operationalPhase The MutableCharSpan is filled.
  */
- CHIP_ERROR GetOperationalPhaseAtIndex(size_t index, GenericOperationalPhase & operationalPhase) override;
+ CHIP_ERROR GetOperationalPhaseAtIndex(size_t index, MutableCharSpan & operationalPhase) override;
 
  // command callback
  /**
@@ -90,7 +92,7 @@ class GenericOperationalStateDelegateImpl : public Delegate
 
 protected:
  Span<const GenericOperationalState> mOperationalStateList;
- Span<const GenericOperationalPhase> mOperationalPhaseList;
+ Span<const CharSpan> mOperationalPhaseList;
 };
 
 // This is an application level delegate to handle operational state commands according to the specific business logic.
@@ -104,16 +106,10 @@ class OperationalStateDelegate : public GenericOperationalStateDelegateImpl
  GenericOperationalState(to_underlying(OperationalStateEnum::kError)),
  };
 
- const GenericOperationalPhase opPhaseList[1] = {
- // Phase List is null
- GenericOperationalPhase(DataModel::Nullable<CharSpan>()),
- };
-
 public:
  OperationalStateDelegate()
  {
  GenericOperationalStateDelegateImpl::mOperationalStateList = Span<const GenericOperationalState>(opStateList);
- GenericOperationalStateDelegateImpl::mOperationalPhaseList = Span<const GenericOperationalPhase>(opPhaseList);
  }
 };
 
@@ -140,18 +136,11 @@ class RvcOperationalStateDelegate : public OperationalState::GenericOperationalS
  OperationalState::GenericOperationalState(to_underlying(Clusters::RvcOperationalState::OperationalStateEnum::kDocked)),
  };
 
- const OperationalState::GenericOperationalPhase rvcOpPhaseList[1] = {
- // Phase List is null
- OperationalState::GenericOperationalPhase(DataModel::Nullable<CharSpan>()),
- };
-
 public:
  RvcOperationalStateDelegate()
  {
  GenericOperationalStateDelegateImpl::mOperationalStateList =
  Span<const OperationalState::GenericOperationalState>(rvcOpStateList);
- GenericOperationalStateDelegateImpl::mOperationalPhaseList =
- Span<const OperationalState::GenericOperationalPhase>(rvcOpPhaseList);
  }
 };
 

examples/chef/common/chef-rvc-operational-state-delegate.cpp

@@ -37,14 +37,13 @@ CHIP_ERROR GenericOperationalStateDelegateImpl::GetOperationalStateAtIndex(size_
  return CHIP_NO_ERROR;
 }
 
-CHIP_ERROR GenericOperationalStateDelegateImpl::GetOperationalPhaseAtIndex(size_t index, GenericOperationalPhase & operationalPhase)
+CHIP_ERROR GenericOperationalStateDelegateImpl::GetOperationalPhaseAtIndex(size_t index, MutableCharSpan & operationalPhase)
 {
  if (index >= mOperationalPhaseList.size())
  {
  return CHIP_ERROR_NOT_FOUND;
  }
- operationalPhase = mOperationalPhaseList[index];
- return CHIP_NO_ERROR;
+ return CopyCharSpanToMutableCharSpan(mOperationalPhaseList[index], operationalPhase);
 }
 
 void GenericOperationalStateDelegateImpl::HandlePauseStateCallback(GenericOperationalError & err)

examples/chef/common/chef-rvc-operational-state-delegate.h

@@ -50,14 +50,16 @@ class GenericOperationalStateDelegateImpl : public Delegate
  CHIP_ERROR GetOperationalStateAtIndex(size_t index, GenericOperationalState & operationalState) override;
 
  /**
- * Fills in the provided GenericOperationalPhase with the phase at index `index` if there is one,
+ * Fills in the provided MutableCharSpan with the phase at index `index` if there is one,
  * or returns CHIP_ERROR_NOT_FOUND if the index is out of range for the list of phases.
+ * If fills in the provided MutableCharSpan with the phase at index `0` and returns CHIP_ERROR_NOT_FOUND,
+ * it represents PhaseList attribute is an empty list, the SDK will set PhaseList attribute value to null.
  * Note: This is used by the SDK to populate the phase list attribute. If the contents of this list changes, the
  * device SHALL call the Instance's ReportPhaseListChange method to report that this attribute has changed.
  * @param index The index of the phase, with 0 representing the first phase.
- * @param operationalPhase The GenericOperationalPhase is filled.
+ * @param operationalPhase The MutableCharSpan is filled.
  */
- CHIP_ERROR GetOperationalPhaseAtIndex(size_t index, GenericOperationalPhase & operationalPhase) override;
+ CHIP_ERROR GetOperationalPhaseAtIndex(size_t index, MutableCharSpan & operationalPhase) override;
 
  // command callback
  /**
@@ -86,7 +88,7 @@ class GenericOperationalStateDelegateImpl : public Delegate
 
 protected:
  Span<const GenericOperationalState> mOperationalStateList;
- Span<const GenericOperationalPhase> mOperationalPhaseList;
+ Span<const CharSpan> mOperationalPhaseList;
 };
 
 // This is an application level delegate to handle operational state commands according to the specific business logic.
@@ -100,16 +102,10 @@ class OperationalStateDelegate : public GenericOperationalStateDelegateImpl
  GenericOperationalState(to_underlying(OperationalStateEnum::kError)),
  };
 
- const GenericOperationalPhase opPhaseList[1] = {
- // Phase List is null
- GenericOperationalPhase(DataModel::Nullable<CharSpan>()),
- };
-
 public:
  OperationalStateDelegate()
  {
  GenericOperationalStateDelegateImpl::mOperationalStateList = Span<const GenericOperationalState>(opStateList);
- GenericOperationalStateDelegateImpl::mOperationalPhaseList = Span<const GenericOperationalPhase>(opPhaseList);
  }
 };
 
@@ -134,18 +130,11 @@ class RvcOperationalStateDelegate : public OperationalState::GenericOperationalS
  OperationalState::GenericOperationalState(to_underlying(Clusters::RvcOperationalState::OperationalStateEnum::kDocked)),
  };
 
- const OperationalState::GenericOperationalPhase rvcOpPhaseList[1] = {
- // Phase List is null
- OperationalState::GenericOperationalPhase(DataModel::Nullable<CharSpan>()),
- };
-
 public:
  RvcOperationalStateDelegate()
  {
  GenericOperationalStateDelegateImpl::mOperationalStateList =
  Span<const OperationalState::GenericOperationalState>(rvcOpStateList);
- GenericOperationalStateDelegateImpl::mOperationalPhaseList =
- Span<const OperationalState::GenericOperationalPhase>(rvcOpPhaseList);
  }
 };
 

examples/dishwasher-app/dishwasher-common/include/operational-state-delegate-impl.h

@@ -50,12 +50,14 @@ class OperationalStateDelegate : public Delegate
 
  /**
  * Get the list of supported operational phases.
- * Fills in the provided GenericOperationalPhase with the phase at index `index` if there is one,
+ * Fills in the provided MutableCharSpan with the phase at index `index` if there is one,
  * or returns CHIP_ERROR_NOT_FOUND if the index is out of range for the list of phases.
+ * If fills in the provided MutableCharSpan with the phase at index `0` and returns CHIP_ERROR_NOT_FOUND,
+ * it represents PhaseList attribute is an empty list, the SDK will set PhaseList attribute value to null.
  * @param index The index of the phase, with 0 representing the first phase.
- * @param operationalPhase The GenericOperationalPhase is filled.
+ * @param operationalPhase The MutableCharSpan is filled.
  */
- CHIP_ERROR GetOperationalPhaseAtIndex(size_t index, GenericOperationalPhase & operationalPhase) override;
+ CHIP_ERROR GetOperationalPhaseAtIndex(size_t index, MutableCharSpan & operationalPhase) override;
 
  // command callback
  /**
@@ -91,13 +93,7 @@ class OperationalStateDelegate : public Delegate
  };
 
  app::DataModel::List<const GenericOperationalState> mOperationalStateList = Span<const GenericOperationalState>(rvcOpStateList);
-
- const GenericOperationalPhase opPhaseList[1] = {
- // Phase List is null
- GenericOperationalPhase(DataModel::Nullable<CharSpan>()),
- };
-
- Span<const GenericOperationalPhase> mOperationalPhaseList = Span<const GenericOperationalPhase>(opPhaseList);
+ const Span<const CharSpan> mOperationalPhaseList;
 };
 
 void Shutdown();

examples/dishwasher-app/dishwasher-common/src/operational-state-delegate-impl.cpp

@@ -32,14 +32,13 @@ CHIP_ERROR OperationalStateDelegate::GetOperationalStateAtIndex(size_t index, Ge
  return CHIP_NO_ERROR;
 }
 
-CHIP_ERROR OperationalStateDelegate::GetOperationalPhaseAtIndex(size_t index, GenericOperationalPhase & operationalPhase)
+CHIP_ERROR OperationalStateDelegate::GetOperationalPhaseAtIndex(size_t index, MutableCharSpan & operationalPhase)
 {
- if (index > mOperationalPhaseList.size() - 1)
+ if (index >= mOperationalPhaseList.size())
  {
  return CHIP_ERROR_NOT_FOUND;
  }
- operationalPhase = mOperationalPhaseList[index];
- return CHIP_NO_ERROR;
+ return CopyCharSpanToMutableCharSpan(mOperationalPhaseList[index], operationalPhase);
 }
 
 void OperationalStateDelegate::HandlePauseStateCallback(GenericOperationalError & err)

examples/microwave-oven-app/microwave-oven-common/include/microwave-oven-device.h

@@ -111,14 +111,16 @@ class ExampleMicrowaveOvenDevice : public MicrowaveOvenControl::Delegate,
  CHIP_ERROR GetOperationalStateAtIndex(size_t index, OperationalState::GenericOperationalState & operationalState) override;
 
  /**
- * Fills in the provided GenericOperationalPhase with the phase at index `index` if there is one,
+ * Fills in the provided MutableCharSpan with the phase at index `index` if there is one,
  * or returns CHIP_ERROR_NOT_FOUND if the index is out of range for the list of phases.
+ * If fills in the provided MutableCharSpan with the phase at index `0` and returns CHIP_ERROR_NOT_FOUND,
+ * it represents PhaseList attribute is an empty list, the SDK will set PhaseList attribute value to null.
  * Note: This is used by the SDK to populate the phase list attribute. If the contents of this list changes, the
  * device SHALL call the Instance's ReportPhaseListChange method to report that this attribute has changed.
  * @param index The index of the phase, with 0 representing the first phase.
- * @param operationalPhase The GenericOperationalPhase is filled.
+ * @param operationalPhase The MutableCharSpan is filled.
  */
- CHIP_ERROR GetOperationalPhaseAtIndex(size_t index, OperationalState::GenericOperationalPhase & operationalPhase) override;
+ CHIP_ERROR GetOperationalPhaseAtIndex(size_t index, MutableCharSpan & operationalPhase) override;
 
  /**
  * Handle Command Callback in application: Pause
@@ -220,14 +222,7 @@ class ExampleMicrowaveOvenDevice : public MicrowaveOvenControl::Delegate,
 
  const app::DataModel::List<const OperationalState::GenericOperationalState> mOperationalStateList =
  Span<const OperationalState::GenericOperationalState>(mOpStateList);
-
- const OperationalState::GenericOperationalPhase mOpPhaseList[1] = {
- // Phase List is null
- OperationalState::GenericOperationalPhase(DataModel::Nullable<CharSpan>()),
- };
-
- Span<const OperationalState::GenericOperationalPhase> mOperationalPhaseList =
- Span<const OperationalState::GenericOperationalPhase>(mOpPhaseList);
+ const Span<const CharSpan> mOperationalPhaseList;
 };
 
 } // namespace Clusters

examples/microwave-oven-app/microwave-oven-common/src/microwave-oven-device.cpp

@@ -80,15 +80,13 @@ CHIP_ERROR ExampleMicrowaveOvenDevice::GetOperationalStateAtIndex(size_t index,
  return CHIP_NO_ERROR;
 }
 
-CHIP_ERROR ExampleMicrowaveOvenDevice::GetOperationalPhaseAtIndex(size_t index,
- OperationalState::GenericOperationalPhase & operationalPhase)
+CHIP_ERROR ExampleMicrowaveOvenDevice::GetOperationalPhaseAtIndex(size_t index, MutableCharSpan & operationalPhase)
 {
- if (index > mOperationalPhaseList.size() - 1)
+ if (index >= mOperationalPhaseList.size())
  {
  return CHIP_ERROR_NOT_FOUND;
  }
- operationalPhase = mOperationalPhaseList[index];
- return CHIP_NO_ERROR;
+ return CopyCharSpanToMutableCharSpan(mOperationalPhaseList[index], operationalPhase);
 }
 
 void ExampleMicrowaveOvenDevice::HandlePauseStateCallback(OperationalState::GenericOperationalError & err)

examples/rvc-app/rvc-common/include/rvc-operational-state-delegate.h

@@ -47,11 +47,7 @@ class RvcOperationalStateDelegate : public OperationalState::Delegate
  OperationalState::GenericOperationalState(to_underlying(Clusters::RvcOperationalState::OperationalStateEnum::kCharging)),
  OperationalState::GenericOperationalState(to_underlying(Clusters::RvcOperationalState::OperationalStateEnum::kDocked)),
  };
-
- const Clusters::OperationalState::GenericOperationalPhase mOperationalPhaseList[1] = {
- // Phase List is null
- OperationalState::GenericOperationalPhase(DataModel::Nullable<CharSpan>()),
- };
+ const Span<const CharSpan> mOperationalPhaseList;
 
  RvcDevice * mPauseRvcDeviceInstance;
  HandleOpStateCommand mPauseCallback;
@@ -77,15 +73,16 @@ class RvcOperationalStateDelegate : public OperationalState::Delegate
  Clusters::OperationalState::GenericOperationalState & operationalState) override;
 
  /**
- * Fills in the provided GenericOperationalPhase with the phase at index `index` if there is one,
+ * Fills in the provided MutableCharSpan with the phase at index `index` if there is one,
  * or returns CHIP_ERROR_NOT_FOUND if the index is out of range for the list of phases.
+ * If fills in the provided MutableCharSpan with the phase at index `0` and returns CHIP_ERROR_NOT_FOUND,
+ * it represents PhaseList attribute is an empty list, the SDK will set PhaseList attribute value to null.
  * Note: This is used by the SDK to populate the phase list attribute. If the contents of this list changes, the
  * device SHALL call the Instance's ReportPhaseListChange method to report that this attribute has changed.
  * @param index The index of the phase, with 0 representing the first phase.
- * @param operationalPhase The GenericOperationalPhase is filled.
+ * @param operationalPhase The MutableCharSpan is filled.
  */
- CHIP_ERROR GetOperationalPhaseAtIndex(size_t index,
- Clusters::OperationalState::GenericOperationalPhase & operationalPhase) override;
+ CHIP_ERROR GetOperationalPhaseAtIndex(size_t index, MutableCharSpan & operationalPhase) override;
 
  // command callback
  /**