diff --git a/annotated.html b/annotated.html index 71e65a7..81683c3 100644 --- a/annotated.html +++ b/annotated.html @@ -80,8 +80,8 @@  Ncommon  Nbase_specification  CBaseSpecificationBase class for specifications in the Timeloop framework - NnodesNode classes for parsing and processing specification trees - CCombineableListNodeA list node that can be combined with others by extending + NnodesCopy Node classes for parsing and processing specification trees + CCombinableListNodeA list node that can be combined with others by extending  CDictNodeA node that is a dictionary of other nodes  CFlatteningListNodeA list node that flattens lists of lists  CGrabParentAddMe @@ -90,111 +90,122 @@  CParseErrorException for nodes  CTypeSpecifierRepresents a type specifier for a node in the TimeloopFE library  CUnspecifiedClass to represent an unspecified value - NprocessorBase class for all processors - CProcessorBase class for all processors, which are used to modify the specification before it is passed to Accelergy/Timeloop - CProcessorErrorException raised by processors - CReferences2CopiesProcessorConverts references to copies in the specification - CSimpleProcessorAn example simple processor - Nv4Timeloop v4 Specification - Narch - CArchitectureAn architecture - CArchNodeA node in the architecture hierarchy - CArchNodesA collection of architectural nodes - CAttributesA class representing attributes for a node in the architecture - CBranchA branch in the architecture - CComponentA component in the architecture - CComputeA compute component - CContainerA container in the architecture - CHierarchicalA hierarchical branch in the architecture - CLeafA leaf node in the architecture hierarchy - CNetworkA network component - CNetworksA list of networks in the architecture - CNothingA class representing a 'nothing' component - CParallelA parallel branch in the architecture - CPipelined" A pipelined branch in the architecture - CSpatialA spatial configuration in a system architecture - CStorageA storage component - CStorageAttributesRepresents the attributes of a storage element - Ncomponents - CActionRepresents an action that a component can perform - CActionsListA list of actions for a component - CActionSubcomponentsListA list of actions that may be taken as subactions of an action - CComponentAttributesRepresents the attributes of a component - CComponentsA collection of components - CComponentsListA list of components - CCompoundComponentRepresents a compound component - CSubcomponentA subcomponent - CSubcomponentActionA subcomponent action - CSubcomponentActionGroupA group of subactions taken by a particular subcomponent - CSubcomponentActionListA list of subcomponent actions - CSubcomponentListA list of subcomponents - Nconstraints - CConstraintA constraint in the system - CConstraintGroupA group of constraints - CConstraintsClass representing constraints - CConstraintsListA class representing a list of constraints - CDataspaceA constraint class for specifying dataspace properties - CFactorA loop factor (e.g., P=1) - CFactorsA list of factors used to describe loop bounds - CIterationAn iteration (spatial or temporal) constraint - CMaxOverbookedProportionA constraint that defines the maximum overbooked proportion - CPermutationA permutation of ranks - CProblemDataspaceListA list of problem dataspaces - CSpatialA spatial iteration constraint - CTemporalA temporal iteration constraint - CUtilizationA constraint that defines the utilization of a component - Nglobals - CEnvironmentVariablesDictionary of environment variables - CExpressionCustomFunctionsA list of paths to Python files containing functions to be used in expressions - CGlobalsTop-level Globals key - Nmapper - CMapperA mapper object that holds various attributes and settings for mapping operations in Timeloop - COptimizationMetricsA list of optimization metrics including delay, energy, EDP, and last level accesses - Nmapspace - CMapspaceTop-level mapspace object - Nproblem - CDataSpaceA data space object - CDensityA Density object represents the density and distribution of a workload tensor - CDensityListA list of densities for each data space - CInstanceAn problem instance object - CProblemThe top-level problem object in Timeloop - CProblemDataspaceListA list of data spaces in the problem - CShapeProblem shape object - NprocessorsStandard suite of processors for timeloopfe - Nconstraint_attacherTakes constraints from constraints lists and attaches them to objects in the architecture - CConstraintAttacherProcessorTakes constraints from constraints lists and attaches them to objects in the architecture - Nconstraint_macroDefines constraint macros to be used for simplifying constraint specification - CConstraintMacroProcessorDefines constraint macros to be used for simplifying constraint specification - Ndataspace2branchResolves which data spaces are kept in which branches - CDataspace2BranchProcessorResolves which data spaces are kept in which branches - Nenable_dummy_tableEnables the dummy table for Accelergy to placeholder energy/area - CEnableDummyTableProcessorEnable the dummy table for Accelergy to placeholder energy/area - Npermutation_optimizerOptimizes permutation by pruning superfluous permutations - CPermutationOptimizerProcessorOptimizes permutation by pruning superfluous permutations - Nrequired_actionsTakes constraints from constraints lists and attaches them to objects in the architecture - CRequiredActionsProcessorEnsures that all components have actions defined for Accelergy Storage: - Nsparse_opt_attacherTakes sparse optimizations from sparse optimizations lists and attaches them to the architecture - CSparseOptAttacherProcessorTakes sparse optimizations from sparse optimizations lists and attaches them to the architecture - Nto_diagram_processor - CToDiagramProcessorGenerates a Graphviz diagram of the architecture - Nsparse_optimizations - CActionOptimizationAn action optimization - CActionOptimizationListA list of action optimizations - CActionOptimizationOptionAn action optimization option - CActionOptimizationOptionListA list of action optimization options - CComputeOptimizationA compute optimization - CRepresentationDataSpaceContains the representation format for a data space - CRepresentationFormatA representation format sparse optimization - CRepresentationProblemDataspaceListA list of representation problem dataspaces - CRepresentationRankA representation rank - CRepresentationRankListA list of ranks to be used in the representation format - CSparseOptimizationGroupA group of sparse optimizations - CSparseOptimizationsTop-level class for sparse optimizations - CSparseOptimizationsListA list of sparse optimizations - Nspecification - CSpecificationA top-level class for the Timeloop specification - Nvariables - CVariablesA top-level class for variables + Nnodes copy + CCombinableListNodeA list node that can be combined with others by extending + CDictNodeA node that is a dictionary of other nodes + CFlatteningListNodeA list node that flattens lists of lists + CGrabParentAddMe + CListNodeA node that is a list of other nodes + CNodeBase class for all nodes in the hierarchy + CParseErrorException for nodes + CTypeSpecifierRepresents a type specifier for a node in the TimeloopFE library + CUnspecifiedClass to represent an unspecified value + NprocessorBase class for all processors + CProcessorBase class for all processors, which are used to modify the specification before it is passed to Accelergy/Timeloop + CProcessorErrorException raised by processors + CReferences2CopiesProcessorConverts references to copies in the specification + CSimpleProcessorAn example simple processor + Nv4Timeloop v4 Specification + Narch + CArchitectureAn architecture + CArchNodeA node in the architecture hierarchy + CArchNodesA collection of architectural nodes + CAttributesA class representing attributes for a node in the architecture + CBranchA branch in the architecture + CComponentA component in the architecture + CComputeA compute component + CContainerA container in the architecture + CHierarchicalA hierarchical branch in the architecture + CLeafA leaf node in the architecture hierarchy + CNetworkA network component + CNetworksA list of networks in the architecture + CNothingA class representing a 'nothing' component + CParallelA parallel branch in the architecture + CPipelined" A pipelined branch in the architecture + CSpatialA spatial configuration in a system architecture + CStorageA storage component + CStorageAttributesRepresents the attributes of a storage element + Ncomponents + CActionRepresents an action that a component can perform + CActionsListA list of actions for a component + CActionSubcomponentsListA list of actions that may be taken as subactions of an action + CComponentAttributesRepresents the attributes of a component + CComponentsA collection of components + CComponentsListA list of components + CCompoundComponentRepresents a compound component + CSubcomponentA subcomponent + CSubcomponentActionA subcomponent action + CSubcomponentActionGroupA group of subactions taken by a particular subcomponent + CSubcomponentActionListA list of subcomponent actions + CSubcomponentListA list of subcomponents + Nconstraints + CConstraintA constraint in the system + CConstraintGroupA group of constraints + CConstraintsClass representing constraints + CConstraintsListA class representing a list of constraints + CDataspaceA constraint class for specifying dataspace properties + CFactorA loop factor (e.g., P=1) + CFactorsA list of factors used to describe loop bounds + CIterationAn iteration (spatial or temporal) constraint + CMaxOverbookedProportionA constraint that defines the maximum overbooked proportion + CPermutationA permutation of ranks + CProblemDataspaceListA list of problem dataspaces + CSpatialA spatial iteration constraint + CTemporalA temporal iteration constraint + CUtilizationA constraint that defines the utilization of a component + Nglobals + CEnvironmentVariablesDictionary of environment variables + CExpressionCustomFunctionsA list of paths to Python files containing functions to be used in expressions + CGlobalsTop-level Globals key + Nmapper + CMapperA mapper object that holds various attributes and settings for mapping operations in Timeloop + COptimizationMetricsA list of optimization metrics including delay, energy, EDP, and last level accesses + Nmapspace + CMapspaceTop-level mapspace object + Nproblem + CDataSpaceA data space object + CDensityA Density object represents the density and distribution of a workload tensor + CDensityListA list of densities for each data space + CInstanceAn problem instance object + CProblemThe top-level problem object in Timeloop + CProblemDataspaceListA list of data spaces in the problem + CShapeProblem shape object + NprocessorsStandard suite of processors for timeloopfe + Nconstraint_attacherTakes constraints from constraints lists and attaches them to objects in the architecture + CConstraintAttacherProcessorTakes constraints from constraints lists and attaches them to objects in the architecture + Nconstraint_macroDefines constraint macros to be used for simplifying constraint specification + CConstraintMacroProcessorDefines constraint macros to be used for simplifying constraint specification + Ndataspace2branchResolves which data spaces are kept in which branches + CDataspace2BranchProcessorResolves which data spaces are kept in which branches + Nenable_dummy_tableEnables the dummy table for Accelergy to placeholder energy/area + CEnableDummyTableProcessorEnable the dummy table for Accelergy to placeholder energy/area + Npermutation_optimizerOptimizes permutation by pruning superfluous permutations + CPermutationOptimizerProcessorOptimizes permutation by pruning superfluous permutations + Nrequired_actionsTakes constraints from constraints lists and attaches them to objects in the architecture + CRequiredActionsProcessorEnsures that all components have actions defined for Accelergy Storage: + Nsparse_opt_attacherTakes sparse optimizations from sparse optimizations lists and attaches them to the architecture + CSparseOptAttacherProcessorTakes sparse optimizations from sparse optimizations lists and attaches them to the architecture + Nto_diagram_processor + CToDiagramProcessorGenerates a Graphviz diagram of the architecture + Nsparse_optimizations + CActionOptimizationAn action optimization + CActionOptimizationListA list of action optimizations + CActionOptimizationOptionAn action optimization option + CActionOptimizationOptionListA list of action optimization options + CComputeOptimizationA compute optimization + CComputeOptimizationListA list of compute optimizations + CRepresentationDataSpaceContains the representation format for a data space + CRepresentationFormatA representation format sparse optimization + CRepresentationProblemDataspaceListA list of representation problem dataspaces + CRepresentationRankA representation rank + CRepresentationRankListA list of ranks to be used in the representation format + CSparseOptimizationGroupA group of sparse optimizations + CSparseOptimizationsTop-level class for sparse optimizations + CSparseOptimizationsListA list of sparse optimizations + Nspecification + CSpecificationA top-level class for the Timeloop specification + Nvariables + CVariablesA top-level class for variables diff --git a/classes.html b/classes.html index 2c26897..ccd32a6 100644 --- a/classes.html +++ b/classes.html @@ -84,19 +84,19 @@
BaseSpecification (timeloopfe.common.base_specification)
Branch (timeloopfe.v4.arch)
C
-
CombineableListNode (timeloopfe.common.nodes)
Component (timeloopfe.v4.arch)
ComponentAttributes (timeloopfe.v4.components)
Components (timeloopfe.v4.components)
ComponentsList (timeloopfe.v4.components)
CompoundComponent (timeloopfe.v4.components)
Compute (timeloopfe.v4.arch)
ComputeOptimization (timeloopfe.v4.sparse_optimizations)
Constraint (timeloopfe.v4.constraints)
ConstraintAttacherProcessor (timeloopfe.v4.processors.constraint_attacher)
ConstraintGroup (timeloopfe.v4.constraints)
ConstraintMacroProcessor (timeloopfe.v4.processors.constraint_macro)
Constraints (timeloopfe.v4.constraints)
ConstraintsList (timeloopfe.v4.constraints)
Container (timeloopfe.v4.arch)
+
CombinableListNode (timeloopfe.common.nodes)
CombinableListNode (timeloopfe.common.nodes copy)
Component (timeloopfe.v4.arch)
ComponentAttributes (timeloopfe.v4.components)
Components (timeloopfe.v4.components)
ComponentsList (timeloopfe.v4.components)
CompoundComponent (timeloopfe.v4.components)
Compute (timeloopfe.v4.arch)
ComputeOptimization (timeloopfe.v4.sparse_optimizations)
ComputeOptimizationList (timeloopfe.v4.sparse_optimizations)
Constraint (timeloopfe.v4.constraints)
ConstraintAttacherProcessor (timeloopfe.v4.processors.constraint_attacher)
ConstraintGroup (timeloopfe.v4.constraints)
ConstraintMacroProcessor (timeloopfe.v4.processors.constraint_macro)
Constraints (timeloopfe.v4.constraints)
ConstraintsList (timeloopfe.v4.constraints)
Container (timeloopfe.v4.arch)
D
-
Dataspace (timeloopfe.v4.constraints)
DataSpace (timeloopfe.v4.problem)
Dataspace2BranchProcessor (timeloopfe.v4.processors.dataspace2branch)
Density (timeloopfe.v4.problem)
DensityList (timeloopfe.v4.problem)
DictNode (timeloopfe.common.nodes)
+
Dataspace (timeloopfe.v4.constraints)
DataSpace (timeloopfe.v4.problem)
Dataspace2BranchProcessor (timeloopfe.v4.processors.dataspace2branch)
Density (timeloopfe.v4.problem)
DensityList (timeloopfe.v4.problem)
DictNode (timeloopfe.common.nodes copy)
DictNode (timeloopfe.common.nodes)
E
EnableDummyTableProcessor (timeloopfe.v4.processors.enable_dummy_table)
EnvironmentVariables (timeloopfe.v4.globals)
ExpressionCustomFunctions (timeloopfe.v4.globals)
F
-
Factor (timeloopfe.v4.constraints)
Factors (timeloopfe.v4.constraints)
FlatteningListNode (timeloopfe.common.nodes)
+
Factor (timeloopfe.v4.constraints)
Factors (timeloopfe.v4.constraints)
FlatteningListNode (timeloopfe.common.nodes copy)
FlatteningListNode (timeloopfe.common.nodes)
G
-
Globals (timeloopfe.v4.globals)
GrabParentAddMe (timeloopfe.common.nodes)
+
Globals (timeloopfe.v4.globals)
GrabParentAddMe (timeloopfe.common.nodes copy)
GrabParentAddMe (timeloopfe.common.nodes)
H
Hierarchical (timeloopfe.v4.arch)
@@ -105,19 +105,19 @@
Instance (timeloopfe.v4.problem)
Iteration (timeloopfe.v4.constraints)
L
-
Leaf (timeloopfe.v4.arch)
ListNode (timeloopfe.common.nodes)
+
Leaf (timeloopfe.v4.arch)
ListNode (timeloopfe.common.nodes copy)
ListNode (timeloopfe.common.nodes)
M
Mapper (timeloopfe.v4.mapper)
Mapspace (timeloopfe.v4.mapspace)
MaxOverbookedProportion (timeloopfe.v4.constraints)
N
-
Network (timeloopfe.v4.arch)
Networks (timeloopfe.v4.arch)
Node (timeloopfe.common.nodes)
Nothing (timeloopfe.v4.arch)
+
Network (timeloopfe.v4.arch)
Networks (timeloopfe.v4.arch)
Node (timeloopfe.common.nodes copy)
Node (timeloopfe.common.nodes)
Nothing (timeloopfe.v4.arch)
O
OptimizationMetrics (timeloopfe.v4.mapper)
P
-
Parallel (timeloopfe.v4.arch)
ParseError (timeloopfe.common.nodes)
Permutation (timeloopfe.v4.constraints)
PermutationOptimizerProcessor (timeloopfe.v4.processors.permutation_optimizer)
Pipelined (timeloopfe.v4.arch)
Problem (timeloopfe.v4.problem)
ProblemDataspaceList (timeloopfe.v4.constraints)
ProblemDataspaceList (timeloopfe.v4.problem)
Processor (timeloopfe.common.processor)
ProcessorError (timeloopfe.common.processor)
+
Parallel (timeloopfe.v4.arch)
ParseError (timeloopfe.common.nodes copy)
ParseError (timeloopfe.common.nodes)
Permutation (timeloopfe.v4.constraints)
PermutationOptimizerProcessor (timeloopfe.v4.processors.permutation_optimizer)
Pipelined (timeloopfe.v4.arch)
Problem (timeloopfe.v4.problem)
ProblemDataspaceList (timeloopfe.v4.constraints)
ProblemDataspaceList (timeloopfe.v4.problem)
Processor (timeloopfe.common.processor)
ProcessorError (timeloopfe.common.processor)
R
References2CopiesProcessor (timeloopfe.common.processor)
RepresentationDataSpace (timeloopfe.v4.sparse_optimizations)
RepresentationFormat (timeloopfe.v4.sparse_optimizations)
RepresentationProblemDataspaceList (timeloopfe.v4.sparse_optimizations)
RepresentationRank (timeloopfe.v4.sparse_optimizations)
RepresentationRankList (timeloopfe.v4.sparse_optimizations)
RequiredActionsProcessor (timeloopfe.v4.processors.required_actions)
@@ -126,10 +126,10 @@
Shape (timeloopfe.v4.problem)
SimpleProcessor (timeloopfe.common.processor)
SparseOptAttacherProcessor (timeloopfe.v4.processors.sparse_opt_attacher)
SparseOptimizationGroup (timeloopfe.v4.sparse_optimizations)
SparseOptimizations (timeloopfe.v4.sparse_optimizations)
SparseOptimizationsList (timeloopfe.v4.sparse_optimizations)
Spatial (timeloopfe.v4.arch)
Spatial (timeloopfe.v4.constraints)
Specification (timeloopfe.v4.specification)
Storage (timeloopfe.v4.arch)
StorageAttributes (timeloopfe.v4.arch)
Subcomponent (timeloopfe.v4.components)
SubcomponentAction (timeloopfe.v4.components)
SubcomponentActionGroup (timeloopfe.v4.components)
SubcomponentActionList (timeloopfe.v4.components)
SubcomponentList (timeloopfe.v4.components)
T
-
Temporal (timeloopfe.v4.constraints)
ToDiagramProcessor (timeloopfe.v4.processors.to_diagram_processor)
TypeSpecifier (timeloopfe.common.nodes)
+
Temporal (timeloopfe.v4.constraints)
ToDiagramProcessor (timeloopfe.v4.processors.to_diagram_processor)
TypeSpecifier (timeloopfe.common.nodes copy)
TypeSpecifier (timeloopfe.common.nodes)
U
-
Unspecified (timeloopfe.common.nodes)
Utilization (timeloopfe.v4.constraints)
+
Unspecified (timeloopfe.common.nodes copy)
Unspecified (timeloopfe.common.nodes)
Utilization (timeloopfe.v4.constraints)
V
Variables (timeloopfe.v4.variables)
diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1CombinableListNode-members.html b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1CombinableListNode-members.html new file mode 100644 index 0000000..81d331a --- /dev/null +++ b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1CombinableListNode-members.html @@ -0,0 +1,92 @@ + + + + + + + +TimeloopFE: Member List + + + + + + + + + + + +
+
+ + + + + + +
+
TimeloopFE +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
timeloopfe.common.nodes copy.CombinableListNode Member List
+
+
+ +

