|
2 | 2 | % ICapControls: DSS MATLAB interface class to DSS C-API
|
3 | 3 | %
|
4 | 4 | % Properties:
|
5 |
| - % AllNames - (read-only) Array of strings with all CapControl names. |
| 5 | + % AllNames - Array of strings with all CapControl names |
| 6 | + % Count - Number of CapControl objects |
| 7 | + % First - Set first object of CapControl; returns 0 if none. |
| 8 | + % Name - Get/sets the name of the current active CapControl |
| 9 | + % Next - Sets next CapControl active; returns 0 if no more. |
| 10 | + % idx - Sets next CapControl active; returns 0 if no more. |
6 | 11 | % CTratio - Transducer ratio from pirmary current to control current.
|
7 | 12 | % Capacitor - Name of the Capacitor that is controlled.
|
8 |
| - % Count - (read-only) Number of CapControls in Active Circuit |
9 | 13 | % DeadTime -
|
10 | 14 | % Delay - Time delay [s] to switch on after arming. Control may reset before actually switching.
|
11 | 15 | % DelayOff - Time delay [s] before swithcing off a step. Control may reset before actually switching.
|
12 |
| - % First - (read-only) Sets the first CapControl as active. Return 0 if none. |
13 | 16 | % Mode - Type of automatic controller.
|
14 | 17 | % MonitoredObj - Full name of the element that PT and CT are connected to.
|
15 | 18 | % MonitoredTerm - Terminal number on the element that PT and CT are connected to.
|
16 |
| - % Name - Sets a CapControl active by name. |
17 |
| - % Next - (read-only) Gets the next CapControl in the circut. Returns 0 if none. |
18 | 19 | % OFFSetting - Threshold to switch off a step. See Mode for units.
|
19 | 20 | % ONSetting - Threshold to arm or switch on a step. See Mode for units.
|
20 | 21 | % PTratio - Transducer ratio from primary feeder to control voltage.
|
|
27 | 28 |
|
28 | 29 | properties
|
29 | 30 | AllNames
|
| 31 | + Count |
| 32 | + First |
| 33 | + Name |
| 34 | + Next |
| 35 | + idx |
30 | 36 | CTratio
|
31 | 37 | Capacitor
|
32 |
| - Count |
33 | 38 | DeadTime
|
34 | 39 | Delay
|
35 | 40 | DelayOff
|
36 |
| - First |
37 | 41 | Mode
|
38 | 42 | MonitoredObj
|
39 | 43 | MonitoredTerm
|
40 |
| - Name |
41 |
| - Next |
42 | 44 | OFFSetting
|
43 | 45 | ONSetting
|
44 | 46 | PTratio
|
|
47 | 49 | Vmin
|
48 | 50 | end
|
49 | 51 |
|
50 |
| - methods |
| 52 | + methods (Access = public) |
51 | 53 |
|
52 | 54 | function obj = Reset(obj)
|
53 | 55 | calllib('dss_capi_v7', 'CapControls_Reset');
|
54 | 56 | end
|
55 | 57 |
|
| 58 | + end |
| 59 | + methods |
| 60 | + |
56 | 61 | function result = get.AllNames(obj)
|
57 |
| - % (read-only) Array of strings with all CapControl names. |
| 62 | + % Array of strings with all CapControl names |
58 | 63 | result = DSS_MATLAB.get_string_array('CapControls_Get_AllNames');
|
59 | 64 | end
|
60 | 65 |
|
| 66 | + function result = get.Count(obj) |
| 67 | + % Number of CapControl objects |
| 68 | + result = calllib('dss_capi_v7', 'CapControls_Get_Count'); |
| 69 | + end |
| 70 | + |
| 71 | + function result = get.First(obj) |
| 72 | + % Set first object of CapControl; returns 0 if none. |
| 73 | + result = calllib('dss_capi_v7', 'CapControls_Get_First'); |
| 74 | + end |
| 75 | + |
| 76 | + function result = get.Name(obj) |
| 77 | + % Get/sets the name of the current active CapControl |
| 78 | + result = calllib('dss_capi_v7', 'CapControls_Get_Name'); |
| 79 | + end |
| 80 | + function obj = set.Name(obj, Value) |
| 81 | + calllib('dss_capi_v7', 'CapControls_Set_Name', Value); |
| 82 | + obj.CheckForError(); |
| 83 | + end |
| 84 | + |
| 85 | + function result = get.Next(obj) |
| 86 | + % Sets next CapControl active; returns 0 if no more. |
| 87 | + result = calllib('dss_capi_v7', 'CapControls_Get_Next'); |
| 88 | + end |
| 89 | + |
| 90 | + function result = get.idx(obj) |
| 91 | + % Get/set active CapControl by index; 1..Count |
| 92 | + result = calllib('dss_capi_v7', 'CapControls_Get_idx'); |
| 93 | + end |
| 94 | + function obj = set.idx(obj, Value) |
| 95 | + calllib('dss_capi_v7', 'CapControls_Set_idx', Value); |
| 96 | + obj.CheckForError(); |
| 97 | + end |
| 98 | + |
| 99 | + |
61 | 100 | function result = get.CTratio(obj)
|
62 | 101 | % Transducer ratio from pirmary current to control current.
|
63 | 102 | result = calllib('dss_capi_v7', 'CapControls_Get_CTratio');
|
|
76 | 115 | obj.CheckForError();
|
77 | 116 | end
|
78 | 117 |
|
79 |
| - function result = get.Count(obj) |
80 |
| - % (read-only) Number of CapControls in Active Circuit |
81 |
| - result = calllib('dss_capi_v7', 'CapControls_Get_Count'); |
82 |
| - end |
83 |
| - |
84 | 118 | function result = get.DeadTime(obj)
|
85 | 119 | result = calllib('dss_capi_v7', 'CapControls_Get_DeadTime');
|
86 | 120 | end
|
|
107 | 141 | obj.CheckForError();
|
108 | 142 | end
|
109 | 143 |
|
110 |
| - function result = get.First(obj) |
111 |
| - % (read-only) Sets the first CapControl as active. Return 0 if none. |
112 |
| - result = calllib('dss_capi_v7', 'CapControls_Get_First'); |
113 |
| - end |
114 |
| - |
115 | 144 | function result = get.Mode(obj)
|
116 | 145 | % Type of automatic controller.
|
117 | 146 | result = calllib('dss_capi_v7', 'CapControls_Get_Mode');
|
|
139 | 168 | obj.CheckForError();
|
140 | 169 | end
|
141 | 170 |
|
142 |
| - function result = get.Name(obj) |
143 |
| - % Sets a CapControl active by name. |
144 |
| - result = calllib('dss_capi_v7', 'CapControls_Get_Name'); |
145 |
| - end |
146 |
| - function obj = set.Name(obj, Value) |
147 |
| - calllib('dss_capi_v7', 'CapControls_Set_Name', Value); |
148 |
| - obj.CheckForError(); |
149 |
| - end |
150 |
| - |
151 |
| - function result = get.Next(obj) |
152 |
| - % (read-only) Gets the next CapControl in the circut. Returns 0 if none. |
153 |
| - result = calllib('dss_capi_v7', 'CapControls_Get_Next'); |
154 |
| - end |
155 |
| - |
156 | 171 | function result = get.OFFSetting(obj)
|
157 | 172 | % Threshold to switch off a step. See Mode for units.
|
158 | 173 | result = calllib('dss_capi_v7', 'CapControls_Get_OFFSetting');
|
|
0 commit comments