ICategorizedObjectContainer

(类来自 pyomo.core.kernel.base)

class pyomo.core.kernel.base.ICategorizedObjectContainer

基础类: ICategorizedObject

用于分类对象的分类容器的接口。

__init__()

方法

__init__()
activate([shallow])	激活此容器。
child(*args, **kwds)	根据存储键返回此容器的子项。
children(*args, **kwds)	生成器遍历此容器的子元素。
clone()	返回此对象的副本，并将父指针设置为None。
components(*args, **kwds)	生成器遍历存储在此容器下的组件集。
deactivate([shallow])	停用此容器。
getname([fully_qualified, name_buffer, ...])	动态生成此对象的名称。

属性

active	此对象的活动状态。
ctype	对象的类别类型。
local_name	对象在其父级上下文中的本地名称。
name	对象的完全限定名称。
parent	对象的父级（可能为None）。
storage_key	对象在其父级中的存储键

成员文档

activate(shallow=True)

激活此容器。

child(*args, **kwds)

返回给定存储键的此容器的子项。

children(*args, **kwds)

生成器遍历此容器的子元素。

clone()

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

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

components(*args, **kwds)

生成器遍历存储在此容器下的组件集合。

deactivate(shallow=True)

停用此容器。

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

动态生成此对象的名称。

Parameters:

• fully_qualified (bool) – 通过迭代所有祖先容器生成完整名称。 默认值为 False。

• convert (function) – 一个将存储键转换为字符串表示的函数。默认是内置函数 str。

• relative_to (object) – 在生成完全限定名称时，生成相对于此块的名称。

Returns:

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

property active

此对象的活动状态。

property ctype

对象的类别类型。

property local_name

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

property name

对象的完全限定名称。obj.getname(fully_qualified=True)的别名。

property parent

对象的父级（可能为None）。

property storage_key

对象在其父级中的存储键