This is the complete list of members for timeloopfe.common.nodes copy.CombinableListNode, including all inherited members.

+ + + +
__class__timeloopfe.common.nodes copy.CombinableListNodeprivate
combine(self, "CombinableListNode" other)timeloopfe.common.nodes copy.CombinableListNode
+ + + + diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1CombinableListNode.html b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1CombinableListNode.html new file mode 100644 index 0000000..1523e85 --- /dev/null +++ b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1CombinableListNode.html @@ -0,0 +1,327 @@ + + + + + + + +TimeloopFE: timeloopfe.common.nodes copy.CombinableListNode Class Reference + + + + + + + + + + + +
+
+ + + + + + +
+
TimeloopFE +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Member Functions | +Private Attributes | +List of all members
+
timeloopfe.common.nodes copy.CombinableListNode Class Reference
+
+
+ +

A list node that can be combined with others by extending. + More...

+
+Inheritance diagram for timeloopfe.common.nodes copy.CombinableListNode:
+
+
Inheritance graph
+ + + + + + + + + + + +
[legend]
+
+Collaboration diagram for timeloopfe.common.nodes copy.CombinableListNode:
+
+
Collaboration graph
+ + + + + + + + + + + +
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

"CombinableListNode" combine (self, "CombinableListNode" other)
 Extends this list with the contents of another list.
 
- Public Member Functions inherited from timeloopfe.common.nodes copy.ListNode
 __init__ (self, *args, **kwargs)
 
- Public Member Functions inherited from timeloopfe.common.nodes copy.Node
 get_specifiers_from_processors (cls, "BaseSpecification" spec)
 Get the specifiers that have been set from processors.
 
 reset_specifiers_from_processors (cls, Optional[Type] processor=None)
 Reset the specifiers that have been set from processors.
 
 declare_attrs (cls, *args, **kwargs)
 Initialize the attributes of this node.
 
 reset_processor_elems (cls, Optional[Type] processor=None)
 
 recognize_all (cls, bool recognize_all=True)
 Set whether all attributes under this node should be recognized.
 
str get_tag (self)
 Get the tag of this node.
 
Iterable[Tuple[Union[str, int], Any]] items (self)
 Get iterable of (key, value) or (index, value) pairs.
 
T combine_index (self, Union[str, int] key, T value)
 Combine the value at the given key with the given value.
 
str get_name (self, Union[Set, None] seen=None)
 Get the name of this node.
 
 check_unrecognized (self, bool ignore_empty=False, ignore_should_have_been_removed_by=False)
 Check for unrecognized keys in this node and all subnodes.
 
Any recursive_apply (self, callable func, bool self_first=False, set applied_to=None)
 Apply a function to this node and all subnodes.
 
 clean_empties (self)
 Remove empty nodes from this node and all subnodes.
 
bool isempty (self)
 Return True if this node is empty.
 
bool isempty_recursive (self)
 Return True if this node or all subnodes are empty.
 
 add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None)
 Initialize a type specifier for this class.
 
List[Tget_nodes_of_type (self, Type[T] node_type)
 Return a list of all subnodes of a given type.
 
Callable get_setter_lambda (self, Union[str, int] keytag)
 Get a function that can be used to set a value in this node.
 
Callable get_combiner_lambda (self, Union[str, int] keytag)
 Get a function that can be used to combine a value to this node.
 
List[Tuple[Any, Callable]] get_setters_for_keytag (self, str keytag, bool recursive=True)
 Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag.
 
List[Tuple[Any, Callable]] get_combiners_for_keytag (self, str keytag, bool recursive=True)
 Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag.
 
List[Tuple[Any, Callable]] get_setters_for_type (self, Type t, bool recursive=True)
 Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type.
 
List[Tuple[Any, Callable]] get_combiners_for_type (self, Type t, bool recursive=True)
 Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type.
 
 __str__ (self)
 Return the name of this node.
 
 __format__ (self, format_spec)
 Formats the name of this node.
 
bool is_defined_non_default_non_empty (self, str key)
 Returns True if the given key is defined in this node and is not the default value and is not empty.
 
Any __getitem__ (self, Union[str, int] key)
 Get the value at the given key or index.
 
 __setitem__ (self, Union[str, int] key, Any value)
 Set the value at the given key or index.
 
 parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None)
 Parse expressions in this node and all subnodes.
 
 unique_class_name (cls)
 Return a unique name for this class.
 
+ + + +

+Private Attributes

 __class__
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Additional Inherited Members

- Static Public Member Functions inherited from timeloopfe.common.nodes copy.Node
"BaseSpecification" get_global_spec ()
 Get the global specification object.
 
 set_global_spec ("BaseSpecification" spec)
 Set the global specification object.
 
Any try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None)
 Try to combine two values.
 
- Public Attributes inherited from timeloopfe.common.nodes copy.ListNode
 from_data
 
- Public Attributes inherited from timeloopfe.common.nodes copy.Node
 logger
 
 parent_node
 
 spec
 
- Protected Member Functions inherited from timeloopfe.common.nodes copy.Node
Dict[str, TypeSpecifier_get_type_specifiers (cls, "BaseSpecification" spec)
 Get the type specifiers for this node.
 
 _get_all_recognized (self)
 
Dict[Union[str, int], TypeSpecifier_get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None)
 
 _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None)
 
 _parse_elems (self)
 
 _parse_extra_elems (self, List[Tuple[str, Any]] key2elem)
 
 _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False)
 
 _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None)
 
