get_indexed_cuid

(function from pyomo.contrib.mpc.data.get_cuid)

pyomo.contrib.mpc.data.get_cuid.get_indexed_cuid(var, sets=None, dereference=None, context=None)[source]

Attempt to convert the provided “var” object into a CUID with wildcards

Parameters:

  • var – Object to process. May be a VarData, IndexedVar (reference or otherwise), ComponentUID, slice, or string.

  • sets (Tuple of sets) – Sets to use if slicing a vardata object

  • dereference (None or int) – Number of times we may access referent attribute to recover a “base component” from a reference.

  • context (Block) – Block with respect to which slices and CUIDs will be generated

Returns:

ComponentUID corresponding to the provided var and sets

Return type:

ComponentUID