CoilCoolingDXMultiSpeed has methods to add stages, but none to remove stages

[jmarrec]

Issue overview

CoilCoolingDXMultiSpeed has methods add stages, but none to remove stages

void addStage(CoilCoolingDXMultiSpeedStageData& stage);

Current Behavior

The API lets you add stages, but not remove them.

OpenStudio/src/model/CoilCoolingDXMultiSpeed.hpp

Line 136 in f339397

void addStage(CoilCoolingDXMultiSpeedStageData& stage);

Expected Behavior

You should be able to remove stages.

Environment

Some additional details about your environment for this issue (if relevant):

• Platform (Operating system, version): All
• Version of OpenStudio (if using an intermediate build, include SHA): 3.0.1-beta1, f339397

Context

Found in #3987 (comment)

[jmarrec]

IDD should also add \max-fields since this object really expects two, three, or four speeds maximum.

[jmarrec]

(availablitySchedule should have been non optional).

CoilCoolingDXMultiSpeedStageData is a ParentObject. It should have been a ResourceObject I think. @kbenne do you remember why you used ParentObject? cf 13473c0#diff-977d88f8d902362d07d5ae54eff635a6

Here's an example:

m = Model.new
dx = CoilCoolingDXMultiSpeed.new(m)
dx2 = CoilCoolingDXMultiSpeed.new(m)
stage = CoilCoolingDXMultiSpeedStageData.new(m)
dx.addStage(stage)
dx2.addStage(stage)
puts dx

OS:Coil:Cooling:DX:MultiSpeed,
  {3e17298c-7e78-4f13-8c94-5b7bf8113615}, !- Handle
  Coil Cooling DX Multi Speed 1,          !- Name
  [...]
  NaturalGas,                             !- Fuel Type
  {9c50af7f-34b2-4ef9-b691-c4f29b63130c}; !- Stage 1

Now remove dx2, and it deletes the stage in dx too:

dx2.remove
puts dx

OS:Coil:Cooling:DX:MultiSpeed,
  {7256b96e-11b7-439f-b040-95e4d70d6537}, !- Handle
  Coil Cooling DX Multi Speed 1,          !- Name
  [...]
  NaturalGas,                             !- Fuel Type
  ;                                       !- Stage 1

Anyways, this is probably besides the scope of this issue, so I'm going to leave it as is otherwise I'd have to modify a bunch of methods like clone, which may be surprising to users.

OpenStudio/src/model/CoilCoolingDXMultiSpeed.cpp

Lines 304 to 313 in c710464

	ModelObject CoilCoolingDXMultiSpeed_Impl::clone(Model model) const {
	auto t_clone = StraightComponent_Impl::clone(model).cast<CoilCoolingDXMultiSpeed>();
	auto t_stages = stages();
	for( auto stage: t_stages ) {
	auto stageClone = stage.clone(model).cast<CoilCoolingDXMultiSpeedStageData>();
	t_clone.addStage(stageClone);
	}
	return t_clone;
	}

[jmarrec]

Well actually I think making it a ParentObject was the right call given this:

OpenStudio/src/model/CoilCoolingDXMultiSpeedStageData.cpp

Lines 452 to 463 in c710464

	boost::optional<double> CoilCoolingDXMultiSpeedStageData_Impl::autosizedGrossRatedTotalCoolingCapacity() const {
	auto indexAndNameOpt = stageIndexAndParentCoil();
	boost::optional<double> result;
	if (!indexAndNameOpt) {
	return result;
	}
	auto indexAndName = indexAndNameOpt.get();
	int index = std::get<0>(indexAndName);
	CoilCoolingDXMultiSpeed parentCoil = std::get<1>(indexAndName);
	std::string sqlField = "Design Size Speed " + std::to_string(index) + " Gross Rated Total Cooling Capacity";
	return parentCoil.getAutosizedValue(sqlField, "W");
	}

I suppose the issue is that a CoilCoolingDXMultiSpeedStageData shouldn't be used by more than one CoilCoolingDXMultiSpeed object.