- Static Protected Member Functions inherited from timeloopfe.common.nodes copy.Node
str _get_tag (x)
 
- Protected Attributes inherited from timeloopfe.common.nodes copy.Node
 _default_parse
 
+

Detailed Description

+

A list node that can be combined with others by extending.

+

Member Function Documentation

+ +

◆ combine()

+ +
+
+ + + + + + + + + + + +
"CombinableListNode" timeloopfe.common.nodes copy.CombinableListNode.combine ( self,
"CombinableListNode" other )
+
+ +

Extends this list with the contents of another list.

+ +
+
+

Member Data Documentation

+ +

◆ __class__

+ +
+
+ + + + + +
+ + + + +
timeloopfe.common.nodes copy.CombinableListNode.__class__
+
+private
+
+ +
+
+
The documentation for this class was generated from the following file: +
+ + + + diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1CombinableListNode__coll__graph.map b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1CombinableListNode__coll__graph.map new file mode 100644 index 0000000..a550d51 --- /dev/null +++ b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1CombinableListNode__coll__graph.map @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1CombinableListNode__coll__graph.md5 b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1CombinableListNode__coll__graph.md5 new file mode 100644 index 0000000..c40dbc8 --- /dev/null +++ b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1CombinableListNode__coll__graph.md5 @@ -0,0 +1 @@ +34cad7e4ceb0e951f908e6abdc453aaa \ No newline at end of file diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1CombinableListNode__coll__graph.png b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1CombinableListNode__coll__graph.png new file mode 100644 index 0000000..2134996 Binary files /dev/null and b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1CombinableListNode__coll__graph.png differ diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1CombinableListNode__inherit__graph.map b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1CombinableListNode__inherit__graph.map new file mode 100644 index 0000000..a550d51 --- /dev/null +++ b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1CombinableListNode__inherit__graph.map @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1CombinableListNode__inherit__graph.md5 b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1CombinableListNode__inherit__graph.md5 new file mode 100644 index 0000000..c40dbc8 --- /dev/null +++ b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1CombinableListNode__inherit__graph.md5 @@ -0,0 +1 @@ +34cad7e4ceb0e951f908e6abdc453aaa \ No newline at end of file diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1CombinableListNode__inherit__graph.png b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1CombinableListNode__inherit__graph.png new file mode 100644 index 0000000..2134996 Binary files /dev/null and b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1CombinableListNode__inherit__graph.png differ diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1DictNode-members.html b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1DictNode-members.html new file mode 100644 index 0000000..d37344e --- /dev/null +++ b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1DictNode-members.html @@ -0,0 +1,109 @@ + + + + + + + +TimeloopFE: Member List + + + + + + + + + + + +
+
+ + + + + + +
+
TimeloopFE +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
timeloopfe.common.nodes copy.DictNode Member List
+
+
+ +

This is the complete list of members for timeloopfe.common.nodes copy.DictNode, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + +
__class__timeloopfe.common.nodes copy.DictNodeprivate
__getattr__(self, name)timeloopfe.common.nodes copy.DictNode
__getitem__(self, Any __key)timeloopfe.common.nodes copy.DictNode
__init__(self, *args, __node_skip_parse=False, **kwargs)timeloopfe.common.nodes copy.DictNode
__setattr__(self, name, value)timeloopfe.common.nodes copy.DictNode
__setitem__(self, Any __key, Any __value)timeloopfe.common.nodes copy.DictNode
_check_alias(self, key)timeloopfe.common.nodes copy.DictNodeprotected
_require_all_or_none_oftimeloopfe.common.nodes copy.DictNodeprotected
_require_one_oftimeloopfe.common.nodes copy.DictNodeprotected
_update_combine_pre_parse(self, dict other)timeloopfe.common.nodes copy.DictNodeprotected
check_unrecognized(self, *args, **kwargs)timeloopfe.common.nodes copy.DictNode
combine(self, "DictNode" other)timeloopfe.common.nodes copy.DictNode
from_yaml_files(cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs)timeloopfe.common.nodes copy.DictNode
get(self, Any __key, Any __default=None)timeloopfe.common.nodes copy.DictNode
pop(self, Any __key, Any __default=None)timeloopfe.common.nodes copy.DictNode
require_all_or_none_of(cls, *args)timeloopfe.common.nodes copy.DictNode
require_one_of(cls, *args)timeloopfe.common.nodes copy.DictNode
setdefault(self, Any __key, Any __default=None)timeloopfe.common.nodes copy.DictNode
spectimeloopfe.common.nodes copy.DictNode
+ + + + diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1DictNode.html b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1DictNode.html new file mode 100644 index 0000000..bbb56a0 --- /dev/null +++ b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1DictNode.html @@ -0,0 +1,824 @@ + + + + + + + +TimeloopFE: timeloopfe.common.nodes copy.DictNode Class Reference + + + + + + + + + + + +
+
+ + + + + + +
+
TimeloopFE +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Member Functions | +Public Attributes | +Protected Member Functions | +Protected Attributes | +Private Attributes | +List of all members
+
timeloopfe.common.nodes copy.DictNode Class Reference
+
+
+ +

A node that is a dictionary of other nodes. + More...

+
+Inheritance diagram for timeloopfe.common.nodes copy.DictNode:
+
+
Inheritance graph
+ + + + + + + + + +
[legend]
+
+Collaboration diagram for timeloopfe.common.nodes copy.DictNode:
+
+
Collaboration graph
+ + + + + + + + + +
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 __init__ (self, *args, __node_skip_parse=False, **kwargs)
 
 require_one_of (cls, *args)
 Require that at least one of the given keys is present.
 
 require_all_or_none_of (cls, *args)
 Require that all or none of the given keys are present.
 
"DictNode" combine (self, "DictNode" other)
 Combines this dictionary with another dictionary.
 
"DictNode" from_yaml_files (cls, *Union[str, List[str]] files, Dict[str, Any] jinja_parse_data=None, **kwargs)
 Loads a dictionary from one more more yaml files.
 
Any __getitem__ (self, Any __key)
 Get the value at the given key or index.
 
None __setitem__ (self, Any __key, Any __value)
 Set the value at the given key or index.
 
Any get (self, Any __key, Any __default=None)
 Gets a key from the dictionary.
 
Any setdefault (self, Any __key, Any __default=None)
 Sets the default value for a key.
 
Any pop (self, Any __key, Any __default=None)
 Pops a key from the dictionary.
 
None check_unrecognized (self, *args, **kwargs)
 Check for unrecognized keys in this node and all subnodes.
 
 __getattr__ (self, name)
 Index into the attributes or the contents of this node.
 
 __setattr__ (self, name, value)
 
- Public Member Functions inherited from timeloopfe.common.nodes copy.Node
 get_specifiers_from_processors (cls, "BaseSpecification" spec)
 Get the specifiers that have been set from processors.
 
 reset_specifiers_from_processors (cls, Optional[Type] processor=None)
 Reset the specifiers that have been set from processors.
 
 declare_attrs (cls, *args, **kwargs)
 Initialize the attributes of this node.
 
 reset_processor_elems (cls, Optional[Type] processor=None)
 
 recognize_all (cls, bool recognize_all=True)
 Set whether all attributes under this node should be recognized.
 
str get_tag (self)
 Get the tag of this node.
 
Iterable[Tuple[Union[str, int], Any]] items (self)
 Get iterable of (key, value) or (index, value) pairs.
 
T combine_index (self, Union[str, int] key, T value)
 Combine the value at the given key with the given value.
 
str get_name (self, Union[Set, None] seen=None)
 Get the name of this node.
 
Any recursive_apply (self, callable func, bool self_first=False, set applied_to=None)
 Apply a function to this node and all subnodes.
 
 clean_empties (self)
 Remove empty nodes from this node and all subnodes.
 
bool isempty (self)
 Return True if this node is empty.
 
bool isempty_recursive (self)
 Return True if this node or all subnodes are empty.
 
 add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None)
 Initialize a type specifier for this class.
 
List[Tget_nodes_of_type (self, Type[T] node_type)
 Return a list of all subnodes of a given type.
 
Callable get_setter_lambda (self, Union[str, int] keytag)
 Get a function that can be used to set a value in this node.
 
Callable get_combiner_lambda (self, Union[str, int] keytag)
 Get a function that can be used to combine a value to this node.
 
List[Tuple[Any, Callable]] get_setters_for_keytag (self, str keytag, bool recursive=True)
 Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag.
 
List[Tuple[Any, Callable]] get_combiners_for_keytag (self, str keytag, bool recursive=True)
 Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag.
 
List[Tuple[Any, Callable]] get_setters_for_type (self, Type t, bool recursive=True)
 Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type.
 
List[Tuple[Any, Callable]] get_combiners_for_type (self, Type t, bool recursive=True)
 Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type.
 
 __str__ (self)
 Return the name of this node.
 
 __format__ (self, format_spec)
 Formats the name of this node.
 
bool is_defined_non_default_non_empty (self, str key)
 Returns True if the given key is defined in this node and is not the default value and is not empty.
 
 parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None)
 Parse expressions in this node and all subnodes.
 
 unique_class_name (cls)
 Return a unique name for this class.
 
+ + + + + + + + + + +

+Public Attributes

 spec
 
- Public Attributes inherited from timeloopfe.common.nodes copy.Node
 logger
 
 parent_node
 
 spec
 
+ + + + + + + + + + + + + + + + + + + + + + + +

+Protected Member Functions

 _update_combine_pre_parse (self, dict other)
 
None _check_alias (self, key)
 
- Protected Member Functions inherited from timeloopfe.common.nodes copy.Node
Dict[str, TypeSpecifier_get_type_specifiers (cls, "BaseSpecification" spec)
 Get the type specifiers for this node.
 
 _get_all_recognized (self)
 
Dict[Union[str, int], TypeSpecifier_get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None)
 
 _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None)
 
 _parse_elems (self)
 
 _parse_extra_elems (self, List[Tuple[str, Any]] key2elem)
 
 _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False)
 
 _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None)
 
+ + + + + + + + +

+Protected Attributes

 _require_one_of
 
 _require_all_or_none_of
 
- Protected Attributes inherited from timeloopfe.common.nodes copy.Node
 _default_parse
 
+ + + +

+Private Attributes

 __class__
 
+ + + + + + + + + + + + + + +

+Additional Inherited Members

- Static Public Member Functions inherited from timeloopfe.common.nodes copy.Node
"BaseSpecification" get_global_spec ()
 Get the global specification object.
 
 set_global_spec ("BaseSpecification" spec)
 Set the global specification object.
 
Any try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None)
 Try to combine two values.
 
- Static Protected Member Functions inherited from timeloopfe.common.nodes copy.Node
str _get_tag (x)
 
+

Detailed Description

+

A node that is a dictionary of other nodes.

+

Constructor & Destructor Documentation

+ +

◆ __init__()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + +
timeloopfe.common.nodes copy.DictNode.__init__ ( self,
* args,
__node_skip_parse = False,
** kwargs )
+
+ +

Reimplemented from timeloopfe.common.nodes copy.Node.

+ +
+
+

Member Function Documentation

+ +

◆ __getattr__()

+ +
+
+ + + + + + + + + + + +
timeloopfe.common.nodes copy.DictNode.__getattr__ ( self,
name )
+
+ +

Index into the attributes or the contents of this node.

+ +
+
+ +

◆ __getitem__()

+ +
+
+ + + + + + + + + + + +
Any timeloopfe.common.nodes copy.DictNode.__getitem__ ( self,
Any key )
+
+ +

Get the value at the given key or index.

+ +

Reimplemented from timeloopfe.common.nodes copy.Node.

+ +
+
+ +

◆ __setattr__()

+ +
+
+ + + + + + + + + + + + + + + + +
timeloopfe.common.nodes copy.DictNode.__setattr__ ( self,
name,
value )
+
+ +
+
+ +

◆ __setitem__()

+ +
+
+ + + + + + + + + + + + + + + + +
None timeloopfe.common.nodes copy.DictNode.__setitem__ ( self,
Any key,
Any value )
+
+ +

Set the value at the given key or index.

+ +

Reimplemented from timeloopfe.common.nodes copy.Node.

+ +
+
+ +

◆ _check_alias()

+ +
+
+ + + + + +
+ + + + + + + + + + + +
None timeloopfe.common.nodes copy.DictNode._check_alias ( self,
key )
+
+protected
+
+ +
+
+ +

◆ _update_combine_pre_parse()

+ +
+
+ + + + + +
+ + + + + + + + + + + +
timeloopfe.common.nodes copy.DictNode._update_combine_pre_parse ( self,
dict other )
+
+protected
+
+ +
+
+ +

◆ check_unrecognized()

+ +
+
+ + + + + + + + + + + + + + + + +
None timeloopfe.common.nodes copy.DictNode.check_unrecognized ( self,
* args,
** kwargs )
+
+ +

