def newidfobject(self, key, aname="", **kwargs):
# type: (str, str, **Any) -> EpBunch
"""Add a new idfobject to the model.
If you don't specify a value for a field, the default value will be set.
For example ::
newidfobject("CONSTRUCTION")
newidfobject("CONSTRUCTION",
Name='Interior Ceiling_class',
Outside_Layer='LW Concrete',
Layer_2='soundmat')
:param key: The type of IDF object. This must be in ALL_CAPS.
:param aname: This parameter is not used. It is left there for backward compatibility.
:param kwargs: Keyword arguments in the format `field=value` used to set fields in the EnergyPlus object.
:returns: EpBunch object.
"""
obj = newrawobject(self.model, self.idd_info, key)
abunch = obj2bunch(self.model, self.idd_info, obj)
if aname:
warnings.warn(
"The aname parameter should no longer be used (%s)." % aname,
UserWarning,
)
namebunch(abunch, aname)
self.idfobjects[key].append(abunch) # type: Dict[str, Idf_MSequence]
for k, v in kwargs.items():
abunch[k] = v
return abunch
def test_namebunch():
"""py.test for namebunch"""
thedata = (
(Bunch(dict(Name="", a=5)), "yay", "yay"), # abunch, aname, thename
(Bunch(dict(Name=None, a=5)), "yay", None), # abunch, aname, thename
)
for abunch, aname, thename in thedata:
result = modeleditor.namebunch(abunch, aname)
assert result.Name == thename
def test_namebunch():
"""py.test for namebunch"""
thedata = ((bunch.Bunch(dict(Name="", a=5)),
"yay", "yay"), # abunch, aname, thename
(bunch.Bunch(dict(Name=None, a=5)),
"yay", None), # abunch, aname, thename
)
for abunch, aname, thename in thedata:
result = modeleditor.namebunch(abunch, aname)
assert result.Name == thename
def newidfobject(self, key, aname='', **kwargs):
"""
Add a new idfobject to the model. If you don't specify a value for a
field, the default value will be set.
For example ::
newidfobject("CONSTRUCTION")
newidfobject("CONSTRUCTION",
Name='Interior Ceiling_class',
Outside_Layer='LW Concrete',
Layer_2='soundmat')
Parameters
----------
key : str
The type of IDF object. This must be in ALL_CAPS.
aname : str, deprecated
This parameter is not used. It is left there for backward
compatibility.
**kwargs
Keyword arguments in the format `field=value` used to set the value
of fields in the IDF object when it is created.
Returns
-------
EpBunch object
"""
obj = newrawobject(self.model, self.idd_info, key)
abunch = obj2bunch(self.model, self.idd_info, obj)
if aname:
warning.warn("The aname parameter should no longer be used.")
namebunch(abunch, aname)
self.idfobjects[key].append(abunch)
for k, v in kwargs.items():
abunch[k] = v
return abunch