aboutsummaryrefslogtreecommitdiffstats
path: root/models/src/main/java/org/onap/policy/clamp/controlloop/models/controlloop/concepts/ControlLoop.java
blob: d0d79274c3171109c2eac5fa7846dc0f2d3fb131 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
/*-
 * ============LICENSE_START=======================================================
 * Copyright (C) 2021 Nordix Foundation.
 * ================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 * ============LICENSE_END=========================================================
 */

package org.onap.policy.clamp.controlloop.models.controlloop.concepts;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.UUID;
import java.util.stream.Collectors;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor;
import lombok.NonNull;
import org.apache.commons.collections4.MapUtils;
import org.onap.policy.models.base.PfConceptKey;
import org.onap.policy.models.base.PfUtils;
import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
import org.onap.policy.models.tosca.authorative.concepts.ToscaEntity;

/**
 * Class to represent a control loop instance.
 */
@NoArgsConstructor
@Data
@EqualsAndHashCode(callSuper = true)
public class ControlLoop extends ToscaEntity implements Comparable<ControlLoop> {
    @NonNull
    private ToscaConceptIdentifier definition = new ToscaConceptIdentifier(PfConceptKey.getNullKey());

    @NonNull
    private ControlLoopState state = ControlLoopState.UNINITIALISED;

    @NonNull
    private ControlLoopOrderedState orderedState = ControlLoopOrderedState.UNINITIALISED;

    private Map<UUID, ControlLoopElement> elements;

    @Override
    public String getType() {
        return definition.getName();
    }

    @Override
    public String getTypeVersion() {
        return definition.getVersion();
    }

    /**
     * Copy contructor, does a deep copy.
     *
     * @param otherControlLoop the other element to copy from
     */
    public ControlLoop(final ControlLoop otherControlLoop) {
        super(otherControlLoop);
        this.definition = new ToscaConceptIdentifier(otherControlLoop.definition);
        this.state = otherControlLoop.state;
        this.orderedState = otherControlLoop.orderedState;
        this.elements = PfUtils.mapMap(otherControlLoop.elements, ControlLoopElement::new);
    }

    @Override
    public int compareTo(final ControlLoop other) {
        return compareNameVersion(this, other);
    }

    /**
     * Set the ordered state on the control loop and on all its control loop elements.
     *
     * @param orderedState the state we want the control loop to transition to
     */
    public void setCascadedOrderedState(final ControlLoopOrderedState orderedState) {
        this.orderedState = orderedState;

        if (MapUtils.isEmpty(elements)) {
            return;
        }

        elements.values().forEach(element -> element.setOrderedState(orderedState));
    }

    /**
     * Get a list of control loop element statistics.
     *
     * @param controlLoop the control loop
     * @return List of ClElementStatistics
     */
    public List<ClElementStatistics> getControlLoopElementStatisticsList(final ControlLoop controlLoop) {
        if (MapUtils.isEmpty(controlLoop.elements)) {
            return null;
        }

        return controlLoop.elements.values().stream().map(ControlLoopElement::getClElementStatistics)
                .collect(Collectors.toList());
    }
}