IBlock

class pyomo.core.kernel.block.IBlock[source]

一个可以存储任何类别类型对象作为属性的通用容器。

方法

`__init__`()
`activate`([shallow])	激活此容器。
`child`(key)	获取与此容器关联的给定存储键的子对象。
`child_ctypes`(args, *kwds)	返回存储在此容器中的子对象类别类型的集合。
`children`(args, *kwds)	生成器遍历此容器的子元素。
`clone`()	返回此对象的副本，并将父指针设置为`None`。
`collect_ctypes`([active, descend_into])	返回可以在此容器下找到的对象类别类型的集合。
`component_data_objects`(args, *kwds)
`component_objects`(args, *kwds)
`components`([ctype, active, descend_into])	生成对此容器下存储的所有组件的高效遍历。
`deactivate`([shallow])	停用此容器。
`getname`([fully_qualified, name_buffer, ...])	动态生成此对象的名称。

属性

成员文档

child(key)[source]

获取与此容器关联的给定存储键的子对象。

clone()

返回此对象的副本，并将父指针设置为None。

克隆几乎等同于深拷贝，除了遇到的任何分类对象如果不是该对象的后代，将在克隆上引用相同的对象。

collect_ctypes(active=True, descend_into=True)

返回可以在此容器下找到的对象类别类型的集合。

Parameters:

active (True/None) – 控制是否过滤迭代以仅包括存储树的活跃部分。默认值为True。将此关键字设置为None会导致忽略对象的活跃状态。
descend_into (bool, function) – 表示是否要进入一个异构容器。默认值为True，这相当于lambda x: True，意味着所有异构容器都将被进入。

Returns:

一组对象类别类型

components(ctype=<class 'pyomo.core.kernel.base._no_ctype'>, active=True, descend_into=True)

生成对此容器下存储的所有组件的高效遍历。组件是分类的对象，它们要么是（1）非容器，要么是（2）异构容器。

Parameters:

ctype – 表示要包含的组件类别。默认值表示应包含所有类别。
active (True/None) – 控制是否过滤迭代以仅包括存储树的活跃部分。默认值为True。将此关键字设置为None会导致忽略对象的活跃状态。
descend_into (bool, function) – 表示是否要进入一个异构容器。默认值为True，这相当于lambda x: True，意味着所有异构容器都将被进入。

Returns:

存储树中的组件迭代器

getname(fully_qualified=False, name_buffer={}, convert=<class 'str'>, relative_to=None)

动态生成此对象的名称。

Parameters:

Returns:

如果存在父对象，此方法返回一个字符串，表示该对象在其父对象上下文中的名称；否则（如果不存在父对象），此方法返回None。

property local_name: 对象在其父级上下文中的本地名称。是 obj.getname(fully_qualified=False)的别名。