Check for unrecognized keys in this node and all subnodes.

+ +

Reimplemented from timeloopfe.common.nodes copy.Node.

+ +
+
+ +

◆ combine()

+ +
+
+ + + + + + + + + + + +
"DictNode" timeloopfe.common.nodes copy.DictNode.combine ( self,
"DictNode" other )
+
+ +

Combines this dictionary with another dictionary.

+

If a key is present in both dictionaries, the values are combined. Otherwise, the key is taken from whichever dictionary has it.

+ +
+
+ +

◆ from_yaml_files()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + +
"DictNode" timeloopfe.common.nodes copy.DictNode.from_yaml_files ( cls,
*Union[str, List[str]] files,
Dict[str, Any] jinja_parse_data = None,
** kwargs )
+
+ +

Loads a dictionary from one more more yaml files.

+

Each yaml file should contain a dictionary. Dictionaries are combined in the order they are given.

+

Keyword arguments are also added to the dictionary.

+

Args: files: A list of yaml files to load. jinja_parse_data: A dictionary of data to use when parsing kwargs: Extra keyword arguments to add to the dictionary.

+

Returns: A DictNode containing the combined dictionaries.

+

Loads a dictionary from a list of yaml files. Each yaml file should contain a dictionary. Dictionaries are in the given order. Keyword arguments are also added to the dictionary. !

Parameters
+ + + + +
filesA list of yaml files to load. !
jinja_parse_dataA dictionary of data to use when parsing !
kwargsExtra keyword arguments to add to the dictionary.
+
+
+ +
+
+ +

◆ get()

+ +
+
+ + + + + + + + + + + + + + + + +
Any timeloopfe.common.nodes copy.DictNode.get ( self,
Any __key,
Any __default = None )
+
+ +

Gets a key from the dictionary.

+ +
+
+ +

◆ pop()

+ +
+
+ + + + + + + + + + + + + + + + +
Any timeloopfe.common.nodes copy.DictNode.pop ( self,
Any __key,
Any __default = None )
+
+ +

Pops a key from the dictionary.

+ +
+
+ +

◆ require_all_or_none_of()

+ +
+
+ + + + + + + + + + + +
timeloopfe.common.nodes copy.DictNode.require_all_or_none_of ( cls,
* args )
+
+ +

Require that all or none of the given keys are present.

+ +
+
+ +

◆ require_one_of()

+ +
+
+ + + + + + + + + + + +
timeloopfe.common.nodes copy.DictNode.require_one_of ( cls,
* args )
+
+ +

Require that at least one of the given keys is present.

+ +
+
+ +

◆ setdefault()

+ +
+
+ + + + + + + + + + + + + + + + +
Any timeloopfe.common.nodes copy.DictNode.setdefault ( self,
Any __key,
Any __default = None )
+
+ +

Sets the default value for a key.

+ +
+
+

Member Data Documentation

+ +

◆ __class__

+ +
+
+ + + + + +
+ + + + +
timeloopfe.common.nodes copy.DictNode.__class__
+
+private
+
+ +
+
+ +

◆ _require_all_or_none_of

+ +
+
+ + + + + +
+ + + + +
timeloopfe.common.nodes copy.DictNode._require_all_or_none_of
+
+protected
+
+ +
+
+ +

◆ _require_one_of

+ +
+
+ + + + + +
+ + + + +
timeloopfe.common.nodes copy.DictNode._require_one_of
+
+protected
+
+ +
+
+ +

◆ spec

+ +
+
+ + + + +
timeloopfe.common.nodes copy.DictNode.spec
+
+ +
+
+
The documentation for this class was generated from the following file: +
+ + + + diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1DictNode__coll__graph.map b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1DictNode__coll__graph.map new file mode 100644 index 0000000..073f23d --- /dev/null +++ b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1DictNode__coll__graph.map @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1DictNode__coll__graph.md5 b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1DictNode__coll__graph.md5 new file mode 100644 index 0000000..c506121 --- /dev/null +++ b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1DictNode__coll__graph.md5 @@ -0,0 +1 @@ +b5bd75044ac4fcd90c3941ed100d78f3 \ No newline at end of file diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1DictNode__coll__graph.png b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1DictNode__coll__graph.png new file mode 100644 index 0000000..2fa6cef Binary files /dev/null and b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1DictNode__coll__graph.png differ diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1DictNode__inherit__graph.map b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1DictNode__inherit__graph.map new file mode 100644 index 0000000..073f23d --- /dev/null +++ b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1DictNode__inherit__graph.map @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1DictNode__inherit__graph.md5 b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1DictNode__inherit__graph.md5 new file mode 100644 index 0000000..c506121 --- /dev/null +++ b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1DictNode__inherit__graph.md5 @@ -0,0 +1 @@ +b5bd75044ac4fcd90c3941ed100d78f3 \ No newline at end of file diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1DictNode__inherit__graph.png b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1DictNode__inherit__graph.png new file mode 100644 index 0000000..2fa6cef Binary files /dev/null and b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1DictNode__inherit__graph.png differ diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1FlatteningListNode-members.html b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1FlatteningListNode-members.html new file mode 100644 index 0000000..b67aa09 --- /dev/null +++ b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1FlatteningListNode-members.html @@ -0,0 +1,93 @@ + + + + + + + +TimeloopFE: Member List + + + + + + + + + + + +
+
+ + + + + + +
+
TimeloopFE +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
timeloopfe.common.nodes copy.FlatteningListNode Member List
+
+
+ +

This is the complete list of members for timeloopfe.common.nodes copy.FlatteningListNode, including all inherited members.

+ + + + +
__init__(self, *args, **kwargs)timeloopfe.common.nodes copy.FlatteningListNode
_flatten(self)timeloopfe.common.nodes copy.FlatteningListNodeprotected
combine(self, "FlatteningListNode" other)timeloopfe.common.nodes copy.FlatteningListNode
+ + + + diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1FlatteningListNode.html b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1FlatteningListNode.html new file mode 100644 index 0000000..6928cfe --- /dev/null +++ b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1FlatteningListNode.html @@ -0,0 +1,354 @@ + + + + + + + +TimeloopFE: timeloopfe.common.nodes copy.FlatteningListNode Class Reference + + + + + + + + + + + +
+
+ + + + + + +
+
TimeloopFE +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Member Functions | +Protected Member Functions | +List of all members
+
timeloopfe.common.nodes copy.FlatteningListNode Class Reference
+
+
+ +

A list node that flattens lists of lists. + More...

+
+Inheritance diagram for timeloopfe.common.nodes copy.FlatteningListNode:
+
+
Inheritance graph
+ + + + + + + + + + + +
[legend]
+
+Collaboration diagram for timeloopfe.common.nodes copy.FlatteningListNode:
+
+
Collaboration graph
+ + + + + + + + + + + +
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

"FlatteningListNode" combine (self, "FlatteningListNode" other)
 
 __init__ (self, *args, **kwargs)
 
- Public Member Functions inherited from timeloopfe.common.nodes copy.Node
 get_specifiers_from_processors (cls, "BaseSpecification" spec)
 Get the specifiers that have been set from processors.
 
 reset_specifiers_from_processors (cls, Optional[Type] processor=None)
 Reset the specifiers that have been set from processors.
 
 declare_attrs (cls, *args, **kwargs)
 Initialize the attributes of this node.
 
 reset_processor_elems (cls, Optional[Type] processor=None)
 
 recognize_all (cls, bool recognize_all=True)
 Set whether all attributes under this node should be recognized.
 
str get_tag (self)
 Get the tag of this node.
 
Iterable[Tuple[Union[str, int], Any]] items (self)
 Get iterable of (key, value) or (index, value) pairs.
 
T combine_index (self, Union[str, int] key, T value)
 Combine the value at the given key with the given value.
 
str get_name (self, Union[Set, None] seen=None)
 Get the name of this node.
 
 check_unrecognized (self, bool ignore_empty=False, ignore_should_have_been_removed_by=False)
 Check for unrecognized keys in this node and all subnodes.
 
Any recursive_apply (self, callable func, bool self_first=False, set applied_to=None)
 Apply a function to this node and all subnodes.
 
 clean_empties (self)
 Remove empty nodes from this node and all subnodes.
 
bool isempty (self)
 Return True if this node is empty.
 
bool isempty_recursive (self)
 Return True if this node or all subnodes are empty.
 
 add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None)
 Initialize a type specifier for this class.
 
List[Tget_nodes_of_type (self, Type[T] node_type)
 Return a list of all subnodes of a given type.
 
Callable get_setter_lambda (self, Union[str, int] keytag)
 Get a function that can be used to set a value in this node.
 
Callable get_combiner_lambda (self, Union[str, int] keytag)
 Get a function that can be used to combine a value to this node.
 
List[Tuple[Any, Callable]] get_setters_for_keytag (self, str keytag, bool recursive=True)
 Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag.
 
List[Tuple[Any, Callable]] get_combiners_for_keytag (self, str keytag, bool recursive=True)
 Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag.
 
List[Tuple[Any, Callable]] get_setters_for_type (self, Type t, bool recursive=True)
 Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type.
 
List[Tuple[Any, Callable]] get_combiners_for_type (self, Type t, bool recursive=True)
 Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type.
 
 __str__ (self)
 Return the name of this node.
 
 __format__ (self, format_spec)
 Formats the name of this node.
 
bool is_defined_non_default_non_empty (self, str key)
 Returns True if the given key is defined in this node and is not the default value and is not empty.
 
Any __getitem__ (self, Union[str, int] key)
 Get the value at the given key or index.
 
 __setitem__ (self, Union[str, int] key, Any value)
 Set the value at the given key or index.
 
 parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None)
 Parse expressions in this node and all subnodes.
 
 unique_class_name (cls)
 Return a unique name for this class.
 
+ + + + + + + + + + + + + + + + + + + + + +

+Protected Member Functions

 _flatten (self)
 
- Protected Member Functions inherited from timeloopfe.common.nodes copy.Node
Dict[str, TypeSpecifier_get_type_specifiers (cls, "BaseSpecification" spec)
 Get the type specifiers for this node.
 
 _get_all_recognized (self)
 
Dict[Union[str, int], TypeSpecifier_get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None)
 
 _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None)
 
 _parse_elems (self)
 
 _parse_extra_elems (self, List[Tuple[str, Any]] key2elem)
 
 _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False)
 
 _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None)
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Additional Inherited Members

- Static Public Member Functions inherited from timeloopfe.common.nodes copy.Node
"BaseSpecification" get_global_spec ()
 Get the global specification object.
 
 set_global_spec ("BaseSpecification" spec)
 Set the global specification object.
 
Any try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None)
 Try to combine two values.
 
- Public Attributes inherited from timeloopfe.common.nodes copy.ListNode
 from_data
 
- Public Attributes inherited from timeloopfe.common.nodes copy.Node
 logger
 
 parent_node
 
 spec
 
- Static Protected Member Functions inherited from timeloopfe.common.nodes copy.Node
str _get_tag (x)
 
- Protected Attributes inherited from timeloopfe.common.nodes copy.Node
 _default_parse
 
+

Detailed Description

+

A list node that flattens lists of lists.

+

Constructor & Destructor Documentation

+ +

◆ __init__()

+ +
+
+ + + + + + + + + + + + + + + + +
timeloopfe.common.nodes copy.FlatteningListNode.__init__ ( self,
* args,
** kwargs )
+
+ +

Reimplemented from timeloopfe.common.nodes copy.ListNode.

+ +
+
+

Member Function Documentation

+ +

◆ _flatten()

+ +
+
+ + + + + +
+ + + + + + + +
timeloopfe.common.nodes copy.FlatteningListNode._flatten ( self)
+
+protected
+
+ +
+
+ +

◆ combine()

