block_dict

(class from pyomo.core.kernel.block)

class pyomo.core.kernel.block.block_dict(*args, **kwds)

Bases: DictContainer

A dict-style container for objects with category type IBlock

__init__(*args, **kwds)

Methods

`__init__`(args, *kwds)
`activate`([shallow])	Activate this container.
`child`(key)	Get the child object associated with a given storage key for this container.
`children`()	A generator over the children of this container.
`clear`()
`clone`()	Returns a copy of this object with the parent pointer set to `None`.
`components`([active])	Generates an efficient traversal of all components stored under this container.
`deactivate`([shallow])	Deactivate this container.
`get`(k[,d])
`getname`([fully_qualified, name_buffer, ...])	Dynamically generates a name for this object.
`items`()
`keys`()
`pop`(k[,d])	If key is not found, d is returned if given, otherwise KeyError is raised.
`popitem`()	as a 2-tuple; but raise KeyError if D is empty.
`setdefault`(k[,d])
`update`([E, ]**F)	If E present and has a .keys() method, does: for k in E.keys(): D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v
`values`()

Attributes

`active`	The active status of this object.
`ctype`	The object's category type.
`local_name`	The object's local name within the context of its parent.
`name`	The object's fully qualified name.
`parent`	The object's parent (possibly None).
`storage_key`	The object's storage key within its parent

Member Documentation

activate(shallow=True): Activate this container.

child(key)

Get the child object associated with a given storage key for this container.

Raises:: KeyError – if the argument is not a storage key for any children of this container

children(): A generator over the children of this container.

clear() → None. Remove all items from D.

clone()

Returns a copy of this object with the parent pointer set to None.

A clone is almost equivalent to deepcopy except that any categorized objects encountered that are not descendents of this object will reference the same object on the clone.

components(active=True)

Generates an efficient traversal of all components stored under this container. Components are categorized objects that are either (1) not containers, or (2) are heterogeneous containers.

Parameters:: active (True/None) – Controls whether or not to filter the iteration to include only the active part of the storage tree. The default is True. Setting this keyword to None causes the active status of objects to be ignored.
Returns:: iterator of components in the storage tree

deactivate(shallow=True): Deactivate this container.

get(k[, d]) → D[k] if k in D, else d. d defaults to None.

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

Dynamically generates a name for this object.

Parameters:

fully_qualified (bool) – Generate a full name by iterating through all ancestor containers. Default is False.
convert (function) – A function that converts a storage key into a string representation. Default is the built-in function str.
relative_to – When generating a fully qualified name, generate the name relative to this block.

Returns:

If a parent exists, this method returns a string representing the name of the object in the context of its parent; otherwise (if no parent exists), this method returns None.

items() → a set-like object providing a view on D's items

keys() → a set-like object providing a view on D's keys

pop(k[, d]) → v, remove specified key and return the corresponding value.: If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() → (k, v), remove and return some (key, value) pair: as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D

update([E, ]**F) → None. Update D from mapping/iterable E and F.: If E present and has a .keys() method, does: for k in E.keys(): D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() → an object providing a view on D's values

property active: The active status of this object.

property ctype: The object’s category type.

property local_name: The object’s local name within the context of its parent. Alias for obj.getname(fully_qualified=False).

property name: The object’s fully qualified name. Alias for obj.getname(fully_qualified=True).

property parent: The object’s parent (possibly None).

property storage_key: The object’s storage key within its parent