DSSProgress Page 1 of 3
DSSProgress
DSSProgress
This interface allows to control the progress visualization form. DSSProgress is exposed directly by the DSS
object (OpenDSSEngine).
Example
% Create DSS object
DSSObject = actxserver('[Link]')
if ~[Link](0),
disp("Unable to start openDSS");
return
end;
DSSProgress = [Link];
Copyright © (2021) Electric Power Research Institute, Inc. All rights reserved.
Caption
DSSProgress ››
Caption
(write only)
This property sets the caption to appear on the bottom of the DSS Progress form.
Example
% Create DSS object
DSSObject = actxserver('[Link]')
if ~[Link](0),
disp('Unable to start openDSS');
return
end;
% Getting the DSSProgress interface
DSSProgress = [Link];
% Sets the caption of the progress form
[Link] = 'My caption';
Copyright © (2021) Electric Power Research Institute, Inc. All rights reserved.
Close
DSSProgress ››
Close
(method)
[Link] 7/18/2023
DSSProgress Page 2 of 3
This method closes (hides) DSS Progress form.
Example
% Create DSS object
DSSObject = actxserver('[Link]')
if ~[Link](0),
disp('Unable to start openDSS');
return
end;
% Getting the DSSProgress interface
DSSProgress = [Link];
% Shows the progress form
[Link]();
% Sets the caption of the progress form
[Link] = 'My caption';
% Sets the progress pct
[Link] = 50;
% Closes the progress form
[Link]();
Copyright © (2021) Electric Power Research Institute, Inc. All rights reserved.
PctProgress
DSSProgress ››
PctProgress
(write only)
This property sets the percent progress to indicate [0..100].
Example
% Create DSS object
DSSObject = actxserver('[Link]')
if ~[Link](0),
disp('Unable to start openDSS');
return
end;
% Getting the DSSProgress interface
DSSProgress = [Link];
% Shows the progress form
[Link]();
% Sets the caption of the progress form
[Link] = 'My caption';
% Sets the progress pct
[Link] = 50;
% Closes the progress form
[Link]();
[Link] 7/18/2023
DSSProgress Page 3 of 3
Copyright © (2021) Electric Power Research Institute, Inc. All rights reserved.
Show
DSSProgress ››
Show
(method)
This method shows progress form with null caption and progress set to zero.
Example
% Create DSS object
DSSObject = actxserver('[Link]')
if ~[Link](0),
disp('Unable to start openDSS');
return
end;
% Getting the DSSProgress interface
DSSProgress = [Link];
% Shows the progress form
[Link]();
% Sets the caption of the progress form
[Link] = 'My caption';
% Sets the progress pct
[Link] = 50;
% Closes the progress form
[Link]();
Copyright © (2021) Electric Power Research Institute, Inc. All rights reserved.
[Link] 7/18/2023