+ +
+
+ + + + + + + + + + + +
"FlatteningListNode" timeloopfe.common.nodes copy.FlatteningListNode.combine ( self,
"FlatteningListNode" other )
+
+ +
+
+
The documentation for this class was generated from the following file: +
+ + + + diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1FlatteningListNode__coll__graph.map b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1FlatteningListNode__coll__graph.map new file mode 100644 index 0000000..1709877 --- /dev/null +++ b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1FlatteningListNode__coll__graph.map @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1FlatteningListNode__coll__graph.md5 b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1FlatteningListNode__coll__graph.md5 new file mode 100644 index 0000000..08d525f --- /dev/null +++ b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1FlatteningListNode__coll__graph.md5 @@ -0,0 +1 @@ +fd8658af9e87b7e1dd5cea24ae777209 \ No newline at end of file diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1FlatteningListNode__coll__graph.png b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1FlatteningListNode__coll__graph.png new file mode 100644 index 0000000..cc4dc33 Binary files /dev/null and b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1FlatteningListNode__coll__graph.png differ diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1FlatteningListNode__inherit__graph.map b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1FlatteningListNode__inherit__graph.map new file mode 100644 index 0000000..1709877 --- /dev/null +++ b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1FlatteningListNode__inherit__graph.map @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1FlatteningListNode__inherit__graph.md5 b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1FlatteningListNode__inherit__graph.md5 new file mode 100644 index 0000000..08d525f --- /dev/null +++ b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1FlatteningListNode__inherit__graph.md5 @@ -0,0 +1 @@ +fd8658af9e87b7e1dd5cea24ae777209 \ No newline at end of file diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1FlatteningListNode__inherit__graph.png b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1FlatteningListNode__inherit__graph.png new file mode 100644 index 0000000..cc4dc33 Binary files /dev/null and b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1FlatteningListNode__inherit__graph.png differ diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1GrabParentAddMe-members.html b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1GrabParentAddMe-members.html new file mode 100644 index 0000000..fec1f04 --- /dev/null +++ b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1GrabParentAddMe-members.html @@ -0,0 +1,94 @@ + + + + + + + +TimeloopFE: Member List + + + + + + + + + + + +
+
+ + + + + + +
+
TimeloopFE +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
timeloopfe.common.nodes copy.GrabParentAddMe Member List
+
+
+ +

This is the complete list of members for timeloopfe.common.nodes copy.GrabParentAddMe, including all inherited members.

+ + + + + +
__enter__(self)timeloopfe.common.nodes copy.GrabParentAddMe
__exit__(self, *args)timeloopfe.common.nodes copy.GrabParentAddMe
__init__(self, "Node" add_elem)timeloopfe.common.nodes copy.GrabParentAddMe
add_elemtimeloopfe.common.nodes copy.GrabParentAddMe
+ + + + diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1GrabParentAddMe.html b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1GrabParentAddMe.html new file mode 100644 index 0000000..e049ffa --- /dev/null +++ b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1GrabParentAddMe.html @@ -0,0 +1,185 @@ + + + + + + + +TimeloopFE: timeloopfe.common.nodes copy.GrabParentAddMe Class Reference + + + + + + + + + + + +
+
+ + + + + + +
+
TimeloopFE +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Member Functions | +Public Attributes | +List of all members
+
timeloopfe.common.nodes copy.GrabParentAddMe Class Reference
+
+
+ + + + + + + + +

+Public Member Functions

 __init__ (self, "Node" add_elem)
 
 __enter__ (self)
 
 __exit__ (self, *args)
 
+ + + +

+Public Attributes

 add_elem
 
+

Constructor & Destructor Documentation

+ +

◆ __init__()

+ +
+
+ + + + + + + + + + + +
timeloopfe.common.nodes copy.GrabParentAddMe.__init__ ( self,
"Node" add_elem )
+
+ +
+
+

Member Function Documentation

+ +

◆ __enter__()

+ +
+
+ + + + + + + +
timeloopfe.common.nodes copy.GrabParentAddMe.__enter__ ( self)
+
+ +
+
+ +

◆ __exit__()

+ +
+
+ + + + + + + + + + + +
timeloopfe.common.nodes copy.GrabParentAddMe.__exit__ ( self,
* args )
+
+ +
+
+

Member Data Documentation

+ +

◆ add_elem

+ +
+
+ + + + +
timeloopfe.common.nodes copy.GrabParentAddMe.add_elem
+
+ +
+
+
The documentation for this class was generated from the following file: +
+ + + + diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1ListNode-members.html b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1ListNode-members.html new file mode 100644 index 0000000..33df26d --- /dev/null +++ b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1ListNode-members.html @@ -0,0 +1,92 @@ + + + + + + + +TimeloopFE: Member List + + + + + + + + + + + +
+
+ + + + + + +
+
TimeloopFE +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
timeloopfe.common.nodes copy.ListNode Member List
+
+
+ +

This is the complete list of members for timeloopfe.common.nodes copy.ListNode, including all inherited members.

+ + + +
__init__(self, *args, **kwargs)timeloopfe.common.nodes copy.ListNode
from_datatimeloopfe.common.nodes copy.ListNode
+ + + + diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1ListNode.html b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1ListNode.html new file mode 100644 index 0000000..37de304 --- /dev/null +++ b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1ListNode.html @@ -0,0 +1,319 @@ + + + + + + + +TimeloopFE: timeloopfe.common.nodes copy.ListNode Class Reference + + + + + + + + + + + +
+
+ + + + + + +
+
TimeloopFE +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Member Functions | +Public Attributes | +List of all members
+
timeloopfe.common.nodes copy.ListNode Class Reference
+
+
+ +

A node that is a list of other nodes. + More...

+
+Inheritance diagram for timeloopfe.common.nodes copy.ListNode:
+
+
Inheritance graph
+ + + + + + + + + + + + + +
[legend]
+
+Collaboration diagram for timeloopfe.common.nodes copy.ListNode:
+
+
Collaboration graph
+ + + + + + + + + +
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 __init__ (self, *args, **kwargs)
 
- Public Member Functions inherited from timeloopfe.common.nodes copy.Node
 get_specifiers_from_processors (cls, "BaseSpecification" spec)
 Get the specifiers that have been set from processors.
 
 reset_specifiers_from_processors (cls, Optional[Type] processor=None)
 Reset the specifiers that have been set from processors.
 
 declare_attrs (cls, *args, **kwargs)
 Initialize the attributes of this node.
 
 reset_processor_elems (cls, Optional[Type] processor=None)
 
 recognize_all (cls, bool recognize_all=True)
 Set whether all attributes under this node should be recognized.
 
str get_tag (self)
 Get the tag of this node.
 
Iterable[Tuple[Union[str, int], Any]] items (self)
 Get iterable of (key, value) or (index, value) pairs.
 
T combine_index (self, Union[str, int] key, T value)
 Combine the value at the given key with the given value.
 
str get_name (self, Union[Set, None] seen=None)
 Get the name of this node.
 
 check_unrecognized (self, bool ignore_empty=False, ignore_should_have_been_removed_by=False)
 Check for unrecognized keys in this node and all subnodes.
 
Any recursive_apply (self, callable func, bool self_first=False, set applied_to=None)
 Apply a function to this node and all subnodes.
 
 clean_empties (self)
 Remove empty nodes from this node and all subnodes.
 
bool isempty (self)
 Return True if this node is empty.
 
bool isempty_recursive (self)
 Return True if this node or all subnodes are empty.
 
 add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None)
 Initialize a type specifier for this class.
 
List[Tget_nodes_of_type (self, Type[T] node_type)
 Return a list of all subnodes of a given type.
 
Callable get_setter_lambda (self, Union[str, int] keytag)
 Get a function that can be used to set a value in this node.
 
Callable get_combiner_lambda (self, Union[str, int] keytag)
 Get a function that can be used to combine a value to this node.
 
List[Tuple[Any, Callable]] get_setters_for_keytag (self, str keytag, bool recursive=True)
 Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag.
 
List[Tuple[Any, Callable]] get_combiners_for_keytag (self, str keytag, bool recursive=True)
 Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag.
 
List[Tuple[Any, Callable]] get_setters_for_type (self, Type t, bool recursive=True)
 Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type.
 
List[Tuple[Any, Callable]] get_combiners_for_type (self, Type t, bool recursive=True)
 Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type.
 
 __str__ (self)
 Return the name of this node.
 
 __format__ (self, format_spec)
 Formats the name of this node.
 
bool is_defined_non_default_non_empty (self, str key)
 Returns True if the given key is defined in this node and is not the default value and is not empty.
 
Any __getitem__ (self, Union[str, int] key)
 Get the value at the given key or index.
 
 __setitem__ (self, Union[str, int] key, Any value)
 Set the value at the given key or index.
 
 parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None)
 Parse expressions in this node and all subnodes.
 
 unique_class_name (cls)
 Return a unique name for this class.
 
+ + + + + + + + + + +

+Public Attributes

 from_data
 
- Public Attributes inherited from timeloopfe.common.nodes copy.Node
 logger
 
 parent_node
 
 spec
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Additional Inherited Members

- Static Public Member Functions inherited from timeloopfe.common.nodes copy.Node
"BaseSpecification" get_global_spec ()
 Get the global specification object.
 
 set_global_spec ("BaseSpecification" spec)
 Set the global specification object.
 
Any try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None)
 Try to combine two values.
 
- Protected Member Functions inherited from timeloopfe.common.nodes copy.Node
Dict[str, TypeSpecifier_get_type_specifiers (cls, "BaseSpecification" spec)
 Get the type specifiers for this node.
 
 _get_all_recognized (self)
 
Dict[Union[str, int], TypeSpecifier_get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None)
 
 _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None)
 
 _parse_elems (self)
 
 _parse_extra_elems (self, List[Tuple[str, Any]] key2elem)
 
 _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False)
 
 _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None)
 
- Static Protected Member Functions inherited from timeloopfe.common.nodes copy.Node
str _get_tag (x)
 
- Protected Attributes inherited from timeloopfe.common.nodes copy.Node
 _default_parse
 
+

Detailed Description

+

A node that is a list of other nodes.

+

Constructor & Destructor Documentation

+ +

◆ __init__()

+ +
+
+ + + + + + + + + + + + + + + + +
timeloopfe.common.nodes copy.ListNode.__init__ ( self,
* args,
** kwargs )
+
+
+

Member Data Documentation

+ +

◆ from_data

+ +
+
+ + + + +
timeloopfe.common.nodes copy.ListNode.from_data
+
+ +
+
+
The documentation for this class was generated from the following file: +
+ + + + diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1ListNode__coll__graph.map b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1ListNode__coll__graph.map new file mode 100644 index 0000000..f378ce9 --- /dev/null +++ b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1ListNode__coll__graph.map @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1ListNode__coll__graph.md5 b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1ListNode__coll__graph.md5 new file mode 100644 index 0000000..4d1998b --- /dev/null +++ b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1ListNode__coll__graph.md5 @@ -0,0 +1 @@ +39503fe4e5a0565ec53c718536312f5c \ No newline at end of file diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1ListNode__coll__graph.png b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1ListNode__coll__graph.png new file mode 100644 index 0000000..016daba Binary files /dev/null and b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1ListNode__coll__graph.png differ diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1ListNode__inherit__graph.map b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1ListNode__inherit__graph.map new file mode 100644 index 0000000..7719485 --- /dev/null +++ b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1ListNode__inherit__graph.map @@ -0,0 +1,13 @@ + + + + + + + + + + + + + diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1ListNode__inherit__graph.md5 b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1ListNode__inherit__graph.md5 new file mode 100644 index 0000000..b0c5194 --- /dev/null +++ b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1ListNode__inherit__graph.md5 @@ -0,0 +1 @@ +bc6eafdcd5ec16173f1fa1a85cb55363 \ No newline at end of file diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1ListNode__inherit__graph.png b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1ListNode__inherit__graph.png new file mode 100644 index 0000000..3286d98 Binary files /dev/null and b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1ListNode__inherit__graph.png differ diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1Node-members.html b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1Node-members.html new file mode 100644 index 0000000..780dda1 --- /dev/null +++ b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1Node-members.html @@ -0,0 +1,137 @@ + + + + + + + +TimeloopFE: Member List + + + + + + + + + + + +
+
+ + + + + + +
+
TimeloopFE +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
timeloopfe.common.nodes copy.Node Member List
+
+
+ +

