xbrl.formula.VariableSet

An xbrl.formula.VariableSet class represents a <variable:variableSet> resource in the formula network.

class xbrl.formula.VariableSet

Proper instances of this class will be created within RaptorXML only, instantiation from script code will throw a NotImplementedError exception.

Attributes

xbrl.formula.VariableSet.aspect_model

Returns the value of the ‘aspectModel’ attribute as an xbrl.formula.AspectModel enumeration.

xbrl.formula.VariableSet.filter_relationships

Returns an iterator of xbrl.formula.VariableSetFilterRelationship objects which represent the variable-set-filter relationships from this <variable:variableSet> resource.

xbrl.formula.VariableSet.implicit_filtering

Returns the inferred value of the ‘implicitFiltering’ attribute as bool.

xbrl.formula.VariableSet.precondition_relationships

Returns an iterator of xbrl.formula.VariableSetPreconditionRelationship objects which represent the variable-set-precondition relationships from this <variable:variableSet> resource.

xbrl.formula.VariableSet.variable_set_relationships

Returns an iterator of xbrl.formula.VariableSetRelationship objects which represent the variable-set relationships from this <variable:variableSet> resource.

Methods

xbrl.formula.VariableSet.find_variable(qname)

[Deprecated: Use resolve_variable() instead!] Returns an xbrl.formula.Parameter or xbrl.formula.Variable object which represents the formula paramter or variable with the given XML qualified name within the scope of this variable set, or None if no parameter or variable was found.

xbrl.formula.VariableSet.referenced_parameters()

Returns an iterator of xbrl.formula.Parameter objects representing the referenced formula parameters by this <variable:variableSet> resource and any other associated resources.

xbrl.formula.VariableSet.resolve_variable(qname)

Returns an xbrl.formula.Parameter or xbrl.formula.Variable object which represents the formula paramter or variable with the given XML qualified name within the scope of this variable set, or None if no parameter or variable was found.

Special methods

__bool__, __eq__, __ge__, __gt__, __le__, __lt__, __ne__