com.powerdata.openpa/PhaseShifterList.java at master · powerdata/com.powerdata.openpa · GitHub

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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
package com.powerdata.openpa;
/*
 * Copyright (c) 2016, PowerData Corporation, Incremental Systems Corporation
 * All rights reserved.
 * Licensed under the BSD-3 Clause License.
 * See full license at https://powerdata.github.io/openpa/LICENSE.md
 */


import java.util.Arrays;
import java.util.EnumSet;
import java.util.Set;
import com.powerdata.openpa.PhaseShifter.ControlMode;
import com.powerdata.openpa.impl.EmptyLists;

public interface PhaseShifterList extends ACBranchListIfc<PhaseShifter>
{
	static PhaseShifterList emptyList() {return EmptyLists.EMPTY_PHASESHIFTERS;}

	/**
	 * return the phase shifter control mode
	 * @param ndx offset within the list
	 * @return current ControlMode
	 * @throws PAModelException
	 */
	ControlMode getControlMode(int ndx) throws PAModelException;
	/**
	 * return the control mode for all phase shifters
	 * @return current ControlMode for the entire list
	 * @throws PAModelException
	 */
	ControlMode[] getControlMode() throws PAModelException;
	/**
	 * set the phase shifter control mode
	 * @param ndx offset within the list
	 * @param m Desired control mode
	 * @throws PAModelException
	 */
	void setControlMode(int ndx, ControlMode m) throws PAModelException;
	/**
	 * set the phase shifter control modes
	 * @param m array of Desired control modes
	 * @throws PAModelException
	 */
	void setControlMode(ControlMode[] m) throws PAModelException;
	/**
	 * query the presence of active power regulation
	 * @param ndx offset within the list
	 * @return true if the device is capable of regulating MW, false otherwise
	 * @throws PAModelException
	 */
	boolean hasReg(int ndx) throws PAModelException;
	/**
	 * query the presence of active power regulation
	 * @return true if the device is capable of regulating MW, false otherwise
	 * @throws PAModelException
	 */
	boolean[] hasReg() throws PAModelException;
	/**
	 * set the presence of active power regulation
	 * @param ndx offset within the list
	 * @param v true if the device is capable of regulating MW, false otherwise
	 * @throws PAModelException
	 */
	void setReg(int ndx, boolean v) throws PAModelException;
	/**
	 * set the presence of active power regulation
	 *
	 * @param v
	 *            array of booleans true if the device is capable of regulating
	 *            MW, false otherwise
	 * @throws PAModelException
	 */
	void setReg(boolean[] v) throws PAModelException;
	/**
	 * Get the maximum phase shift angle
	 * @param ndx offset within the list
	 * @return maximum phase shift angle (DEG)
	 * @throws PAModelException
	 */
	float getMaxAng(int ndx) throws PAModelException;
	float[] getMaxAng() throws PAModelException;
	void setMaxAng(int ndx, float v) throws PAModelException;
	void setMaxAng(float[] v) throws PAModelException;
	float getMinAng(int ndx) throws PAModelException;
	float[] getMinAng() throws PAModelException;
	void setMinAng(int ndx, float v) throws PAModelException;
	void setMinAng(float[] v) throws PAModelException;
	float getRegMaxMW(int ndx) throws PAModelException;
	float[] getRegMaxMW() throws PAModelException;
	void setRegMaxMW(int ndx, float mw) throws PAModelException;
	void setRegMaxMW(float[] mw) throws PAModelException;
	float getRegMinMW(int ndx) throws PAModelException;
	void setRegMinMW(int ndx, float mw) throws PAModelException;
	float[] getRegMinMW() throws PAModelException;
	void setRegMinMW(float[] mw) throws PAModelException;


	static Set<ColumnMeta> Cols = EnumSet.copyOf(Arrays
			.asList(new ColumnMeta[] {
					ColumnMeta.PhashID,
					ColumnMeta.PhashNAME,
					ColumnMeta.PhashBUSFROM,
					ColumnMeta.PhashBUSTO,
					ColumnMeta.PhashINSVC,
					ColumnMeta.PhashPFROM,
					ColumnMeta.PhashQFROM,
					ColumnMeta.PhashPTO,
					ColumnMeta.PhashQTO,
					ColumnMeta.PhashR,
					ColumnMeta.PhashX,
					ColumnMeta.PhashGMAG,
					ColumnMeta.PhashBMAG,
					ColumnMeta.PhashANG,
					ColumnMeta.PhashTAPFROM,
					ColumnMeta.PhashTAPTO,
					ColumnMeta.PhashCTRLMODE,
					ColumnMeta.PhashRATLT,
					ColumnMeta.PhashHASREG,
					ColumnMeta.PhashMXANG,
					ColumnMeta.PhashMNANG,
					ColumnMeta.PhashMXMW,
					ColumnMeta.PhashMNMW
					}));
	@Override
	default Set<ColumnMeta> getColTypes()
	{
		return Cols;
	}
	@Override
	default ListMetaType getListMeta()
	{
		return ListMetaType.PhaseShifter;
	}

}