This is the complete list of members for timeloopfe.common.nodes copy.Node, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
__currently_parsing_indextimeloopfe.common.nodes copy.Nodeprivate
__format__(self, format_spec)timeloopfe.common.nodes copy.Node
__getitem__(self, Union[str, int] key)timeloopfe.common.nodes copy.Node
__init__(self, *args, **kwargs)timeloopfe.common.nodes copy.Node
__setitem__(self, Union[str, int] key, Any value)timeloopfe.common.nodes copy.Node
__str__(self)timeloopfe.common.nodes copy.Node
_check_unrecognized(self, ignore_empty=False, ignore_should_have_been_removed_by=False)timeloopfe.common.nodes copy.Nodeprotected
_default_parsetimeloopfe.common.nodes copy.Nodeprotected
_get_all_recognized(self)timeloopfe.common.nodes copy.Nodeprotected
_get_index2checker(self, Optional[List[Tuple[str, Any]]] key2elem=None)timeloopfe.common.nodes copy.Nodeprotected
_get_tag(x)timeloopfe.common.nodes copy.Nodeprotectedstatic
_get_type_specifiers(cls, "BaseSpecification" spec)timeloopfe.common.nodes copy.Nodeprotected
_parse_elem(self, Union[str, int] key, TypeSpecifier check, Any value_override=None)timeloopfe.common.nodes copy.Nodeprotected
_parse_elems(self)timeloopfe.common.nodes copy.Nodeprotected
_parse_expression(self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None)timeloopfe.common.nodes copy.Nodeprotected
_parse_extra_elems(self, List[Tuple[str, Any]] key2elem)timeloopfe.common.nodes copy.Nodeprotected
add_attr(cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None)timeloopfe.common.nodes copy.Node
check_unrecognized(self, bool ignore_empty=False, ignore_should_have_been_removed_by=False)timeloopfe.common.nodes copy.Node
clean_empties(self)timeloopfe.common.nodes copy.Node
combine_index(self, Union[str, int] key, T value)timeloopfe.common.nodes copy.Node
declare_attrs(cls, *args, **kwargs)timeloopfe.common.nodes copy.Node
get_combiner_lambda(self, Union[str, int] keytag)timeloopfe.common.nodes copy.Node
get_combiners_for_keytag(self, str keytag, bool recursive=True)timeloopfe.common.nodes copy.Node
get_combiners_for_type(self, Type t, bool recursive=True)timeloopfe.common.nodes copy.Node
get_global_spec()timeloopfe.common.nodes copy.Nodestatic
get_name(self, Union[Set, None] seen=None)timeloopfe.common.nodes copy.Node
get_nodes_of_type(self, Type[T] node_type)timeloopfe.common.nodes copy.Node
get_setter_lambda(self, Union[str, int] keytag)timeloopfe.common.nodes copy.Node
get_setters_for_keytag(self, str keytag, bool recursive=True)timeloopfe.common.nodes copy.Node
get_setters_for_type(self, Type t, bool recursive=True)timeloopfe.common.nodes copy.Node
get_specifiers_from_processors(cls, "BaseSpecification" spec)timeloopfe.common.nodes copy.Node
get_tag(self)timeloopfe.common.nodes copy.Node
is_defined_non_default_non_empty(self, str key)timeloopfe.common.nodes copy.Node
isempty(self)timeloopfe.common.nodes copy.Node
isempty_recursive(self)timeloopfe.common.nodes copy.Node
items(self)timeloopfe.common.nodes copy.Node
loggertimeloopfe.common.nodes copy.Node
parent_nodetimeloopfe.common.nodes copy.Node
parse_expressions(self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None)timeloopfe.common.nodes copy.Node
recognize_all(cls, bool recognize_all=True)timeloopfe.common.nodes copy.Node
recursive_apply(self, callable func, bool self_first=False, set applied_to=None)timeloopfe.common.nodes copy.Node
reset_processor_elems(cls, Optional[Type] processor=None)timeloopfe.common.nodes copy.Node
reset_specifiers_from_processors(cls, Optional[Type] processor=None)timeloopfe.common.nodes copy.Node
set_global_spec("BaseSpecification" spec)timeloopfe.common.nodes copy.Nodestatic
spectimeloopfe.common.nodes copy.Node
try_combine(Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None)timeloopfe.common.nodes copy.Nodestatic
unique_class_name(cls)timeloopfe.common.nodes copy.Node
+ + + + diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1Node.html b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1Node.html new file mode 100644 index 0000000..760ba4b --- /dev/null +++ b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1Node.html @@ -0,0 +1,1546 @@ + + + + + + + +TimeloopFE: timeloopfe.common.nodes copy.Node Class Reference + + + + + + + + + + + +
+
+ + + + + + +
+
TimeloopFE +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Member Functions | +Static Public Member Functions | +Public Attributes | +Protected Member Functions | +Static Protected Member Functions | +Protected Attributes | +Private Attributes | +List of all members
+
timeloopfe.common.nodes copy.Node Class Reference
+
+
+ +

Base class for all nodes in the hierarchy. + More...

+
+Inheritance diagram for timeloopfe.common.nodes copy.Node:
+
+
Inheritance graph
+ + + + + + + + + + + + + +
[legend]
+
+Collaboration diagram for timeloopfe.common.nodes copy.Node:
+
+
Collaboration graph
+ + + + + +
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 __init__ (self, *args, **kwargs)
 
 get_specifiers_from_processors (cls, "BaseSpecification" spec)
 Get the specifiers that have been set from processors.
 
 reset_specifiers_from_processors (cls, Optional[Type] processor=None)
 Reset the specifiers that have been set from processors.
 
 declare_attrs (cls, *args, **kwargs)
 Initialize the attributes of this node.
 
 reset_processor_elems (cls, Optional[Type] processor=None)
 
 recognize_all (cls, bool recognize_all=True)
 Set whether all attributes under this node should be recognized.
 
str get_tag (self)
 Get the tag of this node.
 
Iterable[Tuple[Union[str, int], Any]] items (self)
 Get iterable of (key, value) or (index, value) pairs.
 
T combine_index (self, Union[str, int] key, T value)
 Combine the value at the given key with the given value.
 
str get_name (self, Union[Set, None] seen=None)
 Get the name of this node.
 
 check_unrecognized (self, bool ignore_empty=False, ignore_should_have_been_removed_by=False)
 Check for unrecognized keys in this node and all subnodes.
 
Any recursive_apply (self, callable func, bool self_first=False, set applied_to=None)
 Apply a function to this node and all subnodes.
 
 clean_empties (self)
 Remove empty nodes from this node and all subnodes.
 
bool isempty (self)
 Return True if this node is empty.
 
bool isempty_recursive (self)
 Return True if this node or all subnodes are empty.
 
 add_attr (cls, str key_or_tag, Optional[Union[type, Tuple[type,...], Tuple[None,...], Tuple[str,...], None]] required_type=None, Any default=default_unspecified_, Optional[Callable] callfunc=None, Optional[bool] part_name_match=None, Optional[bool] no_change_key=None, Any _processor_responsible_for_removing=None, Optional[Dict[str, TypeSpecifier]] _add_checker_to=None)
 Initialize a type specifier for this class.
 
