com.zepben.protobuf.cim.iec61970.base.wires.RegulatingControlOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of evolve-grpc Show documentation
Show all versions of evolve-grpc Show documentation
Protobuf and gRPC definitions for the evolve platform
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: zepben/protobuf/cim/iec61970/base/wires/RegulatingControl.proto
package com.zepben.protobuf.cim.iec61970.base.wires;
public interface RegulatingControlOrBuilder extends
// @@protoc_insertion_point(interface_extends:zepben.protobuf.cim.iec61970.base.wires.RegulatingControl)
com.google.protobuf.MessageOrBuilder {
/**
*
**
* The PowerSystemResource fields for this RegulatingControl.
*
*
* .zepben.protobuf.cim.iec61970.base.core.PowerSystemResource psr = 1;
* @return Whether the psr field is set.
*/
boolean hasPsr();
/**
*
**
* The PowerSystemResource fields for this RegulatingControl.
*
*
* .zepben.protobuf.cim.iec61970.base.core.PowerSystemResource psr = 1;
* @return The psr.
*/
com.zepben.protobuf.cim.iec61970.base.core.PowerSystemResource getPsr();
/**
*
**
* The PowerSystemResource fields for this RegulatingControl.
*
*
* .zepben.protobuf.cim.iec61970.base.core.PowerSystemResource psr = 1;
*/
com.zepben.protobuf.cim.iec61970.base.core.PowerSystemResourceOrBuilder getPsrOrBuilder();
/**
* .google.protobuf.NullValue discreteNull = 2;
* @return Whether the discreteNull field is set.
*/
boolean hasDiscreteNull();
/**
* .google.protobuf.NullValue discreteNull = 2;
* @return The enum numeric value on the wire for discreteNull.
*/
int getDiscreteNullValue();
/**
* .google.protobuf.NullValue discreteNull = 2;
* @return The discreteNull.
*/
com.google.protobuf.NullValue getDiscreteNull();
/**
* bool discreteSet = 3;
* @return Whether the discreteSet field is set.
*/
boolean hasDiscreteSet();
/**
* bool discreteSet = 3;
* @return The discreteSet.
*/
boolean getDiscreteSet();
/**
*
**
* The regulating control mode presently available. This specification allows for determining the kind of regulation without need for obtaining the units from a schedule.
*
*
* .zepben.protobuf.cim.iec61970.base.wires.RegulatingControlModeKind mode = 4;
* @return The enum numeric value on the wire for mode.
*/
int getModeValue();
/**
*
**
* The regulating control mode presently available. This specification allows for determining the kind of regulation without need for obtaining the units from a schedule.
*
*
* .zepben.protobuf.cim.iec61970.base.wires.RegulatingControlModeKind mode = 4;
* @return The mode.
*/
com.zepben.protobuf.cim.iec61970.base.wires.RegulatingControlModeKind getMode();
/**
*
**
* Phase voltage controlling this regulator, measured at regulator location.
*
*
* .zepben.protobuf.cim.iec61970.base.core.PhaseCode monitoredPhase = 5;
* @return The enum numeric value on the wire for monitoredPhase.
*/
int getMonitoredPhaseValue();
/**
*
**
* Phase voltage controlling this regulator, measured at regulator location.
*
*
* .zepben.protobuf.cim.iec61970.base.core.PhaseCode monitoredPhase = 5;
* @return The monitoredPhase.
*/
com.zepben.protobuf.cim.iec61970.base.core.PhaseCode getMonitoredPhase();
/**
*
**
* This is a deadband used with discrete control to avoid excessive update of controls like tap changers and shunt compensator banks while regulating.
* The units are the base units appropriate for the mode.
* The attribute shall be a positive value or zero. If RegulatingControl.discrete is set to "false", the RegulatingControl.targetDeadband is to be ignored.
* Note that for instance, if the targetValue is 100 kV and the targetDeadband is 2 kV the range is from 99 to 101 kV.
*
*
* float targetDeadband = 6;
* @return The targetDeadband.
*/
float getTargetDeadband();
/**
*
**
* The target value specified for case input. This value can be used for the target value without the use of schedules.
* The value has the units appropriate to the mode attribute.
*
*
* double targetValue = 7;
* @return The targetValue.
*/
double getTargetValue();
/**
* .google.protobuf.NullValue enabledNull = 8;
* @return Whether the enabledNull field is set.
*/
boolean hasEnabledNull();
/**
* .google.protobuf.NullValue enabledNull = 8;
* @return The enum numeric value on the wire for enabledNull.
*/
int getEnabledNullValue();
/**
* .google.protobuf.NullValue enabledNull = 8;
* @return The enabledNull.
*/
com.google.protobuf.NullValue getEnabledNull();
/**
* bool enabledSet = 9;
* @return Whether the enabledSet field is set.
*/
boolean hasEnabledSet();
/**
* bool enabledSet = 9;
* @return The enabledSet.
*/
boolean getEnabledSet();
/**
*
**
* Maximum allowed target value (RegulatingControl.targetValue).
*
*
* double maxAllowedTargetValue = 10;
* @return The maxAllowedTargetValue.
*/
double getMaxAllowedTargetValue();
/**
*
**
* Minimum allowed target value (RegulatingControl.targetValue).
*
*
* double minAllowedTargetValue = 11;
* @return The minAllowedTargetValue.
*/
double getMinAllowedTargetValue();
/**
*
**
* The terminal associated with this regulating control. The terminal is associated instead of a node, since the terminal could connect into either a
* topological node or a connectivity node. Sometimes it is useful to model regulation at a terminal of a bus bar object.
*
*
* string terminalMRID = 12;
* @return The terminalMRID.
*/
java.lang.String getTerminalMRID();
/**
*
**
* The terminal associated with this regulating control. The terminal is associated instead of a node, since the terminal could connect into either a
* topological node or a connectivity node. Sometimes it is useful to model regulation at a terminal of a bus bar object.
*
*
* string terminalMRID = 12;
* @return The bytes for terminalMRID.
*/
com.google.protobuf.ByteString
getTerminalMRIDBytes();
/**
*
**
* The equipment that participates in this regulating control scheme.
*
*
* repeated string regulatingCondEqMRIDs = 13;
* @return A list containing the regulatingCondEqMRIDs.
*/
java.util.List
getRegulatingCondEqMRIDsList();
/**
*
**
* The equipment that participates in this regulating control scheme.
*
*
* repeated string regulatingCondEqMRIDs = 13;
* @return The count of regulatingCondEqMRIDs.
*/
int getRegulatingCondEqMRIDsCount();
/**
*
**
* The equipment that participates in this regulating control scheme.
*
*
* repeated string regulatingCondEqMRIDs = 13;
* @param index The index of the element to return.
* @return The regulatingCondEqMRIDs at the given index.
*/
java.lang.String getRegulatingCondEqMRIDs(int index);
/**
*
**
* The equipment that participates in this regulating control scheme.
*
*
* repeated string regulatingCondEqMRIDs = 13;
* @param index The index of the value to return.
* @return The bytes of the regulatingCondEqMRIDs at the given index.
*/
com.google.protobuf.ByteString
getRegulatingCondEqMRIDsBytes(int index);
/**
*
**
* The rated current of associated CT in amps for this RegulatingControl. Forms the base used to convert Line Drop
* Compensation settings from ohms to voltage.
*
*
* double ratedCurrent = 14;
* @return The ratedCurrent.
*/
double getRatedCurrent();
com.zepben.protobuf.cim.iec61970.base.wires.RegulatingControl.DiscreteCase getDiscreteCase();
com.zepben.protobuf.cim.iec61970.base.wires.RegulatingControl.EnabledCase getEnabledCase();
}