ActiveComponentData

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

class pyomo.core.base.component.ActiveComponentData(component)

基础类: ComponentData

这是用于Pyomo建模组件中的组件数据的基类，这些组件可以被激活和停用。

可能会出现父组件处于_active=True状态，但所有ComponentData都处于_active=False状态的情况。这似乎是一个合理的状态，尽管我们无法轻易检测到这种情况。重要的是要避免一个或多个ComponentData处于活动状态，但父组件声称active=False的情况。这个类结构旨在防止这种情况发生。

Constructor arguments:

owner 拥有此数据对象的组件

Private class attributes:

_component 拥有此数据对象的组件的弱引用 _index 此数据对象的索引 _active 一个布尔值，指示此数据是否处于活动状态

__init__(component)

方法

__init__(component)
activate()	将活动属性设置为True
clear_suffix_value(suffix_or_name[, expand])	设置此组件数据的后缀值
cname(*args, **kwds)	已弃用。
deactivate()	将活动属性设置为False
get_suffix_value(suffix_or_name[, default])	获取此组件数据的后缀值
getname([fully_qualified, name_buffer, ...])	返回包含组件名称和索引的字符串
index()	返回此ComponentData实例相对于父组件索引集的索引。
is_component_type()	如果此类是Pyomo组件，则返回True
is_expression_type([expression_system])	如果此数值是一个表达式，则返回 True
is_indexed()	如果此组件已索引，则返回true
is_logical_type()	如果此类是Pyomo布尔对象，则返回True。
is_named_expression_type()	如果此数值是一个命名表达式，则返回 True
is_numeric_type()	如果此类是Pyomo数值对象，则返回True
is_parameter_type()	除非此类是参数对象，否则返回 False
is_reference()	如果此对象是引用，则返回 True。
is_variable_type()	除非此类是变量对象，否则返回 False
model()	返回拥有此数据的组件的模型。
parent_block()	返回拥有此数据的组件的父组件。
parent_component()	返回与此对象关联的组件。
pprint([ostream, verbose, prefix])	打印组件信息
set_suffix_value(suffix_or_name, value[, expand])	设置此组件数据的后缀值
type()	已弃用。

属性

active	返回活动属性
ctype	返回此组件的类类型
local_name	仅在直接父容器的上下文中获取组件名称。
name	获取完全限定的组件名称。

成员文档

activate()

将活动属性设置为True

clear_suffix_value(suffix_or_name, expand=True)

设置此组件数据的后缀值

cname(*args, **kwds)

已弃用。

自版本5.0起已弃用：cname() 方法已重命名为 getname()。 获取组件名称的首选方法是使用 .name 属性，该属性返回完全限定的组件名称。 .local_name 属性将仅在直接父容器的上下文中返回组件名称。

deactivate()

将活动属性设置为False

get_suffix_value(suffix_or_name, default=None)

获取此组件数据的后缀值

getname(fully_qualified=False, name_buffer=None, relative_to=None)

返回包含组件名称和索引的字符串

index()

返回此ComponentData实例相对于父组件索引集的索引。如果此实例没有父组件，或者由于某些未知原因此实例不属于父组件的索引集，则返回None。

is_component_type()

如果此类是Pyomo组件，则返回True

is_expression_type(expression_system=None)

如果此数值是一个表达式，则返回 True

is_indexed()

如果此组件已索引，则返回true

is_logical_type()

如果此类是Pyomo布尔对象，则返回True。

布尔对象包括常量、变量或逻辑表达式。

is_named_expression_type()

如果此数值是一个命名表达式，则返回 True

is_numeric_type()

如果此类是Pyomo数值对象，则返回True

is_parameter_type()

除非此类是参数对象，否则返回 False

is_reference()

如果此对象是引用，则返回 True。

is_variable_type()

除非此类是变量对象，否则返回 False

model()

返回拥有此数据的组件的模型。

parent_block()

返回拥有此数据的组件的父组件。

parent_component()

返回与此对象关联的组件。

pprint(ostream=None, verbose=False, prefix='')

打印组件信息

请注意，此方法通常只能通过IndexedComponent容器中的ComponentData对象访问。组件，包括未索引的Component派生类以及标量和索引的IndexedComponent派生类，将会看到Component.pprint()

set_suffix_value(suffix_or_name, value, expand=True)

设置此组件数据的后缀值

type()

已弃用。

返回此组件的类类型

自版本5.7起已弃用：Component.type() 方法已被 .ctype 属性取代。

property active

返回活动属性

property ctype

返回此组件的类类型

property local_name

仅在直接父容器的上下文中获取组件名称。

property name

获取完全限定的组件名称。