List[Tget_nodes_of_type (self, Type[T] node_type)
 Return a list of all subnodes of a given type.
 
Callable get_setter_lambda (self, Union[str, int] keytag)
 Get a function that can be used to set a value in this node.
 
Callable get_combiner_lambda (self, Union[str, int] keytag)
 Get a function that can be used to combine a value to this node.
 
List[Tuple[Any, Callable]] get_setters_for_keytag (self, str keytag, bool recursive=True)
 Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag.
 
List[Tuple[Any, Callable]] get_combiners_for_keytag (self, str keytag, bool recursive=True)
 Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag.
 
List[Tuple[Any, Callable]] get_setters_for_type (self, Type t, bool recursive=True)
 Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type.
 
List[Tuple[Any, Callable]] get_combiners_for_type (self, Type t, bool recursive=True)
 Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type.
 
 __str__ (self)
 Return the name of this node.
 
 __format__ (self, format_spec)
 Formats the name of this node.
 
bool is_defined_non_default_non_empty (self, str key)
 Returns True if the given key is defined in this node and is not the default value and is not empty.
 
Any __getitem__ (self, Union[str, int] key)
 Get the value at the given key or index.
 
 __setitem__ (self, Union[str, int] key, Any value)
 Set the value at the given key or index.
 
 parse_expressions (self, Optional[Dict[str, Any]] symbol_table=None, Optional[set] parsed_ids=None, Optional[Callable] callfunc=None)
 Parse expressions in this node and all subnodes.
 
 unique_class_name (cls)
 Return a unique name for this class.
 
+ + + + + + + + + + +

+Static Public Member Functions

"BaseSpecification" get_global_spec ()
 Get the global specification object.
 
 set_global_spec ("BaseSpecification" spec)
 Set the global specification object.
 
Any try_combine (Any a, Any b, Union["Node", None] innonde=None, Union[int, str, None] index=None)
 Try to combine two values.
 
+ + + + + + + +

+Public Attributes

 logger
 
 parent_node
 
 spec
 
+ + + + + + + + + + + + + + + + + + +

+Protected Member Functions

Dict[str, TypeSpecifier_get_type_specifiers (cls, "BaseSpecification" spec)
 Get the type specifiers for this node.
 
 _get_all_recognized (self)
 
Dict[Union[str, int], TypeSpecifier_get_index2checker (self, Optional[List[Tuple[str, Any]]] key2elem=None)
 
 _parse_elem (self, Union[str, int] key, TypeSpecifier check, Any value_override=None)
 
 _parse_elems (self)
 
 _parse_extra_elems (self, List[Tuple[str, Any]] key2elem)
 
 _check_unrecognized (self, ignore_empty=False, ignore_should_have_been_removed_by=False)
 
 _parse_expression (self, Union[str, int] index, Dict[str, Any] symbol_table, Optional[TypeSpecifier] checker=None)
 
+ + + +

+Static Protected Member Functions

str _get_tag (x)
 
+ + + +

+Protected Attributes

 _default_parse
 
+ + + +

+Private Attributes

 __currently_parsing_index
 
+

Detailed Description

+

Base class for all nodes in the hierarchy.

+

Attributes: parent_node (Node): The parent node of the current node. spec (Specification): The global specification object. _init_args (Tuple): The arguments and keyword arguments used to initialize the node. __currently_parsing_index (Union[int, str]): The index or key currently being parsed. logger (Logger): The logger object for the node's class. _default_parse (bool): Flag indicating whether the node should be parsed using default rules.

+

Methods: get_specifiers_from_processors(cls, spec): Get the specifiers from processors. reset_specifiers_from_processors(cls, processor): Reset the specifiers from processors. declare_attrs(cls, *args, **kwargs): Initialize the attributes of this node. reset_processor_elems(cls, processor): Reset the processor elements. recognize_all(cls, recognize_all): Set whether all attributes under this node should be recognized. _get_type_specifiers(cls, spec): Get the type specifiers for this node. _get_all_recognized(self): Check if all attributes under this node are recognized. _get_tag(x): Get the tag of a node. get_global_spec(): Get the global specification object. set_global_spec(spec): Set the global specification object. get_tag(self): Get the tag of this node. _get_index2checker(self, key2elem): Get the index-to-checker mapping. items(self): Get an iterable of (key, value) or (index, value) pairs. combine_index(self, key, value): Combine the value at the given key with the given value. _parse_elem(self, key, check, value_override): Parse an element of the node.

+

Constructor & Destructor Documentation

+ +

◆ __init__()

+ +
+
+ + + + + + + + + + + + + + + + +
timeloopfe.common.nodes copy.Node.__init__ ( self,
* args,
** kwargs )
+
+
+

Member Function Documentation

+ +

◆ __format__()

+ +
+
+ + + + + + + + + + + +
timeloopfe.common.nodes copy.Node.__format__ ( self,
format_spec )
+
+ +

Formats the name of this node.

+ +
+
+ +

◆ __getitem__()

+ +
+
+ + + + + + + + + + + +
Any timeloopfe.common.nodes copy.Node.__getitem__ ( self,
Union[str, int] key )
+
+ +

Get the value at the given key or index.

+ +

Reimplemented in timeloopfe.common.nodes copy.DictNode.

+ +
+
+ +

◆ __setitem__()

+ +
+
+ + + + + + + + + + + + + + + + +
timeloopfe.common.nodes copy.Node.__setitem__ ( self,
Union[str, int] key,
Any value )
+
+ +

Set the value at the given key or index.

+ +

Reimplemented in timeloopfe.common.nodes copy.DictNode.

+ +
+
+ +

◆ __str__()

+ +
+
+ + + + + + + +
timeloopfe.common.nodes copy.Node.__str__ ( self)
+
+ +

Return the name of this node.

+ +
+
+ +

◆ _check_unrecognized()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + +
timeloopfe.common.nodes copy.Node._check_unrecognized ( self,
ignore_empty = False,
ignore_should_have_been_removed_by = False )
+
+protected
+
+ +
+
+ +

◆ _get_all_recognized()

+ +
+
+ + + + + +
+ + + + + + + +
timeloopfe.common.nodes copy.Node._get_all_recognized ( self)
+
+protected
+
+ +
+
+ +

◆ _get_index2checker()

+ +
+
+ + + + + +
+ + + + + + + + + + + +
Dict[Union[str, int], TypeSpecifier] timeloopfe.common.nodes copy.Node._get_index2checker ( self,
Optional[List[Tuple[str, Any]]] key2elem = None )
+
+protected
+
+ +
+
+ +

◆ _get_tag()

+ +
+
+ + + + + +
+ + + + + + + +
str timeloopfe.common.nodes copy.Node._get_tag ( x)
+
+staticprotected
+
+ +
+
+ +

◆ _get_type_specifiers()

+ +
+
+ + + + + +
+ + + + + + + + + + + +
Dict[str, TypeSpecifier] timeloopfe.common.nodes copy.Node._get_type_specifiers ( cls,
"BaseSpecification" + spec )
+
+protected
+
+ +

Get the type specifiers for this node.

+

Attributes: spec (Specification): The global specification object.

+

Returns: Dict[str, TypeSpecifier]: The type specifiers for this node.

+ +
+
+ +

◆ _parse_elem()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + +
timeloopfe.common.nodes copy.Node._parse_elem ( self,
Union[str, int] key,
TypeSpecifier check,
Any value_override = None )
+
+protected
+
+ +
+
+ +

◆ _parse_elems()

+ +
+
+ + + + + +
+ + + + + + + +
timeloopfe.common.nodes copy.Node._parse_elems ( self)
+
+protected
+
+ +
+
+ +

◆ _parse_expression()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + +
timeloopfe.common.nodes copy.Node._parse_expression ( self,
Union[str, int] index,
Dict[str, Any] symbol_table,
Optional[TypeSpecifier] checker = None )
+
+protected
+
+ +
+
+ +

◆ _parse_extra_elems()

+ +
+
+ + + + + +
+ + + + + + + + + + + +
timeloopfe.common.nodes copy.Node._parse_extra_elems ( self,
List[Tuple[str, Any]] key2elem )
+
+protected
+
+ +
+
+ +

◆ add_attr()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
timeloopfe.common.nodes copy.Node.add_attr ( cls,
str key_or_tag,
Optional[ + Union[type, Tuple[type, ...], Tuple[None, ...], Tuple[str, ...], None] + ] required_type = None,
Any default = default_unspecified_,
Optional[Callable] callfunc = None,
Optional[bool] part_name_match = None,
Optional[bool] no_change_key = None,
Any _processor_responsible_for_removing = None,
Optional[Dict[str, TypeSpecifier]] _add_checker_to = None )
+
+ +

Initialize a type specifier for this class.

+

Args: key_or_tag: The key/tag or tag to use for this type specifier. required_type: The type of value that this type specifier will be default: The default value to use if the key/tag is not found. callfunc: A function to call on the value before returning it. part_name_match: If True, the key/tag will match if it is a substring of the actual key/tag. no_change_key: If True, a parsed key will not be changed when a partial name match is found. Otherwise, the parsed key will be changed to the actual key. _processor_responsible_for_removing: The processor that will be responsible for removing this key from the containing node, if any. _add_checker_to: The dictionary to add the checker to. If None, add the checker to the class's type specifiers.

+

Raises: AttributeError: If the class does not have a _param_type_specifiers attribute.

+ +
+
+ +

◆ check_unrecognized()

+ +
+
+ + + + + + + + + + + + + + + + +
timeloopfe.common.nodes copy.Node.check_unrecognized ( self,
bool ignore_empty = False,
ignore_should_have_been_removed_by = False )
+
+ +

Check for unrecognized keys in this node and all subnodes.

+

Also checks for correct types.

+

Args: ignore_empty (bool): Flag indicating whether to ignore empty nodes. ignore_should_have_been_removed_by (bool): Flag indicating whether to ignore nodes that should have been removed by a processor.

+

Raises: ParseError: If an unrecognized key is found.

+ +

Reimplemented in timeloopfe.common.nodes copy.DictNode.

+ +
+
+ +

◆ clean_empties()

+ +
+
+ + + + + + + +
timeloopfe.common.nodes copy.Node.clean_empties ( self)
+
+ +

Remove empty nodes from this node and all subnodes.

+ +
+
+ +

◆ combine_index()

+ +
+
+ + + + + + + + + + + + + + + + +
T timeloopfe.common.nodes copy.Node.combine_index ( self,
Union[str, int] key,
T value )
+
+ +

Combine the value at the given key with the given value.

+

If there is no value at the given key, sets the value at the given key. If there is, attempts to combine the two values.

+

Args: key: The key to combine. value: The value to combine.

+

Returns: The combined value.

+ +
+
+ +

◆ declare_attrs()

+ +
+
+ + + + + + + + + + + + + + + + +
timeloopfe.common.nodes copy.Node.declare_attrs ( cls,
* args,
** kwargs )
+
+ +

Initialize the attributes of this node.

+ +
+
+ +

◆ get_combiner_lambda()

+ +
+
+ + + + + + + + + + + +
Callable timeloopfe.common.nodes copy.Node.get_combiner_lambda ( self,
Union[str, int] keytag )
+
+ +

Get a function that can be used to combine a value to this node.

+

The combiner takes one argument, the value to combine.

+

Args: keytag: The key or tag to combine.

+

Returns: A function that can be used to combine a value to this node.

+ +
+
+ +

◆ get_combiners_for_keytag()

+ +
+
+ + + + + + + + + + + + + + + + +
List[Tuple[Any, Callable]] timeloopfe.common.nodes copy.Node.get_combiners_for_keytag ( self,
str keytag,
bool recursive = True )
+
+ +

Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given key/tag.

+

A combiner is a function that can be used to combine a value to this node.

+

Args: keytag: The key or tag to search for. recursive: If True, search recursively.

+ +
+
+ +

◆ get_combiners_for_type()

+ +
+
+ + + + + + + + + + + + + + + + +
List[Tuple[Any, Callable]] timeloopfe.common.nodes copy.Node.get_combiners_for_type ( self,
Type t,
bool recursive = True )
+
+ +

Get a list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type.

+

A combiner is a function that can be used to combine a value in this node.

+

Args: t: The type to search for. recursive: If True, search recursively.

+

Returns: A list of tuples of the form (value, combiner) for all keys/tags in this node that match the given type.

+ +
+
+ +

◆ get_global_spec()

+ +
+
+ + + + + +
+ + + + + + + +
"BaseSpecification" timeloopfe.common.nodes copy.Node.get_global_spec ()
+
+static
+
+ +

Get the global specification object.

+ +
+
+ +

◆ get_name()

+ +
+
+ + + + + + + + + + + +
str timeloopfe.common.nodes copy.Node.get_name ( self,
Union[Set, None] seen = None )
+
+ +

Get the name of this node.

+ +
+
+ +

◆ get_nodes_of_type()

+ +
+
+ + + + + + + + + + + +
List[T] timeloopfe.common.nodes copy.Node.get_nodes_of_type ( self,
Type[T] node_type )
+
+ +

Return a list of all subnodes of a given type.

+

Args: node_type: The type of node to search for.

+

Returns: A list of all subnodes of the given type.

+ +
+
+ +

◆ get_setter_lambda()

+ +
+
+ + + + + + + + + + + +
Callable timeloopfe.common.nodes copy.Node.get_setter_lambda ( self,
Union[str, int] keytag )
+
+ +

Get a function that can be used to set a value in this node.

+

The setter takes one argument, the value to set.

+

Args: keytag: The key or tag to set.

+

Returns: A function that can be used to set a value in this node.

+ +
+
+ +

◆ get_setters_for_keytag()

+ +
+
+ + + + + + + + + + + + + + + + +
List[Tuple[Any, Callable]] timeloopfe.common.nodes copy.Node.get_setters_for_keytag ( self,
str keytag,
bool recursive = True )
+
+ +

Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given key/tag.

+

A setter is a function that can be used to set a value in this node.

+

Args: keytag: The key or tag to search for. recursive: If True, search recursively.

+ +
+
+ +

◆ get_setters_for_type()

+ +
+
+ + + + + + + + + + + + + + + + +
List[Tuple[Any, Callable]] timeloopfe.common.nodes copy.Node.get_setters_for_type ( self,
Type t,
bool recursive = True )
+
+ +

Get a list of tuples of the form (value, setter) for all keys/tags in this node that match the given type.

+

A setter is a function that can be used to set a value in this node.

+

Args: t: The type to search for. recursive: If True, search recursively.

+

Returns: A list of tuples of the form (value, setter) for all keys/tags in this node that match the given type.

+ +
+
+ +

◆ get_specifiers_from_processors()

+ +
+
+ + + + + + + + + + + +
timeloopfe.common.nodes copy.Node.get_specifiers_from_processors ( cls,
"BaseSpecification" spec )
+
+ +

Get the specifiers that have been set from processors.

+ +
+
+ +

◆ get_tag()

+ +
+
+ + + + + + + +
str timeloopfe.common.nodes copy.Node.get_tag ( self)
+
+ +

Get the tag of this node.

+ +
+
+ +

◆ is_defined_non_default_non_empty()

+ +
+
+ + + + + + + + + + + +
bool timeloopfe.common.nodes copy.Node.is_defined_non_default_non_empty ( self,
str key )
+
+ +

Returns True if the given key is defined in this node and is not the default value and is not empty.

+ +
+
+ +

◆ isempty()

+ +
+
+ + + + + + + +
bool timeloopfe.common.nodes copy.Node.isempty ( self)
+
+ +

Return True if this node is empty.

+

Good to override.

+ +
+
+ +

◆ isempty_recursive()

+ +
+
+ + + + + + + +
bool timeloopfe.common.nodes copy.Node.isempty_recursive ( self)
+
+ +

Return True if this node or all subnodes are empty.

+ +
+
+ +

◆ items()

+ +
+
+ + + + + + + +
Iterable[Tuple[Union[str, int], Any]] timeloopfe.common.nodes copy.Node.items ( self)
+
+ +

Get iterable of (key, value) or (index, value) pairs.

+ +
+
+ +

◆ parse_expressions()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + +
timeloopfe.common.nodes copy.Node.parse_expressions ( self,
Optional[Dict[str, Any]] symbol_table = None,
Optional[set] parsed_ids = None,
Optional[Callable] callfunc = None )
+
+ +

Parse expressions in this node and all subnodes.

+

Args: symbol_table: A dictionary mapping variable names to values. parsed_ids: A set of IDs of nodes that have already been parsed. callfunc: A function to call on each node after parsing.

+ +
+
+ +

◆ recognize_all()

+ +
+
+ + + + + + + + + + + +
timeloopfe.common.nodes copy.Node.recognize_all ( cls,
bool recognize_all = True )
+
+ +

Set whether all attributes under this node should be recognized.

+

Attributes: recognize_all (bool): Flag indicating whether all attributes under this node should be recognized.

+ +
+
+ +

◆ recursive_apply()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + +
Any timeloopfe.common.nodes copy.Node.recursive_apply ( self,
callable func,
bool self_first = False,
set applied_to = None )
+
+ +

Apply a function to this node and all subnodes.

+

Args: func (callable): The function to apply. self_first (bool): Flag indicating whether to apply the function to this node before applying it to subnodes. applied_to (set): A set of ids of nodes that have already been visited. Prevents infinite recursion.

+

Returns: The return value of the function applied to this node.

+ +
+
+ +

◆ reset_processor_elems()

+ +
+
+ + + + + + + + + + + +
timeloopfe.common.nodes copy.Node.reset_processor_elems ( cls,
Optional[Type] processor = None )
+
+ +
+
+ +

◆ reset_specifiers_from_processors()

+ +
+
+ + + + + + + + + + + +
timeloopfe.common.nodes copy.Node.reset_specifiers_from_processors ( cls,
Optional[Type] processor = None )
+
+ +

Reset the specifiers that have been set from processors.

+ +
+
+ +

◆ set_global_spec()

+ +
+
+ + + + + +
+ + + + + + + +
timeloopfe.common.nodes copy.Node.set_global_spec ("BaseSpecification" spec)
+
+static
+
+ +

Set the global specification object.

+ +
+
+ +

◆ try_combine()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + +
Any timeloopfe.common.nodes copy.Node.try_combine (Any a,
Any b,
Union["Node", None] innonde = None,
Union[int, str, None] index = None )
+
+static
+
+ +

Try to combine two values.

+

Args: a: The first value. b: The second value. innonde: The node that contains the values. For error messages. index: The index of the values in the node. For error messages.

+

Returns: The combined value.

+ +
+
+ +

◆ unique_class_name()

+ +
+
+ + + + + + + +
timeloopfe.common.nodes copy.Node.unique_class_name ( cls)
+
+ +

Return a unique name for this class.

+ +
+
+

Member Data Documentation

+ +

◆ __currently_parsing_index

+ +
+
+ + + + + +
+ + + + +
timeloopfe.common.nodes copy.Node.__currently_parsing_index
+
+private
+
+ +
+
+ +

◆ _default_parse

+ +
+
+ + + + + +
+ + + + +
timeloopfe.common.nodes copy.Node._default_parse
+
+protected
+
+ +
+
+ +

◆ logger

+ +
+
+ + + + +
timeloopfe.common.nodes copy.Node.logger
+
+ +
+
+ +

◆ parent_node

+ +
+
+ + + + +
timeloopfe.common.nodes copy.Node.parent_node
+
+ +
+
+ +

◆ spec

+ +
+
+ + + + +
timeloopfe.common.nodes copy.Node.spec
+
+ +
+
+
The documentation for this class was generated from the following file: +
+ + + + diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1Node__coll__graph.map b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1Node__coll__graph.map new file mode 100644 index 0000000..52385aa --- /dev/null +++ b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1Node__coll__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1Node__coll__graph.md5 b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1Node__coll__graph.md5 new file mode 100644 index 0000000..4246ae1 --- /dev/null +++ b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1Node__coll__graph.md5 @@ -0,0 +1 @@ +570e1d411d5d4b8e7c5621278cb404bf \ No newline at end of file diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1Node__coll__graph.png b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1Node__coll__graph.png new file mode 100644 index 0000000..71db9f8 Binary files /dev/null and b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1Node__coll__graph.png differ diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1Node__inherit__graph.map b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1Node__inherit__graph.map new file mode 100644 index 0000000..faf8364 --- /dev/null +++ b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1Node__inherit__graph.map @@ -0,0 +1,13 @@ + + + + + + + + + + + + + diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1Node__inherit__graph.md5 b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1Node__inherit__graph.md5 new file mode 100644 index 0000000..fe2e097 --- /dev/null +++ b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1Node__inherit__graph.md5 @@ -0,0 +1 @@ +9978aa1ecfd008c0787c442592a2e133 \ No newline at end of file diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1Node__inherit__graph.png b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1Node__inherit__graph.png new file mode 100644 index 0000000..87a4272 Binary files /dev/null and b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1Node__inherit__graph.png differ diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1ParseError.html b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1ParseError.html new file mode 100644 index 0000000..9d7bbf1 --- /dev/null +++ b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1ParseError.html @@ -0,0 +1,115 @@ + + + + + + + +TimeloopFE: timeloopfe.common.nodes copy.ParseError Class Reference + + + + + + + + + + + +
+
+ + + + + + +
+
TimeloopFE +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
timeloopfe.common.nodes copy.ParseError Class Reference
+
+
+ +

Exception for nodes. + More...

+
+Inheritance diagram for timeloopfe.common.nodes copy.ParseError:
+
+
Inheritance graph
+ + + + + +
[legend]
+
+Collaboration diagram for timeloopfe.common.nodes copy.ParseError:
+
+
Collaboration graph
+ + + + + +
[legend]
+

Detailed Description

+

Exception for nodes.

+

The documentation for this class was generated from the following file: +
+ + + + diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1ParseError__coll__graph.map b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1ParseError__coll__graph.map new file mode 100644 index 0000000..a1c3bfb --- /dev/null +++ b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1ParseError__coll__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1ParseError__coll__graph.md5 b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1ParseError__coll__graph.md5 new file mode 100644 index 0000000..111ce1e --- /dev/null +++ b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1ParseError__coll__graph.md5 @@ -0,0 +1 @@ +e507845acf2d955631eebe74d240dbed \ No newline at end of file diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1ParseError__coll__graph.png b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1ParseError__coll__graph.png new file mode 100644 index 0000000..766b2db Binary files /dev/null and b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1ParseError__coll__graph.png differ diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1ParseError__inherit__graph.map b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1ParseError__inherit__graph.map new file mode 100644 index 0000000..a1c3bfb --- /dev/null +++ b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1ParseError__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1ParseError__inherit__graph.md5 b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1ParseError__inherit__graph.md5 new file mode 100644 index 0000000..111ce1e --- /dev/null +++ b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1ParseError__inherit__graph.md5 @@ -0,0 +1 @@ +e507845acf2d955631eebe74d240dbed \ No newline at end of file diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1ParseError__inherit__graph.png b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1ParseError__inherit__graph.png new file mode 100644 index 0000000..766b2db Binary files /dev/null and b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1ParseError__inherit__graph.png differ diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1TypeSpecifier-members.html b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1TypeSpecifier-members.html new file mode 100644 index 0000000..d2c66e5 --- /dev/null +++ b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1TypeSpecifier-members.html @@ -0,0 +1,100 @@ + + + + + + + +TimeloopFE: Member List + + + + + + + + + + + +
+
+ + + + + + +
+
TimeloopFE +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
timeloopfe.common.nodes copy.TypeSpecifier Member List
+
+
+ +

This is the complete list of members for timeloopfe.common.nodes copy.TypeSpecifier, including all inherited members.

+ + + + + + + + + + + +
__init__(self, str name, Type required_type, Any default=default_unspecified_, Union[Callable, None] callfunc=None, Type should_have_been_removed_by=None, bool part_name_match=False, bool no_change_key=False)timeloopfe.common.nodes copy.TypeSpecifier
callfunctimeloopfe.common.nodes copy.TypeSpecifier
cast(self, Any value, bool __node_skip_parse=False)timeloopfe.common.nodes copy.TypeSpecifier
cast_check_type(self, Any value, "Node" node, str key)timeloopfe.common.nodes copy.TypeSpecifier
check_type(self, Any value, "Node" node, str key)timeloopfe.common.nodes copy.TypeSpecifier
get_id2casted(cls)timeloopfe.common.nodes copy.TypeSpecifier
removed_by_str(self)timeloopfe.common.nodes copy.TypeSpecifier
required_typetimeloopfe.common.nodes copy.TypeSpecifier
reset_id2casted(cls)timeloopfe.common.nodes copy.TypeSpecifier
should_have_been_removed_bytimeloopfe.common.nodes copy.TypeSpecifier
+ + + + diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1TypeSpecifier.html b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1TypeSpecifier.html new file mode 100644 index 0000000..f1e7d8e --- /dev/null +++ b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1TypeSpecifier.html @@ -0,0 +1,363 @@ + + + + + + + +TimeloopFE: timeloopfe.common.nodes copy.TypeSpecifier Class Reference + + + + + + + + + + + +
+
+ + + + + + +
+
TimeloopFE +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Member Functions | +Public Attributes | +List of all members
+
timeloopfe.common.nodes copy.TypeSpecifier Class Reference
+
+
+ +

Represents a type specifier for a node in the TimeloopFE library. + More...

+ + + + + + + + + + + + + + + + +

+Public Member Functions

 get_id2casted (cls)
 
 reset_id2casted (cls)
 
 __init__ (self, str name, Type required_type, Any default=default_unspecified_, Union[Callable, None] callfunc=None, Type should_have_been_removed_by=None, bool part_name_match=False, bool no_change_key=False)
 
 removed_by_str (self)
 
Any cast_check_type (self, Any value, "Node" node, str key)
 
Any cast (self, Any value, bool __node_skip_parse=False)
 
 check_type (self, Any value, "Node" node, str key)
 
+ + + + + + + +

+Public Attributes

 callfunc
 
 should_have_been_removed_by
 
 required_type
 
+

Detailed Description

+

Represents a type specifier for a node in the TimeloopFE library.

+

Attributes: name (str): The name of the type specifier. required_type (Type): The required type for the node. default (Any): The default value for the type specifier. callfunc (Union[Callable, None]): The function to call for casting the value. should_have_been_removed_by (Type): The type that should have removed or transformed the node. part_name_match (bool): Flag indicating if the name should be partially matched. no_change_key (bool): Flag indicating if the key should not be changed.

+

Methods: get_id2casted(cls): Get the dictionary of casted values. reset_id2casted(cls): Reset the dictionary of casted values. removed_by_str(self): Get the string representation of the type that should have removed or transformed the node. cast_check_type(self, value: Any, node: "Node", key: str) -> Any: Check and cast the value to the required type. cast(self, value: Any, __node_skip_parse: bool = False) -> Any: Cast the value to the required type. check_type(self, value: Any, node: "Node", key: str): Check if the value matches the required type.

+

Constructor & Destructor Documentation

+ +

◆ __init__()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
timeloopfe.common.nodes copy.TypeSpecifier.__init__ ( self,
str name,
Type required_type,
Any default = default_unspecified_,
Union[Callable, None] callfunc = None,
Type should_have_been_removed_by = None,
bool part_name_match = False,
bool no_change_key = False )
+
+ +
+
+

Member Function Documentation

+ +

◆ cast()

+ +
+
+ + + + + + + + + + + + + + + + +
Any timeloopfe.common.nodes copy.TypeSpecifier.cast ( self,
Any value,
bool __node_skip_parse = False )
+
+ +
+
+ +

◆ cast_check_type()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + +
Any timeloopfe.common.nodes copy.TypeSpecifier.cast_check_type ( self,
Any value,
"Node" node,
str key )
+
+ +
+
+ +

◆ check_type()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + +
timeloopfe.common.nodes copy.TypeSpecifier.check_type ( self,
Any value,
"Node" node,
str key )
+
+ +
+
+ +

◆ get_id2casted()

+ +
+
+ + + + + + + +
timeloopfe.common.nodes copy.TypeSpecifier.get_id2casted ( cls)
+
+ +
+
+ +

◆ removed_by_str()

+ +
+
+ + + + + + + +
timeloopfe.common.nodes copy.TypeSpecifier.removed_by_str ( self)
+
+ +
+
+ +

◆ reset_id2casted()

+ +
+
+ + + + + + + +
timeloopfe.common.nodes copy.TypeSpecifier.reset_id2casted ( cls)
+
+ +
+
+

Member Data Documentation

+ +

◆ callfunc

+ +
+
+ + + + +
timeloopfe.common.nodes copy.TypeSpecifier.callfunc
+
+ +
+
+ +

◆ required_type

+ +
+
+ + + + +
timeloopfe.common.nodes copy.TypeSpecifier.required_type
+
+ +
+
+ +

◆ should_have_been_removed_by

+ +
+
+ + + + +
timeloopfe.common.nodes copy.TypeSpecifier.should_have_been_removed_by
+
+ +
+
+
The documentation for this class was generated from the following file: +
+ + + + diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1Unspecified-members.html b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1Unspecified-members.html new file mode 100644 index 0000000..c45c426 --- /dev/null +++ b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1Unspecified-members.html @@ -0,0 +1,92 @@ + + + + + + + +TimeloopFE: Member List + + + + + + + + + + + +
+
+ + + + + + +
+
TimeloopFE +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
timeloopfe.common.nodes copy.Unspecified Member List
+
+
+ +

This is the complete list of members for timeloopfe.common.nodes copy.Unspecified, including all inherited members.

+ + + +
__repr__(self)timeloopfe.common.nodes copy.Unspecified
__str__(self)timeloopfe.common.nodes copy.Unspecified
+ + + + diff --git a/classtimeloopfe_1_1common_1_1nodes_01copy_1_1Unspecified.html b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1Unspecified.html new file mode 100644 index 0000000..1af8ebc --- /dev/null +++ b/classtimeloopfe_1_1common_1_1nodes_01copy_1_1Unspecified.html @@ -0,0 +1,141 @@ + + + + + + + +TimeloopFE: timeloopfe.common.nodes copy.Unspecified Class Reference + + + + + + + + + + + +
+
+ + + + + + +
+
TimeloopFE +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Member Functions | +List of all members
+
timeloopfe.common.nodes copy.Unspecified Class Reference
+
+
+ +

Class to represent an unspecified value. + More...

+ + + + + + +

+Public Member Functions

 __str__ (self)
 
 __repr__ (self)
 
+

Detailed Description

+

Class to represent an unspecified value.

+

Member Function Documentation

+ +

◆ __repr__()

+ +
+
+ + + + + + + +
timeloopfe.common.nodes copy.Unspecified.__repr__ ( self)
+
+ +
+
+ +

◆ __str__()

+ +
+
+ + + + + + + +
timeloopfe.common.nodes copy.Unspecified.__str__ ( self)
+
+ +
+
+
The documentation for this class was generated from the following file: +
+ + + + diff --git a/classtimeloopfe_1_1common_1_1nodes_1_1CombineableListNode-members.html b/classtimeloopfe_1_1common_1_1nodes_1_1CombinableListNode-members.html similarity index 79% rename from classtimeloopfe_1_1common_1_1nodes_1_1CombineableListNode-members.html rename to classtimeloopfe_1_1common_1_1nodes_1_1CombinableListNode-members.html index f107c8d..7b825e0 100644 --- a/classtimeloopfe_1_1common_1_1nodes_1_1CombineableListNode-members.html +++ b/classtimeloopfe_1_1common_1_1nodes_1_1CombinableListNode-members.html @@ -71,18 +71,18 @@
-
timeloopfe.common.nodes.CombineableListNode Member List
+
timeloopfe.common.nodes.CombinableListNode Member List
-

This is the complete list of members for timeloopfe.common.nodes.CombineableListNode, including all inherited members.

+

This is the complete list of members for timeloopfe.common.nodes.CombinableListNode, including all inherited members.

- - + +
__class__timeloopfe.common.nodes.CombineableListNodeprivate
combine(self, "CombineableListNode" other)timeloopfe.common.nodes.CombineableListNode
__class__timeloopfe.common.nodes.CombinableListNodeprivate
combine(self, "CombinableListNode" other)timeloopfe.common.nodes.CombinableListNode