open dss com doc

Upload: mariam-mughees

Post on 09-Jan-2016

127 views

Category:

Documents


8 download

DESCRIPTION

opendss info

TRANSCRIPT

  • OpenDSSTypeLibraryDocumentationAugust18,2015Version7.6.4.65

    Enumerations

    enumMonitorModesdssVI=0,MonitorrecordsVoltageandCurrentattheterminal(DefaultdssPower=1,MonitorrecordskW,kvarorkVA,anglevalues,etc.attheterminaltowhichitisconnected.dssSequence=16,ReportsthemonitoredquantitiesassequencequantitiesdssMagnitude=32,ReportsthemonitoredquantitiesinMagnitudeOnlydssPosOnly=64,ReportsthePositiveSeqonlyoravgofallphasesdssTaps=2,FormonitoringRegulatorandTransformertapsdssStates=3FormonitoringStateVariables(forPCElementsonly

    enumSolveModesdssSnapShot=0,SolveasinglesnapshotpowerflowdssDutyCycle=6,SolvefollowingDutyCycleloadshapesdssDirect=7,Solvedirect(forcedadmittancemodeldssDaily=1,SolvefollowingDailyloadshapesdssMonte1=3,MonteCarloMode1dssMonte2=10,MonteCarloMode2dssMonte3=11,MonteCarloMode3dssFaultStudy=9,FaultstudyatallbusesdssYearly=2,SolvefollowingYearlyloadshapesdssMonteFault=8,MontecarloFaultStudydssPeakDay=5,SolvesforPeakDayusingDailyloadcurvedssLD1=4,LoaddurationMode1dssLD2=12,LoadDurationMode2dssAutoAdd=13,AutoaddgeneratorsorcapacitorsdssHarmonic=15,(noHelpstringavailable)dssDynamic=14(noHelpstringavailable)

    1

  • enumOptionsdssPowerFlow=1,PowerFlowloadmodeloptiondssAdmittance=2,AdmittanceloadmodeloptiondssNormalSolve=0,SolutionalgorithmoptionNormalsolutionmodedssNewtonSolve=1,SolutionalgorithmoptionNewtonsolutiondssStatic=0,ControlModeoptionStaticdssEvent=1,ControlModeOptionEventdrivensolutionmodedssTime=2,ControlmodeoptionTimedrivenmodedssMultiphase=0,Circuitmodelismultiphase(defaultdssPositiveSeq=1,CircuitmodelispositivesequencemodelonlydssGaussian=1,Randommode=GaussiandssUniform=2,Randommode=UniformdssLogNormal=3,RandomMode=LognormaldssAddGen=1,AddgeneratorsinAutoAddmode(AddTypedssAddCap=2,AddcapacitorsinAutoAddmode(AddtypedssControlOFF=1ControlModeOFF=1

    enumCapControlModesdssCapControlVoltage=1,voltagecontrol,ONandOFFsettingsonthePTsecondarybasedssCapControlKVAR=2,kVARcontrol,ONandOFFsettingsonPT/CTbasedssCapControlCurrent=0,Currentcontrol,ONandOFFsettingsonCTsecondarydssCapControlPF=4,ONandOFFsettingsarepowerfactor,negativeforleadingdssCapControlTime=3Timecontrol,ONandOFFsettingsaresecondsfrommidnight

    enumActionCodesdssActionNone=0,NoactiondssActionOpen=1,OpenaswitchdssActionClose=2,CloseaswitchdssActionReset=3,Resettotheshelfstate(unlocked,closedforaswitchdssActionLock=4,Lockaswitch,prventingbothmanualandautomaticoperationdssActionUnlock=5,Unlockaswitch,permittingbothmanualandautomaticoperationdssActionTapUp=6,MovearegulatortapupdssActionTapDown=7Movearegulatortapdown

    enumLoadStatusdssLoadVariable=0,(noHelpstringavailable)

    2

  • dssLoadFixed=1,(noHelpstringavailable)dssLoadExempt=2(noHelpstringavailable)

    enumLoadModelsdssLoadConstPQ=1,(noHelpstringavailable)dssLoadConstZ=2,(noHelpstringavailable)dssLoadMotor=3,(noHelpstringavailable)dssLoadCVR=4,(noHelpstringavailable)dssLoadConstI=5,(noHelpstringavailable)dssLoadConstPFixedQ=6,(noHelpstringavailable)dssLoadConstPFixedX=7,(noHelpstringavailable)dssLoadZIPV=8(noHelpstringavailable)

    enumLineUnitsdssLineUnitsNone=0,Nolinelengthunit.dssLineUnitsMiles=1,Linelengthunitsinmiles.dssLineUnitskFt=2,Linelengthunitsareinthousandfeet.dssLineUnitskm=3,Linelengthunitsarekm.dssLineUnitsmeter=4,Linelengthunitsaremeters.dssLineUnitsft=5,Lineunitsinfeet.dssLineUnitsinch=6,Linelengthunitsareinches.dssLineUnitscm=7,Lineunitsarecm.dssLineUnitsmm=8,Linelengthunitsaremm.dssLineUnitsMaxnum=9Maximumnumberoflineunitsconstants.

    3

  • Interfaces

    TextInterfaceCommand [out,retval]Type:BSTR*Command;[Property(get)];'value=Command' InputcommandstringfortheDSS.Command [in]Type:BSTRCommand;[Property(put)];'Command=value' InputcommandstringfortheDSS.Result [out,retval]Type:BSTR*Result;[Property(get)];'value=Result' Resultstringforthelastcommand.

    DSSPropertyInterfaceName [out,retval]Type:BSTR*Name;[Property(get)];'value=Name' NameofPropertyDescription [out,retval]Type:BSTR*Description;[Property(get)];'value=Description' Descriptionoftheproperty.Val [out,retval]Type:BSTR*Value;[Property(get)];'value=Val' (noHelpstringavailable)Val [in]Type:BSTRValue;[Property(put)];'Val=value' (noHelpstringavailable)

    CktElementInterfaceName [out,retval]Type:BSTR*Value;[Property(get)];'value=Name' FullNameofActiveCircuitElementNumTerminals [out,retval]Type:long*Value;[Property(get)];'value=NumTerminals' NumberofTerminalsthisCircuitElementNumConductors [out,retval]Type:long*Value;[Property(get)];'value=NumConductors' NumberofConductorsperTerminalNumPhases [out,retval]Type:long*Value;[Property(get)];'value=NumPhases' NumberofPhasesBusNames [out,retval]Type:VARIANT*Value;[Property(get)];'value=BusNames' Variantarrayofstrings.GetBusdefinitionstowhicheachterminalisconnected.0basedarray.BusNames [in]Type:VARIANTValue;[Property(put)];'BusNames=value' Variantarrayofstrings.SetBusdefinitionsforeachterminalisconnected.Properties [in]Type:VARIANTIndx,[out,retval]Type:IDSSProperty**Value;[Property

    4

  • (get)];'value=Properties' CollectionofPropertiesforthisCircuitElement(0basedindex,ifnumericVoltages [out,retval]Type:VARIANT*Value;[Property(get)];'value=Voltages' ComplexarrayofvoltagesatterminalsCurrents [out,retval]Type:VARIANT*Value;[Property(get)];'value=Currents' ComplexarrayofcurrentsintoeachconductorofeachterminalPowers [out,retval]Type:VARIANT*Value;[Property(get)];'value=Powers' ComplexarrayofpowersintoeachconductorofeachterminalLosses [out,retval]Type:VARIANT*Value;[Property(get)];'value=Losses' Totallossesintheelement:twoelementcomplexarrayPhaseLosses [out,retval]Type:VARIANT*Value;[Property(get)];'value=PhaseLosses' ComplexarrayoflossesbyphaseSeqVoltages [out,retval]Type:VARIANT*Value;[Property(get)];'value=SeqVoltages' Doublearrayofsymmetricalcomponentvoltagesateach3phaseterminalSeqCurrents [out,retval]Type:VARIANT*Value;[Property(get)];'value=SeqCurrents' Doublearrayofsymmetricalcomponentcurrentsintoeach3phaseterminalSeqPowers [out,retval]Type:VARIANT*Value;[Property(get)];'value=SeqPowers' Doublearrayofsequencepowersintoeach3phaseteminalEnabled [out,retval]Type:VARIANT_BOOL*Value;[Property(get)];'value=Enabled' Booleanindicatingthatelementiscurrentlyinthecircuit.Enabled [in]Type:VARIANT_BOOLValue;[Property(put)];'Enabled=value' Booleanindicatingthatelementiscurrentlyinthecircuit.NormalAmps [out,retval]Type:double*Value;[Property(get)];'value=NormalAmps' NormalampereratingforPDElementsNormalAmps [in]Type:doubleValue;[Property(put)];'NormalAmps=value' NormalampereratingEmergAmps [out,retval]Type:double*Value;[Property(get)];'value=EmergAmps' EmergencyAmpereRatingforPDelementsEmergAmps [in]Type:doubleValue;[Property(put)];'EmergAmps=value' EmergencyAmpereRatingOpen [in]Type:longTerm,[in]Type:longPhs;[Method];'Open(arglist)' Openthespecifiedterminalandphase,ifnonzero.Elseallconductorsatterminal.Close [in]Type:longTerm,[in]Type:longPhs;[Method];'Close(arglist)' Closethespecifiedterminalandphase,ifnonzero.Elseallconductorsatterminal.IsOpen [in]Type:longTerm,[in]Type:longPhs,[out,retval]Type:VARIANT_BOOL*Value;

    5

  • [Method];'IsOpen(arglist)' Booleanindicatingifthespecifiedterminaland,optionally,phaseisopen.NumProperties [out,retval]Type:long*Value;[Property(get)];'value=NumProperties' NumberofPropertiesthisCircuitElement.AllPropertyNames [out,retval]Type:VARIANT*Value;[Property(get)];'value=AllPropertyNames' Variantarraycontainingallpropertynamesoftheactivedevice.Residuals [out,retval]Type:VARIANT*Value;[Property(get)];'value=Residuals' Residualcurrentsforeachterminal:(mag,angleYprim [out,retval]Type:VARIANT*Value;[Property(get)];'value=Yprim' YPrimmatrix,columnorder,complexnumbers(pairedDisplayName [out,retval]Type:BSTR*Value;[Property(get)];'value=DisplayName' Displaynameoftheobject(notnecessarilyuniqueDisplayName [in]Type:BSTRValue;[Property(put)];'DisplayName=value' Displaynameoftheobject(notnecessarilyuniqueHandle [out,retval]Type:long*Value;[Property(get)];'value=Handle' PointertothisobjectGUID [out,retval]Type:BSTR*Value;[Property(get)];'value=GUID' globallyuniqueidentifierforthisobjectHasSwitchControl [out,retval]Type:VARIANT_BOOL*Value;[Property(get)];'value=HasSwitchControl' ThiselementhasaSwtControlattached.HasVoltControl [out,retval]Type:VARIANT_BOOL*Value;[Property(get)];'value=HasVoltControl' ThiselementhasaCapControlorRegControlattached.EnergyMeter [out,retval]Type:BSTR*Value;[Property(get)];'value=EnergyMeter' NameoftheEnergyMeterthiselementisassignedto.Controller [in]Type:longidx,[out,retval]Type:BSTR*Value;[Property(get)];'value=Controller' Fullnameoftheithcontrollerattachedtothiselement.Ex:str=Controller(2CplxSeqVoltages [out,retval]Type:VARIANT*Value;[Property(get)];'value=CplxSeqVoltages' ComplexdoublearrayofSequenceVoltageforallterminalsofactivecircuitelement.CplxSeqCurrents [out,retval]Type:VARIANT*Value;[Property(get)];'value=CplxSeqCurrents' ComplexdoublearrayofSequenceCurrentsforallconductorsofallterminalsofactivecircuitelement.AllVariableNames [out,retval]Type:VARIANT*Value;[Property(get)];'value=AllVariableNames' Variantarrayofstringslistingallthepublishedvariablenames,ifaPCElement.Otherwise,nullstring.AllVariableValues [out,retval]Type:VARIANT*Value;[Property(get)];'value=AllVariableValues' Variantarrayofdoubles.ValuesofstatevariablesofactiveelementifPCelement.

    6

  • Variable [in]Type:BSTRMyVarName,[out]Type:long*Code,[out,retval]Type:double*Value;[Property(get)];'value=Variable' ForPCElement,getthevalueofavariablebyname.IfCode>0ThennovariablebythisnameornotaPCelement.Variablei [in]Type:longIdx,[out]Type:long*Code,[out,retval]Type:double*Value;[Property(get)];'value=Variablei' ForPCElement,getthevalueofavariablebyintegerindex.NodeOrder [out,retval]Type:VARIANT*Value;[Property(get)];'value=NodeOrder' Variantarrayofintegercontainingthenodenumbers(representingphases,forexampleHasOCPDevice [out,retval]Type:VARIANT_BOOL*Value;[Property(get)];'value=HasOCPDevice' Trueifarecloser,relay,orfusecontrollingthiscktelement.OCP=OvercurrentProtectionNumControls [out,retval]Type:long*Value;[Property(get)];'value=NumControls' Numberofcontrolsconnectedtothisdevice.UsetodeterminevalidrangeforindexintoControllerarray.OCPDevIndex [out,retval]Type:long*Value;[Property(get)];'value=OCPDevIndex' IndexintoControllerlistofOCPDevicecontrollingthisCktElementOCPDevType [out,retval]Type:long*Value;[Property(get)];'value=OCPDevType' 0=None;1=Fuse;2=Recloser;3=Relay;TypeofOCPcontrollerdeviceCurrentsMagAng [out,retval]Type:VARIANT*Value;[Property(get)];'value=CurrentsMagAng' Currentsinmagnitude,angleformatasavariantarrayofdoubles.VoltagesMagAng [out,retval]Type:VARIANT*Value;[Property(get)];'value=VoltagesMagAng' Voltagesateachconductorinmagnitude,angleformasvariantarrayofdoubles.

    ErrorInterfaceNumber [out,retval]Type:long*Number;[Property(get)];'value=Number' ErrorNumberDescription [out,retval]Type:BSTR*Description;[Property(get)];'value=Description' Descriptionoferrorforlastoperation

    CircuitInterfaceName [out,retval]Type:BSTR*Value;[Property(get)];'value=Name' Nameoftheactivecircuit.NumCktElements [out,retval]Type:long*Value;[Property(get)];'value=NumCktElements' NumberofCktElementsinthecircuit.

    7

  • NumBuses [out,retval]Type:long*Value;[Property(get)];'value=NumBuses' TotalnumberofBusesinthecircuit.NumNodes [out,retval]Type:long*Value;[Property(get)];'value=NumNodes' Totalnumberofnodesinthecircuit.Buses [in]Type:VARIANTIndex,[out,retval]Type:IBus**Value;[Property(get)];'value=Buses' CollectionofBusesinthecircuit.Indexmaybestringorintegerindex(0basedCktElements [in]Type:VARIANTIdx,[out,retval]Type:ICktElement**Value;[Property(get)];'value=CktElements' CollectionofCktElementsinCircuitLosses [out,retval]Type:VARIANT*Value;[Property(get)];'value=Losses' Totallossesinactivecircuit,complexnumber(twoelementarrayofdoubleLineLosses [out,retval]Type:VARIANT*Value;[Property(get)];'value=LineLosses' ComplextotallinelossesinthecircuitSubstationLosses [out,retval]Type:VARIANT*Value;[Property(get)];'value=SubstationLosses' Complexlossesinalltransformersdesignatedtosubstations.TotalPower [out,retval]Type:VARIANT*Value;[Property(get)];'value=TotalPower' Totalpower,wattsdeliveredtothecircuitAllBusVolts [out,retval]Type:VARIANT*Value;[Property(get)];'value=AllBusVolts' Complexarrayofallbus,nodevoltagesfrommostrecentsolutionAllBusVmag [out,retval]Type:VARIANT*Value;[Property(get)];'value=AllBusVmag' Arrayofmagnitudes(doublesAllElementNames [out,retval]Type:VARIANT*Value;[Property(get)];'value=AllElementNames' VaiantarrayofstringscontainingFullNameofallelements.ActiveElement [out,retval]Type:ICktElement**Value;[Property(get)];'value=ActiveElement' ReturnaninterfacetotheactivecircuitelementDisable [in]Type:BSTRName;[Method];'Disable(arglist)' Disableacircuitelementbyname(removesfromcircuitbutleaveindatabaseEnable [in]Type:BSTRName;[Method];'Enable(arglist)' Activate(enableSolution [out,retval]Type:ISolution**Value;[Property(get)];'value=Solution' ReturnaninterfacetotheSolutionobject.ActiveBus [out,retval]Type:IBus**Value;[Property(get)];'value=ActiveBus' Returnaninterfacetotheactivebus.FirstPCElement [out,retval]Type:long*Value;[Method];'FirstPCElement(arglist)' SetsthefirstPowerConversion(PCNextPCElement [out,retval]Type:long*Value;[Method];'NextPCElement(arglist)' GetsnextPCElement.Returns0ifnomore.FirstPDElement [out,retval]Type:long*Value;[Method];

    8

  • 'FirstPDElement(arglist)' SetsthefirstPowerDelivery(PDNextPDElement [out,retval]Type:long*Value;[Method];'NextPDElement(arglist)' GetsnextPDElement.Returns0ifnomore.AllBusNames [out,retval]Type:VARIANT*Value;[Property(get)];'value=AllBusNames' Arrayofstringscontainingnamesofallbusesincircuit(seeAllNodeNamesAllElementLosses [out,retval]Type:VARIANT*Value;[Property(get)];'value=AllElementLosses' Arrayoftotallosses(complexSample [void;[Method];'Sample(arglist)' ForceallMetersandMonitorstotakeasample.SaveSample [void;[Method];'SaveSample(arglist)' Forceallmetersandmonitorstosavetheircurrentbuffers.Monitors [out,retval]Type:IMonitors**Value;[Property(get)];'value=Monitors' ReturnsinterfacetoMonitorscollection.Meters [out,retval]Type:IMeters**Value;[Property(get)];'value=Meters' ReturnsinterfacetoMeters(EnergyMeterGenerators [out,retval]Type:IGenerators**Value;[Property(get)];'value=Generators' ReturnsaGeneratorsObjectinterfaceSettings [out,retval]Type:ISettings**Value;[Property(get)];'value=Settings' ReturnsinterfacetoSettingsinterface.Lines [out,retval]Type:ILines**Value;[Property(get)];'value=Lines' ReturnsInterfacetoLinescollection.SetActiveElement [in]Type:BSTRFullName,[out,retval]Type:long*Value;[Method];'SetActiveElement(arglist)' SetstheActiveCircuitElementusingthefullobjectname(e.g.\i0Capacity [in]Type:doubleStart,[in]Type:doubleIncrement,[out,retval]Type:double*Value;[Method];'Capacity(arglist)' (noHelpstringavailable)SetActiveBus [in]Type:BSTRBusName,[out,retval]Type:long*Value;[Method];'SetActiveBus(arglist)' SetsActivebusbyname.Ignoresnodelist.Returnsbusindex(zerobasedSetActiveBusi [in]Type:longBusIndex,[out,retval]Type:long*Value;[Method];'SetActiveBusi(arglist)' SetsActiveBusbyIntegervalue.0basedindexcompatiblewithSetActiveBusreturnvalueandAllBusNamesindexing.Returns0ifOK.AllBusVmagPu [out,retval]Type:VARIANT*Value;[Property(get)];'value=AllBusVmagPu' DoubleArrayofallbusvoltages(eachnodeAllNodeNames [out,retval]Type:VARIANT*Value;[Property(get)];'value=AllNodeNames' VariantarrayofstringscontainingfullnameofeachnodeinsysteminsameorderasreturnedbyAllBusVolts,etc.SystemY [out,retval]Type:VARIANT*Value;[Property(get)];

    9

  • 'value=SystemY' SystemYmatrix(afterasolutionhasbeenperformedCtrlQueue [out,retval]Type:ICtrlQueue**Value;[Property(get)];'value=CtrlQueue' InterfacetothemainControlQueueAllBusDistances [out,retval]Type:VARIANT*Value;[Property(get)];'value=AllBusDistances' ReturnsdistancefromeachbustoparentEnergyMeter.CorrespondstosequenceinAllBusNames.AllNodeDistances [out,retval]Type:VARIANT*Value;[Property(get)];'value=AllNodeDistances' ReturnsanarrayofdistancesfromparentEnergyMeterforeachNode.CorrespondstoAllBusVMagsequence.AllNodeVmagByPhase [in]Type:longPhase,[out,retval]Type:VARIANT*Value;[Property(get)];'value=AllNodeVmagByPhase' ReturnsArrayofdoublesrepresentvoltagemagnitudesfornodesonthespecifiedphase.AllNodeVmagPUByPhase [in]Type:longPhase,[out,retval]Type:VARIANT*Value;[Property(get)];'value=AllNodeVmagPUByPhase' ReturnsarrayofperunitvoltagemagnitudesforeachnodebyphaseAllNodeDistancesByPhase [in]Type:longPhase,[out,retval]Type:VARIANT*Value;[Property(get)];'value=AllNodeDistancesByPhase' ReturnsanarrayofdoublesrepresentingthedistancestoparentEnergyMeter.SequenceofarraycorrespondstoothernodeByPhaseproperties.AllNodeNamesByPhase [in]Type:longPhase,[out,retval]Type:VARIANT*Value;[Property(get)];'value=AllNodeNamesByPhase' ReturnvariantarrayofstringsofthenodenamesfortheByPhasecriteria.SequencecorrespondstootherByPhaseproperties.Loads [out,retval]Type:ILoads**Value;[Property(get)];'value=Loads' ReturnsinterfacetoLoadelementinterfaceFirstElement [out,retval]Type:long*Value;[Method];'FirstElement(arglist)' SetsFirstelementofactiveclasstobetheActiveelementintheactivecircuit.Returns0ifnone.NextElement [out,retval]Type:long*Value;[Method];'NextElement(arglist)' Setsthenextelementoftheactiveclasstobetheactiveelementintheactivecircuit.Returns0ifnomoreelements.SetActiveClass [in]Type:BSTRClassName,[out,retval]Type:long*Value;[Method];'SetActiveClass(arglist)' Setstheactiveclassbyname.UseFirstElement,NextElementtoiteratethroughtheclass.Returns1iffails.ActiveDSSElement [out,retval]Type:IDSSElement**Value;[Property(get)];'value=ActiveDSSElement' ReturnsInterfacetotheActiveDSSobject,whichcouldbeeitheracircuitelementorageneralDSSelement.

    10

  • ActiveCktElement [out,retval]Type:ICktElement**Value;[Property(get)];'value=ActiveCktElement' ReturnsinterfacetotheActiveCircuitelement(sameasActiveElementActiveClass [out,retval]Type:IActiveClass**Value;[Property(get)];'value=ActiveClass' Returnsinterfacetoactiveclass.Transformers [out,retval]Type:ITransformers**Value;[Property(get)];'value=Transformers' ReturnsinterfacetoTransformerscollectionSwtControls [out,retval]Type:ISwtControls**Value;[Property(get)];'value=SwtControls' ReturnsinterfacetoSwtControlscollection.CapControls [out,retval]Type:ICapControls**Value;[Property(get)];'value=CapControls' ReturnsinterfacetoCapControlscollectionRegControls [out,retval]Type:IRegControls**Value;[Property(get)];'value=RegControls' ReturnsinterfacttoRegControlscollectionCapacitors [out,retval]Type:ICapacitors**Value;[Property(get)];'value=Capacitors' Interfacetotheactivecircuit'sCapacitorscollection.Topology [out,retval]Type:ITopology**Value;[Property(get)];'value=Topology' Interfacetotheactivecircuit'stopologyobject.Sensors [out,retval]Type:ISensors**Value;[Property(get)];'value=Sensors' InterfacetoSensorsintheActiveCircuit.UpdateStorage [void;[Method];'UpdateStorage(arglist)' Forcesupdatetoallstorageclasses.Typicallydoneafterasolution.Doneautomaticallyinintrinsicsolutionmodes.ParentPDElement [out,retval]Type:long*Value;[Property(get)];'value=ParentPDElement' SetsParentPDelement,ifany,tobetheactivecircuitelementandreturnsindex>0;Returns0ifitfailsornotapplicable.XYCurves [out,retval]Type:IXYCurves**Value;[Property(get)];'value=XYCurves' InterfacetoXYCurvesinactivecircuit.PDElements [out,retval]Type:IPDElements**Value;[Property(get)];'value=PDElements' InterfacetoPDElementscollectionReclosers [out,retval]Type:IReclosers**Value;[Property(get)];'value=Reclosers' (noHelpstringavailable)Relays [out,retval]Type:IRelays**Value;[Property(get)];'value=Relays' (noHelpstringavailable)LoadShapes [out,retval]Type:ILoadShapes**Value;[Property(get)];'value=LoadShapes' InterfacetoOpenDSSLoadshapescurrentlydefined.Fuses [out,retval]Type:Fuses**Value;[Property(get)];'value=Fuses' ReturninterfacetoFusesIsources [out,retval]Type:IISources**Value;[Property(get)];'value=Isources' InterfacetoISOURCEdevices

    11

  • YNodeVarray [out,retval]Type:VARIANT*Value;[Property(get)];'value=YNodeVarray' ComplexarrayofactualnodevoltagesinsameorderasSystemYmatrix.EndOfTimeStepUpdate [void;[Method];'EndOfTimeStepUpdate(arglist)' CallsEndOfTimeStepCleanupinSolutionAlgsDSSim_Coms [out,retval]Type:IDSSimComs**Value;[Property(get)];'value=DSSim_Coms' (noHelpstringavailable)YNodeOrder [out,retval]Type:VARIANT*Value;[Property(get)];'value=YNodeOrder' VariantarrayofstringscontainingthenamesofthenodesinthesameorderastheYmatrixYCurrents [out,retval]Type:VARIANT*Value;[Property(get)];'value=YCurrents' Variantarrayofdoublescontainingcomplexinjectioncurrentsforthepresentsolution.Isisthe\i0PVSystems [out,retval]Type:IPVSystems**Value;[Property(get)];'value=PVSystems' InterfacetoPVSystemscollection

    BusInterfaceName [out,retval]Type:BSTR*Name;[Property(get)];'value=Name' NameofBusNumNodes [out,retval]Type:long*NumNodes;[Property(get)];'value=NumNodes' NumberofNodesthisbus.Voltages [out,retval]Type:VARIANT*Voltages;[Property(get)];'value=Voltages' Complexarrayofvoltagesatthisbus.SeqVoltages [out,retval]Type:VARIANT*SeqVoltages;[Property(get)];'value=SeqVoltages' DoubleArrayofsequencevoltagesatthisbus.Nodes [out,retval]Type:VARIANT*Nodes;[Property(get)];'value=Nodes' IntegerArrayofNodeNumbersdefinedatthebusinsameorderasthevoltages.Voc [out,retval]Type:VARIANT*Voc;[Property(get)];'value=Voc' Opencircuitvoltage;Complexarray.Isc [out,retval]Type:VARIANT*Isc;[Property(get)];'value=Isc' Shortcircuitcurrentsatbus;ComplexArray.puVoltages [out,retval]Type:VARIANT*Value;[Property(get)];'value=puVoltages' ComplexArrayofpuvoltagesatthebus.kVBase [out,retval]Type:double*Value;[Property(get)];'value=kVBase' BasevoltageatbusinkVZscMatrix [out,retval]Type:VARIANT*Value;[Property(get)];'value=ZscMatrix' ComplexarrayofZscmatrixatbus.Columnbycolumn.

    12

  • Zsc1 [out,retval]Type:VARIANT*Value;[Property(get)];'value=Zsc1' ComplexPositiveSequenceshortcircuitimpedanceatbus..Zsc0 [out,retval]Type:VARIANT*Value;[Property(get)];'value=Zsc0' ComplexZeroSequenceshortcircuitimpedanceatbus.ZscRefresh [out,retval]Type:VARIANT_BOOL*Value;[Method];'ZscRefresh(arglist)' RecomputesZscforactivebusforpresentcircuitconfiguration.YscMatrix [out,retval]Type:VARIANT*Value;[Property(get)];'value=YscMatrix' ComplexarrayofYscmatrixatbus.Columnbycolumn.Coorddefined [out,retval]Type:VARIANT_BOOL*Value;[Property(get)];'value=Coorddefined' False=0elseTrue.Indicateswhetheracoordinatehasbeendefinedforthisbusx [out,retval]Type:double*Value;[Property(get)];'value=x' XCoordinateforbus(doublex [in]Type:doubleValue;[Property(put)];'x=value' XCoordinateforbus(doubley [out,retval]Type:double*Value;[Property(get)];'value=y' Ycoordinateforbus(doubley [in]Type:doubleValue;[Property(put)];'y=value' Ycoordinateforbus(doubleDistance [out,retval]Type:double*Value;[Property(get)];'value=Distance' Distancefromenergymeter(ifnonzeroGetUniqueNodeNumber [in]Type:longStartNumber,[out,retval]Type:long*Value;[Method];'GetUniqueNodeNumber(arglist)' Returnsauniquenodenumberattheactivebustoavoidnodecollisionsandaddsittothenodelistforthebus.CplxSeqVoltages [out,retval]Type:VARIANT*Value;[Property(get)];'value=CplxSeqVoltages' ComplexDoublearrayofSequenceVoltages(0,1,2Lambda [out,retval]Type:double*Value;[Property(get)];'value=Lambda' Accumulatedfailureratedownstreamfromthisbus;faultsperyearN_interrupts [out,retval]Type:double*Value;[Property(get)];'value=N_interrupts' NumberofinterruptionsthisbusperyearInt_Duration [out,retval]Type:double*Value;[Property(get)];'value=Int_Duration' Averageinterruptionduration,hr.Cust_Interrupts [out,retval]Type:double*Value;[Property(get)];'value=Cust_Interrupts' AnnualnumberofcustomerinterruptionsfromthisbusCust_Duration [out,retval]Type:double*Value;[Property(get)];'value=Cust_Duration' AccumulatedcustomeroutagedurationsN_Customers [out,retval]Type:long*Value;[Property(get)];'value=N_Customers' Totalnumbersofcustomersserveddownlinefromthisbus

    13

  • VLL [out,retval]Type:VARIANT*Value;[Property(get)];'value=VLL' For2and3phasebuses,returnsvariantarrayofcomplexnumbersrepresetinLLvoltagesinvolts.Returns1.0for1phasebus.Ifmorethan3phases,returnsonlyfirst3.puVLL [out,retval]Type:VARIANT*Value;[Property(get)];'value=puVLL' ReturnsComplexarrayofpuLLvoltagesfor2and3phasebuses.Returns1.0for1phasebus.Ifmorethan3phases,returnsonly3phases.VMagAngle [out,retval]Type:VARIANT*Value;[Property(get)];'value=VMagAngle' VariantArrayofdoublescontainingvoltagesinMagnitude(VLNpuVmagAngle [out,retval]Type:VARIANT*Value;[Property(get)];'value=puVmagAngle' Variantarrayofdoublescontainigvoltagemagnitude,anglepairsinperunitTotalMiles [out,retval]Type:double*Value;[Property(get)];'value=TotalMiles' Totallengthoflinedownlinefromthisbus,inmiles.Forreclosersitingalgorithm.SectionID [out,retval]Type:long*Value;[Property(get)];'value=SectionID' IntegerIDofthefeedersectioninwhichthisbusislocated.

    DSSInterfaceNumCircuits [out,retval]Type:long*Value;[Property(get)];'value=NumCircuits' NumberofCircuitscurrentlydefinedCircuits [in]Type:VARIANTIdx,[out,retval]Type:ICircuit**Value;[Property(get)];'value=Circuits' CollectionofCircuitobjectsActiveCircuit [out,retval]Type:ICircuit**Value;[Property(get)];'value=ActiveCircuit' Returnsinterfacetotheactivecircuit.Text [out,retval]Type:IText**Value;[Property(get)];'value=Text' ReturnstheDSSText(commandresultError [out,retval]Type:IError**Value;[Property(get)];'value=Error' ReturnsErrorinterface.NewCircuit [in]Type:BSTRName,[out,retval]Type:ICircuit**Value;[Method];'NewCircuit(arglist)' Makeanewcircuitandreturninterfacetoactivecircuit.ClearAll [void;[Method];'ClearAll(arglist)' Clearsallcircuitdefinitions.ShowPanel [void;[Method];'ShowPanel(arglist)' ShowsnonMDIchildformoftheMainDSSEditFormStart [in]Type:longcode,[out,retval]Type:VARIANT_BOOL*Value;[Method];'Start(arglist)' ValidatetheuserandstarttheDSS.ReturnsTRUEifsuccessful.Version [out,retval]Type:BSTR*Value;[Property(get)];'value=Version' GetversionstringfortheDSS.

    14

  • DSSProgress [out,retval]Type:IDSSProgress**Value;[Property(get)];'value=DSSProgress' GetsinterfacetotheDSSProgressMeterClasses [out,retval]Type:VARIANT*Value;[Property(get)];'value=Classes' ListofDSSintrinsicclasses(namesoftheclassesUserClasses [out,retval]Type:VARIANT*Value;[Property(get)];'value=UserClasses' ListofuserdefinedclassesNumClasses [out,retval]Type:long*Value;[Property(get)];'value=NumClasses' NumberofDSSintrinsicclassesNumUserClasses [out,retval]Type:long*Value;[Property(get)];'value=NumUserClasses' NumberofuserdefinedclassesDataPath [out,retval]Type:BSTR*Value;[Property(get)];'value=DataPath' DSSDataFilePath.Defaultpathforreports,etc.fromDSSDataPath [in]Type:BSTRValue;[Property(put)];'DataPath=value' DSSDataFilePath.Defaultpathforreports,etc.fromDSSReset [void;[Method];'Reset(arglist)' ResetsDSSInitializationforrestarts,etcfromappletsAllowForms [out,retval]Type:VARIANT_BOOL*Value;[Property(get)];'value=AllowForms' DefaultisTRUE.UsethistosettoFALSE;CannotresettoTRUE;AllowForms [in]Type:VARIANT_BOOLValue;[Property(put)];'AllowForms=value' DefaultisTRUE.UsethistosettoFALSE;CannotresettoTRUE;DefaultEditor [out,retval]Type:BSTR*Value;[Property(get)];'value=DefaultEditor' Returnsthepathnameforthedefaulttexteditor.ActiveClass [out,retval]Type:IActiveClass**Value;[Property(get)];'value=ActiveClass' Returnsinterfacetotheactiveclass.SetActiveClass [in]Type:BSTRClassName,[out,retval]Type:long*Value;[Method];'SetActiveClass(arglist)' SetstheActiveDSSClassforusewithActiveClassinterface.SameasSetActiveClassinCircuitinterface.Executive [out,retval]Type:IDSS_Executive**Value;[Property(get)];'value=Executive' InterfacetoDSSExecutivecommandsandoptionsEvents [out,retval]Type:IDSSEvents**Value;[Property(get)];'value=Events' InterfacetotheDSSEventsCmathLib [out,retval]Type:ICmathLib**Value;[Property(get)];'value=CmathLib' Returnsaninterfacetothecomplexmathlibrary.Parser [out,retval]Type:IParser**Value;[Property(get)];'value=Parser' ReturnsinterfacetotheOpenDSSParserlibraryforusebyuserwrittenprograms.DSSim_Coms [out,retval]Type:IDSSimComs**Value;[Property(get)];'value=DSSim_Coms' (noHelpstringavailable)

    15

  • SolutionInterfaceSolve [void;[Method];'Solve(arglist)' Executesolutionforpresentsolutionmode.Mode [out,retval]Type:long*Mode;[Property(get)];'value=Mode' Setpresentsolutionmode(byatextcodeseeDSSHelpMode [in]Type:longMode;[Property(put)];'Mode=value' Setpresentsolutionmode(byatextcodeseeDSSHelpFrequency [out,retval]Type:double*Frequency;[Property(get)];'value=Frequency' SettheFrequencyfornextsolutionFrequency [in]Type:doubleFrequency;[Property(put)];'Frequency=value' SettheFrequencyfornextsolutionHour [out,retval]Type:long*Hour;[Property(get)];'value=Hour' SetHourfortimeseriessolutions.Hour [in]Type:longHour;[Property(put)];'Hour=value' SetHourfortimeseriessolutions.Seconds [out,retval]Type:double*Seconds;[Property(get)];'value=Seconds' Secondsfromtopofthehour.Seconds [in]Type:doubleSeconds;[Property(put)];'Seconds=value' Secondsfromtopofthehour.StepSize [out,retval]Type:double*StepSize;[Property(get)];'value=StepSize' TimestepsizeinsecStepSize [in]Type:doubleStepSize;[Property(put)];'StepSize=value' TimestepsizeinsecYear [out,retval]Type:long*Year;[Property(get)];'value=Year' SetyearforplanningstudiesYear [in]Type:longYear;[Property(put)];'Year=value' SetyearforplanningstudiesLoadMult [out,retval]Type:double*LoadMult;[Property(get)];'value=LoadMult' DefaultloadmultiplierappliedtoallnonfixedloadsLoadMult [in]Type:doubleLoadMult;[Property(put)];'LoadMult=value' DefaultloadmultiplierappliedtoallnonfixedloadsIterations [out,retval]Type:long*Iterations;[Property(get)];'value=Iterations' Numberofiterationstakenforlastsolution.(SameasTotalIterationsMaxIterations [out,retval]Type:long*MaxIterations;[Property(get)];'value=MaxIterations' Maxallowableiterations.MaxIterations [in]Type:longMaxIterations;[Property(put)];'MaxIterations=value' Maxallowableiterations.Tolerance [out,retval]Type:double*Tolerance;[Property(get)];

    16

  • 'value=Tolerance' Solutionconvergencetolerance.Tolerance [in]Type:doubleTolerance;[Property(put)];'Tolerance=value' Solutionconvergencetolerance.Number [out,retval]Type:long*Number;[Property(get)];'value=Number' NumberofsolutionstoperformforMonteCarloandtimeseriessimulationsNumber [in]Type:longNumber;[Property(put)];'Number=value' NumberofsolutionstoperformforMonteCarloandtimeseriessimulationsRandom [out,retval]Type:long*Random;[Property(get)];'value=Random' Randomizationmodeforrandomvariables\i0Random [in]Type:longRandom;[Property(put)];'Random=value' Randomizationmodeforrandomvariables\i0ModeID [out,retval]Type:BSTR*Value;[Property(get)];'value=ModeID' ID(textLoadModel [out,retval]Type:long*Value;[Property(get)];'value=LoadModel' LoadModel:dssPowerFlow(defaultLoadModel [in]Type:longValue;[Property(put)];'LoadModel=value' LoadModel:dssPowerFlow(defaultLDCurve [out,retval]Type:BSTR*Value;[Property(get)];'value=LDCurve' LoadDurationCurvenameforLDmodesLDCurve [in]Type:BSTRValue;[Property(put)];'LDCurve=value' LoadDurationCurvenameforLDmodespctGrowth [out,retval]Type:double*Value;[Property(get)];'value=pctGrowth' PercentdefaultannualloadgrowthratepctGrowth [in]Type:doubleValue;[Property(put)];'pctGrowth=value' PercentdefaultannualloadgrowthrateAddType [out,retval]Type:long*Value;[Property(get)];'value=AddType' TypeofdevicetoaddinAutoAddMode:dssGen(DefaultAddType [in]Type:longValue;[Property(put)];'AddType=value' TypeofdevicetoaddinAutoAddMode:dssGen(DefaultGenkW [out,retval]Type:double*Value;[Property(get)];'value=GenkW' GeneratorkWforAutoAddmodeGenkW [in]Type:doubleValue;[Property(put)];'GenkW=value' GeneratorkWforAutoAddmodeGenPF [out,retval]Type:double*Value;[Property(get)];'value=GenPF' PFforgeneratorsinAutoAddmodeGenPF [in]Type:doubleValue;[Property(put)];'GenPF=value' PFforgeneratorsinAutoAddmodeCapkvar [out,retval]Type:double*Value;[Property(get)];'value=Capkvar' CapacitorkvarforaddingcapacitorsinAutoAddmode

    17

  • Capkvar [in]Type:doubleValue;[Property(put)];'Capkvar=value' CapacitorkvarforaddingcapacitorsinAutoAddmodeAlgorithm [out,retval]Type:long*Value;[Property(get)];'value=Algorithm' BaseSolutionalgorithm:dssNormalSolve|dssNewtonSolveAlgorithm [in]Type:longValue;[Property(put)];'Algorithm=value' BaseSolutionalgorithm:dssNormalSolve|dssNewtonSolveControlMode [out,retval]Type:long*Value;[Property(get)];'value=ControlMode' dssStatic*|dssEvent|dssTimeModesforcontroldevicesControlMode [in]Type:longValue;[Property(put)];'ControlMode=value' dssStatic*|dssEvent|dssTimeModesforcontroldevicesGenMult [out,retval]Type:double*Value;[Property(get)];'value=GenMult' DefaultMultiplierappliedtogenerators(likeLoadMultGenMult [in]Type:doubleValue;[Property(put)];'GenMult=value' DefaultMultiplierappliedtogenerators(likeLoadMultDefaultDaily [out,retval]Type:BSTR*Value;[Property(get)];'value=DefaultDaily' Defaultdailyloadshape(defaultsto\i0DefaultDaily [in]Type:BSTRValue;[Property(put)];'DefaultDaily=value' Defaultdailyloadshape(defaultsto\i0DefaultYearly [out,retval]Type:BSTR*Value;[Property(get)];'value=DefaultYearly' DefaultYearlyloadshape(defaultsto\i0DefaultYearly [in]Type:BSTRValue;[Property(put)];'DefaultYearly=value' DefaultYearlyloadshape(defaultsto\i0EventLog [out,retval]Type:VARIANT*Value;[Property(get)];'value=EventLog' ArrayofstringscontainingtheEventLogdblHour [out,retval]Type:double*Value;[Property(get)];'value=dblHour' Hourasadouble,includingfractionalpartdblHour [in]Type:doubleValue;[Property(put)];'dblHour=value' Hourasadouble,includingfractionalpartStepsizeMin [in]Type:doubleParam1;[Property(put)];'StepsizeMin=value' SetStepsizeinminutesStepsizeHr [in]Type:doubleParam1;[Property(put)];'StepsizeHr=value' SetStepsizeinHrControlIterations [out,retval]Type:long*Value;[Property(get)];'value=ControlIterations' ValueofthecontroliterationcounterControlIterations [in]Type:longValue;[Property(put)];'ControlIterations=value' ValueofthecontroliterationcounterMaxControlIterations [out,retval]Type:long*Value;[Property(get)];'value=MaxControlIterations' MaximumallowablecontroliterationsMaxControlIterations [in]Type:longValue;[Property(put)];

    18

  • 'MaxControlIterations=value' MaximumallowablecontroliterationsSample_DoControlActions [void;[Method];'Sample_DoControlActions(arglist)' SamplecontrolsandthenprocessthecontrolqueueforpresentcontrolmodeanddispatchcontrolactionsCheckFaultStatus [void;[Method];'CheckFaultStatus(arglist)' Executesstatuscheckonallfaultobjectsdefinedinthecircuit.SolveSnap [void;[Method];'SolveSnap(arglist)' ExecutethesnapshotpowerflowroutineintheDSSthatsolvesatthepresentstatewithcontrolactionsSolveDirect [void;[Method];'SolveDirect(arglist)' ExecutesadirectsolutionfromthesystemYmatrix,ignoringcompensationcurrentsofloads,generators(includesYprimonlySolvePflow [void;[Method];'SolvePflow(arglist)' Solvesusingpresentpowerflowmethod.Iterativesolutionratherthandirectsolution.SolveNoControl [void;[Method];'SolveNoControl(arglist)' SimilartoSolveSnapexceptnocontrolactionsarecheckedorexecutedSolvePlusControl [void;[Method];'SolvePlusControl(arglist)' Executesapowerflowsolution(SolveNoControlInitSnap [void;[Method];'InitSnap(arglist)' Initializessomevariablesforsnapshotpowerflow.SolveSnapdoesthisautomatically.CheckControls [void;[Method];'CheckControls(arglist)' ThenormalprocessforsamplingandexecutingControlActionsandFaultStatusandrebuildsYifnecessary.SampleControlDevices [void;[Method];'SampleControlDevices(arglist)' Executesasamplingofallintrinsiccontroldevices,whichpushcontrolactionsontothecontrolqueue.DoControlActions [void;[Method];'DoControlActions(arglist)' PopscontrolactionsoffthecontrolqueueanddispatchestothepropercontrolelementBuildYMatrix [in]Type:longBuildOption,[in]Type:longAllocateVI;[Method];'BuildYMatrix(arglist)' ForcebuildingoftheSystemYmatrixSystemYChanged [out,retval]Type:VARIANT_BOOL*Value;[Property(get)];'value=SystemYChanged' FlagthatindicatesifelementsoftheSystemYhavebeenchangedbyrecentactivity.Converged [out,retval]Type:VARIANT_BOOL*Value;[Property(get)];'value=Converged' Flagtoindicatewhetherthecircuitsolutionconverged

    19

  • Converged [in]Type:VARIANT_BOOLValue;[Property(put)];'Converged=value' FlagtoindicatewhetherthecircuitsolutionconvergedTotaliterations [out,retval]Type:long*Value;[Property(get)];'value=Totaliterations' Totaliterationsincludingcontroliterationsformostrecentsolution.MostIterationsDone [out,retval]Type:long*Value;[Property(get)];'value=MostIterationsDone' Maxnumberofiterationsrequiredtoconvergeatanycontroliterationofthemostrecentsolution.ControlActionsDone [out,retval]Type:VARIANT_BOOL*Value;[Property(get)];'value=ControlActionsDone' Flagindicatingthecontrolactionsaredone.ControlActionsDone [in]Type:VARIANT_BOOLValue;[Property(put)];'ControlActionsDone=value' (noHelpstringavailable)FinishTimeStep [void;[Method];'FinishTimeStep(arglist)' CallCleanup,samplemonitors,andincrementtimeatendoftimestep.Cleanup [void;[Method];'Cleanup(arglist)' Updatestorage,invcontrol,etcatendoftimestep

    MonitorsInterfaceAllNames [out,retval]Type:VARIANT*Value;[Property(get)];'value=AllNames' ArrayofallMonitorNamesFirst [out,retval]Type:long*Value;[Property(get)];'value=First' SetsthefirstMonitoractive.Returns0ifnomonitors.Next [out,retval]Type:long*Value;[Property(get)];'value=Next' Setsnextmonitoractive.Returns0ifnomore.Reset [void;[Method];'Reset(arglist)' ResetsactiveMonitorobject.ResetAll [void;[Method];'ResetAll(arglist)' ResetsallMonitorObjectsSample [void;[Method];'Sample(arglist)' CausesactiveMonitortotakeasample.Save [void;[Method];'Save(arglist)' Causesactivemonitortosaveitscurrentsamplebuffertoitsmonitorstream.ThenyoucanaccesstheBytestreamorchanneldata.Moststandardsolutionmodesdothisautomatically.Show [void;[Method];'Show(arglist)' ConvertsmonitorfiletotextanddisplayswithtexteditorFileName [out,retval]Type:BSTR*Value;[Property(get)];'value=FileName' NameofCSVfileassociatedwithactiveMonitor.

    20

  • Mode [out,retval]Type:long*Value;[Property(get)];'value=Mode' SetMonitormode(bitmaskintegerseeDSSHelpMode [in]Type:longValue;[Property(put)];'Mode=value' SetMonitormode(bitmaskintegerseeDSSHelpName [out,retval]Type:BSTR*Value;[Property(get)];'value=Name' SetstheactiveMonitorobjectbynameName [in]Type:BSTRValue;[Property(put)];'Name=value' SetstheactiveMonitorobjectbynameByteStream [out,retval]Type:VARIANT*Value;[Property(get)];'value=ByteStream' ByteArraycontainingmonitorstreamvalues.Makesurea\i0SampleCount [out,retval]Type:long*Value;[Property(get)];'value=SampleCount' NumberofSamplesinMonitoratPresentSampleAll [void;[Method];'SampleAll(arglist)' CausesallMonitorstotakeasampleofthepresentstateSaveAll [void;[Method];'SaveAll(arglist)' SaveallMonitorbufferstotheirrespectivefilestreams.Count [out,retval]Type:long*Value;[Property(get)];'value=Count' NumberofMonitorsProcess [void;[Method];'Process(arglist)' Postprocessmonitorsamplestakensofar,e.g.,Pstformode=4ProcessAll [void;[Method];'ProcessAll(arglist)' Allmonitorspostprocessthedatatakensofar.FileVersion [out,retval]Type:long*Value;[Property(get)];'value=FileVersion' MonitorFileVersion(integerRecordSize [out,retval]Type:long*Value;[Property(get)];'value=RecordSize' SizeofeachrecordinByteStream(IntegerHeader [out,retval]Type:VARIANT*Value;[Property(get)];'value=Header' Headerstring;VariantarrayofstringscontainingChannelnamesdblHour [out,retval]Type:VARIANT*Value;[Property(get)];'value=dblHour' Variantarrayofdoublescontaingintimevalueinhoursfortimesampledmonitorvalues;Emptyiffrequencysampledvaluesforharmonicssolution(seedblFreqdblFreq [out,retval]Type:VARIANT*Value;[Property(get)];'value=dblFreq' Variantarrayofdoublescontainingfrequencyvaluesforharmonicsmodesolutions;Emptyfortimemodesolutions(usedblHourChannel [in]Type:longIndex,[out,retval]Type:VARIANT*Value;[Property(get)];'value=Channel' Variantarrayofdoublesforthespecifiedchannel(usage:MyArray=DSSMonitor.Channel(iNumChannels [out,retval]Type:long*Value;[Property(get)];'value=NumChannels' NumberofChannelsintheactiveMonitor

    21

  • Element [out,retval]Type:BSTR*Value;[Property(get)];'value=Element' Fullobjectnameofelementbeingmonitored.Element [in]Type:BSTRValue;[Property(put)];'Element=value' Fullobjectnameofelementbeingmonitored.Terminal [out,retval]Type:long*Value;[Property(get)];'value=Terminal' TerminalnumberofelementbeingmonitoredTerminal [in]Type:longValue;[Property(put)];'Terminal=value' Terminalnumberofelementbeingmonitored.

    MetersInterfaceAllNames [out,retval]Type:VARIANT*Value;[Property(get)];'value=AllNames' ArrayofallenergyMeternamesFirst [out,retval]Type:long*Value;[Property(get)];'value=First' SetthefirstenergyMeteractive.Returns0ifnone.Next [out,retval]Type:long*Value;[Property(get)];'value=Next' SetsthenextenergyMeteractive.Returns0ifnomore.RegisterNames [out,retval]Type:VARIANT*Value;[Property(get)];'value=RegisterNames' Arrayofstringscontainingthenamesoftheregisters.RegisterValues [out,retval]Type:VARIANT*Value;[Property(get)];'value=RegisterValues' ArrayofallthevaluescontainedintheMeterregistersfortheactiveMeter.Reset [void;[Method];'Reset(arglist)' ResetsregistersofactiveMeter.ResetAll [void;[Method];'ResetAll(arglist)' ResetsregistersofallMeterobjects.Sample [void;[Method];'Sample(arglist)' ForcesactiveMetertotakeasample.Save [void;[Method];'Save(arglist)' Savesmeterregistervalues.Name [out,retval]Type:BSTR*Value;[Property(get)];'value=Name' Get/Settheactivemetername.Name [in]Type:BSTRValue;[Property(put)];'Name=value' Setametertobeactivebyname.Totals [out,retval]Type:VARIANT*Value;[Property(get)];'value=Totals' TotalsofallregistersofallmetersPeakcurrent [out,retval]Type:VARIANT*Value;[Property(get)];'value=Peakcurrent' ArrayofdoublestosetvaluesofPeakCurrentpropertyPeakcurrent [in]Type:VARIANTValue;[Property(put)];

    22

  • 'Peakcurrent=value' ArrayofdoublestosetvaluesofPeakCurrentpropertyCalcCurrent [out,retval]Type:VARIANT*Value;[Property(get)];'value=CalcCurrent' SetthemagnitudeoftherealpartoftheCalculatedCurrent(normallydeterminedbysolutionCalcCurrent [in]Type:VARIANTValue;[Property(put)];'CalcCurrent=value' SetthemagnitudeoftherealpartoftheCalculatedCurrent(normallydeterminedbysolutionAllocFactors [out,retval]Type:VARIANT*Value;[Property(get)];'value=AllocFactors' Arrayofdoubles:setthephaseallocationfactorsfortheactivemeter.AllocFactors [in]Type:VARIANTValue;[Property(put)];'AllocFactors=value' Arrayofdoubles:setthephaseallocationfactorsfortheactivemeter.MeteredElement [out,retval]Type:BSTR*Value;[Property(get)];'value=MeteredElement' SetNameofmeteredelementMeteredElement [in]Type:BSTRValue;[Property(put)];'MeteredElement=value' SetNameofmeteredelementMeteredTerminal [out,retval]Type:long*Value;[Property(get)];'value=MeteredTerminal' setNumberofMeteredTerminalMeteredTerminal [in]Type:longValue;[Property(put)];'MeteredTerminal=value' setNumberofMeteredTerminalDIFilesAreOpen [out,retval]Type:VARIANT_BOOL*Value;[Property(get)];'value=DIFilesAreOpen' GlobalFlagintheDSStoindicateifDemandInterval(DISampleAll [void;[Method];'SampleAll(arglist)' CausesallEnergyMeterobjectstotakeasampleatthepresenttimeSaveAll [void;[Method];'SaveAll(arglist)' SaveAllEnergyMeterobjectsOpenAllDIFiles [void;[Method];'OpenAllDIFiles(arglist)' OpenDemandInterval(DICloseAllDIFiles [void;[Method];'CloseAllDIFiles(arglist)' CloseAllDemandIntervalFiles(NecessaryattheendofarunCountEndElements [out,retval]Type:long*Value;[Property(get)];'value=CountEndElements' Numberofzoneendelementsintheactivemeterzone.AllEndElements [out,retval]Type:VARIANT*Value;[Property(get)];'value=AllEndElements' Variantarrayofnamesofallzoneendelements.Count [out,retval]Type:long*Value;[Property(get)];'value=Count' NumberofEnergyMetersintheActiveCircuitAllBranchesInZone [out,retval]Type:VARIANT*Value;[Property(get)];'value=AllBranchesInZone' Widestringlistofallbranchesinzoneoftheactiveenergymeterobject.CountBranches [out,retval]Type:long*Value;[Property(get)];

    23

  • 'value=CountBranches' NumberofbranchesinActiveenergymeterzone.(SameassequencelistsizeSAIFI [out,retval]Type:double*Value;[Property(get)];'value=SAIFI' ReturnsSAIFIforthismeter'sZone.ExecuteReliabilityCalcmethodfirst.SequenceIndex [out,retval]Type:long*Value;[Property(get)];'value=SequenceIndex' Get/setIndexintoMeter'sSequenceListthatcontainsbranchpointersinlexicalorder.Earlierindexguaranteedtobeuplinefromlaterindex.SetsPDelementactive.SequenceIndex [in]Type:longValue;[Property(put)];'SequenceIndex=value' Get/setIndexintoMeter'sSequenceListthatcontainsbranchpointersinlexicalorder.Earlierindexguaranteedtobeuplinefromlaterindex.SetsPDelementactive.SAIFIKW [out,retval]Type:double*Value;[Property(get)];'value=SAIFIKW' SAIFIbasedonkWratherthannumberofcustomers.Getafterreliabilitycalcs.DoReliabilityCalc [in]Type:VARIANT_BOOLAssumeRestoration;[Method];'DoReliabilityCalc(arglist)' CalculateSAIFI,etc.SeqListSize [out,retval]Type:long*Value;[Property(get)];'value=SeqListSize' SizeofSequenceListTotalCustomers [out,retval]Type:long*Value;[Property(get)];'value=TotalCustomers' TotalNumberofcustomersinthiszone(downlinefromtheEnergyMeterSAIDI [out,retval]Type:double*Value;[Property(get)];'value=SAIDI' SAIDIforthismeter'szone.ExecuteDoReliabilityCalcfirst.CustInterrupts [out,retval]Type:double*Value;[Property(get)];'value=CustInterrupts' TotalcustomerinterruptionsforthisMeterzonebasedonreliabilitycalcs.

    GeneratorsInterfaceAllNames [out,retval]Type:VARIANT*Value;[Property(get)];'value=AllNames' ArrayofnamesofallGeneratorobjects.RegisterNames [out,retval]Type:VARIANT*Value;[Property(get)];'value=RegisterNames' ArrayofNamesofallgeneratorenergymeterregistersRegisterValues [out,retval]Type:VARIANT*Value;[Property(get)];'value=RegisterValues' Arrayofvalusingeneratorenergymeterregisters.First [out,retval]Type:long*Value;[Property(get)];'value=First' SetsfirstGeneratortobeactive.Returns0ifnone.Next [out,retval]Type:long*Value;[Property(get)];'value=Next' SetsnextGeneratortobeactive.Returns0ifnomore.ForcedON [out,retval]Type:VARIANT_BOOL*Value;[Property(get)];

    24

  • 'value=ForcedON' IndicateswhetherthegeneratorisforcedONregardlesofotherdispatchcriteria.ForcedON [in]Type:VARIANT_BOOLValue;[Property(put)];'ForcedON=value' IndicateswhetherthegeneratorisforcedONregardlesofotherdispatchcriteria.Name [out,retval]Type:BSTR*Value;[Property(get)];'value=Name' Setsageneratoractivebyname.Name [in]Type:BSTRValue;[Property(put)];'Name=value' Setsageneratoractivebyname.kV [out,retval]Type:double*Value;[Property(get)];'value=kV' Voltagebasefortheactivegenerator,kVkV [in]Type:doubleValue;[Property(put)];'kV=value' Voltagebasefortheactivegenerator,kVkW [out,retval]Type:double*Value;[Property(get)];'value=kW' kWoutputfortheactivegenerator.kvarisupdatedforcurrentpowerfactor.kW [in]Type:doubleValue;[Property(put)];'kW=value' kWoutputfortheactivegenerator.kvarisupdatedforcurrentpowerfactorkvar [out,retval]Type:double*Value;[Property(get)];'value=kvar' kvaroutputfortheactivegenerator.UpdatespowerfactorbasedonpresentkWvalue.kvar [in]Type:doubleValue;[Property(put)];'kvar=value' kvaroutputfortheactivegenerator.UpdatespowerfactorbasedonpresentkW.PF [out,retval]Type:double*Value;[Property(get)];'value=PF' Powerfactor(pos.=producingvarsPF [in]Type:doubleValue;[Property(put)];'PF=value' Powerfactor(pos.=producingvarsPhases [out,retval]Type:long*Value;[Property(get)];'value=Phases' NumberofphasesPhases [in]Type:longValue;[Property(put)];'Phases=value' NumberofphasesCount [out,retval]Type:long*Value;[Property(get)];'value=Count' NumberofGeneratorObjectsinActiveCircuitidx [out,retval]Type:long*Value;[Property(get)];'value=idx' Get/SetactiveGeneratorbyindexintogeneratorslist.1..Countidx [in]Type:longValue;[Property(put)];'idx=value' Get/SetactiveGeneratorbyindexintogeneratorslist.1..Count

    25

  • DSSProgressInterfacePctProgress [in]Type:longParam1;[Property(put)];'PctProgress=value' Percentprogresstoindicate[0..100]Caption [in]Type:BSTRParam1;[Property(put)];'Caption=value' CaptiontoappearonthebottomoftheDSSProgressform.Show [void;[Method];'Show(arglist)' Showsprogressformwithnullcaptionandprogresssettozero.Close [void;[Method];'Close(arglist)' Closes(hides

    SettingsInterfaceAllowDuplicates [out,retval]Type:VARIANT_BOOL*Value;[Property(get)];'value=AllowDuplicates' True|False*DesignateswhethertoallowduplicatenamesofobjectsAllowDuplicates [in]Type:VARIANT_BOOLValue;[Property(put)];'AllowDuplicates=value' True|False*DesignateswhethertoallowduplicatenamesofobjectsZoneLock [out,retval]Type:VARIANT_BOOL*Value;[Property(get)];'value=ZoneLock' True|False*LocksZonesonenergymeterstopreventrebuildingifacircuitchangeoccurs.ZoneLock [in]Type:VARIANT_BOOLValue;[Property(put)];'ZoneLock=value' True|False*LocksZonesonenergymeterstopreventrebuildingifacircuitchangeoccurs.AllocationFactors [in]Type:doubleParam1;[Property(put)];'AllocationFactors=value' SetsallloadallocationfactorsforallloadsdefinedbyXFKVApropertytothisvalue.AutoBusList [out,retval]Type:BSTR*Value;[Property(get)];'value=AutoBusList' ListofBusesor(File=xxxxAutoBusList [in]Type:BSTRValue;[Property(put)];'AutoBusList=value' ListofBusesor(File=xxxxCktModel [out,retval]Type:long*Value;[Property(get)];'value=CktModel' dssMultiphase*|dssPositiveSeqIIndicateifthecircuitmodelispositivesequence.CktModel [in]Type:longValue;[Property(put)];'CktModel=value' dssMultiphase*|dssPositiveSeqIIndicateifthecircuitmodelispositivesequence.NormVminpu [out,retval]Type:double*Value;[Property(get)];

    26

  • 'value=NormVminpu' PerUnitminimumvoltageforNormalconditions.NormVminpu [in]Type:doubleValue;[Property(put)];'NormVminpu=value' PerUnitminimumvoltageforNormalconditions.NormVmaxpu [out,retval]Type:double*Value;[Property(get)];'value=NormVmaxpu' PerUnitmaximumvoltageforNormalconditions.NormVmaxpu [in]Type:doubleValue;[Property(put)];'NormVmaxpu=value' PerUnitmaximumvoltageforNormalconditions.EmergVminpu [out,retval]Type:double*Value;[Property(get)];'value=EmergVminpu' PerUnitminimumvoltageforEmergencyconditions.EmergVminpu [in]Type:doubleValue;[Property(put)];'EmergVminpu=value' PerUnitminimumvoltageforEmergencyconditions.EmergVmaxpu [out,retval]Type:double*Value;[Property(get)];'value=EmergVmaxpu' PerUnitmaximumvoltageforEmergencyconditions.EmergVmaxpu [in]Type:doubleValue;[Property(put)];'EmergVmaxpu=value' PerUnitmaximumvoltageforEmergencyconditions.UEweight [out,retval]Type:double*Value;[Property(get)];'value=UEweight' WeightingfactorappliedtoUEregistervalues.UEweight [in]Type:doubleValue;[Property(put)];'UEweight=value' WeightingfactorappliedtoUEregistervalues.LossWeight [out,retval]Type:double*Value;[Property(get)];'value=LossWeight' WeightingfactorappliedtoLossregistervalues.LossWeight [in]Type:doubleValue;[Property(put)];'LossWeight=value' WeightingfactorappliedtoLossregistervalues.UEregs [out,retval]Type:VARIANT*Value;[Property(get)];'value=UEregs' ArrayofIntegersdefiningenergymeterregisterstouseforcomputingUEUEregs [in]Type:VARIANTValue;[Property(put)];'UEregs=value' ArrayofIntegersdefiningenergymeterregisterstouseforcomputingUELossRegs [out,retval]Type:VARIANT*Value;[Property(get)];'value=LossRegs' IntegerarraydefiningwhichenergymeterregisterstouseforcomputinglossesLossRegs [in]Type:VARIANTValue;[Property(put)];'LossRegs=value' IntegerarraydefiningwhichenergymeterregisterstouseforcomputinglossesTrapezoidal [out,retval]Type:VARIANT_BOOL*Value;[Property(get)];'value=Trapezoidal' True|False*Getsvalueoftrapezoidalintegrationflaginenergymeters.Trapezoidal [in]Type:VARIANT_BOOLValue;[Property(put)];'Trapezoidal=value' True|False*Getsvalueoftrapezoidalintegrationflaginenergymeters.VoltageBases [out,retval]Type:VARIANT*Value;[Property(get)];'value=VoltageBases' ArrayofdoublesdefiningthelegalvoltagebasesinkVLL

    27

  • VoltageBases [in]Type:VARIANTValue;[Property(put)];'VoltageBases=value' ArrayofdoublesdefiningthelegalvoltagebasesinkVLLControlTrace [out,retval]Type:VARIANT_BOOL*Value;[Property(get)];'value=ControlTrace' True|False*Denoteswhethertotracethecontrolactionstoafile.ControlTrace [in]Type:VARIANT_BOOLValue;[Property(put)];'ControlTrace=value' True|False*Denoteswhethertotracethecontrolactionstoafile.PriceSignal [out,retval]Type:double*Value;[Property(get)];'value=PriceSignal' PriceSignalfortheCircuitPriceSignal [in]Type:doubleValue;[Property(put)];'PriceSignal=value' PriceSignalfortheCircuitPriceCurve [out,retval]Type:BSTR*Value;[Property(get)];'value=PriceCurve' NameofLoadShapeobjectthatservesasthesourceofpricesignaldataforyearlysimulations,etc.PriceCurve [in]Type:BSTRValue;[Property(put)];'PriceCurve=value' NameofLoadShapeobjectthatservesasthesourceofpricesignaldataforyearlysimulations,etc.

    LinesInterfaceName [out,retval]Type:BSTR*Value;[Property(get)];'value=Name' SpecifythenameoftheLineelementtosetitactive.Name [in]Type:BSTRValue;[Property(put)];'Name=value' SpecifythenameoftheLineelementtosetitactive.AllNames [out,retval]Type:VARIANT*Value;[Property(get)];'value=AllNames' NamesofallLineObjectsFirst [out,retval]Type:long*Value;[Property(get)];'value=First' Invokingthispropertysetsthefirstelementactive.Returns0ifnolines.Otherwise,indexofthelineelement.Next [out,retval]Type:long*Value;[Property(get)];'value=Next' InvokingthispropertyadvancestothenextLineelementactive.Returns0ifnomorelines.Otherwise,indexofthelineelement.New [in]Type:BSTRName,[out,retval]Type:long*Value;[Method];'New(arglist)' CreatesanewLineandmakesittheActiveCircuitElement.Bus1 [out,retval]Type:BSTR*Value;[Property(get)];'value=Bus1' Nameofbusforterminal1.Bus1 [in]Type:BSTRValue;[Property(put)];'Bus1=value' Nameofbusforterminal1.Bus2 [out,retval]Type:BSTR*Value;[Property(get)];'value=Bus2' Nameofbusforterminal2.

    28

  • Bus2 [in]Type:BSTRValue;[Property(put)];'Bus2=value' Nameofbusforterminal2.LineCode [out,retval]Type:BSTR*Value;[Property(get)];'value=LineCode' NameofLineCodeobjectthatdefinestheimpedances.LineCode [in]Type:BSTRValue;[Property(put)];'LineCode=value' NameofLineCodeobjectthatdefinestheimpedances.Length [out,retval]Type:double*Value;[Property(get)];'value=Length' LengthoflinesectioninunitscompatiblewiththeLineCodedefinition.Length [in]Type:doubleValue;[Property(put)];'Length=value' LengthoflinesectioninunitscompatiblewiththeLineCodedefinition.Phases [out,retval]Type:long*Value;[Property(get)];'value=Phases' NumberofPhases,thisLineelement.Phases [in]Type:longValue;[Property(put)];'Phases=value' NumberofPhases,thisLineelement.R1 [out,retval]Type:double*Value;[Property(get)];'value=R1' PositiveSequenceresistance,ohmsperunitlength.R1 [in]Type:doubleValue;[Property(put)];'R1=value' PositiveSequenceresistance,ohmsperunitlength.X1 [out,retval]Type:double*Value;[Property(get)];'value=X1' PositiveSequencereactance,ohmsperunitlength.X1 [in]Type:doubleValue;[Property(put)];'X1=value' PositiveSequencereactance,ohmsperunitlength.R0 [out,retval]Type:double*Value;[Property(get)];'value=R0' ZeroSequenceresistance,ohmsperunitlength.R0 [in]Type:doubleValue;[Property(put)];'R0=value' ZeroSequenceresistance,ohmsperunitlength.X0 [out,retval]Type:double*Value;[Property(get)];'value=X0' ZeroSequencereactanceohmsperunitlength.X0 [in]Type:doubleValue;[Property(put)];'X0=value' ZeroSequencereactanceohmsperunitlength.C1 [out,retval]Type:double*Value;[Property(get)];'value=C1' PositiveSequencecapacitance,nanofaradsperunitlength.C1 [in]Type:doubleValue;[Property(put)];'C1=value' PositiveSequencecapacitance,nanofaradsperunitlength.C0 [out,retval]Type:double*Value;[Property(get)];'value=C0' ZeroSequencecapacitance,nanofaradsperunitlength.C0 [in]Type:doubleValue;[Property(put)];'C0=value' ZeroSequencecapacitance,nanofaradsperunitlength.Rmatrix [out,retval]Type:VARIANT*Value;[Property(get)];

    29

  • 'value=Rmatrix' Resistancematrix(fullRmatrix [in]Type:VARIANTValue;[Property(put)];'Rmatrix=value' Resistancematrix(fullXmatrix [out,retval]Type:VARIANT*Value;[Property(get)];'value=Xmatrix' (noHelpstringavailable)Xmatrix [in]Type:VARIANTValue;[Property(put)];'Xmatrix=value' (noHelpstringavailable)Cmatrix [out,retval]Type:VARIANT*Value;[Property(get)];'value=Cmatrix' (noHelpstringavailable)Cmatrix [in]Type:VARIANTValue;[Property(put)];'Cmatrix=value' (noHelpstringavailable)NormAmps [out,retval]Type:double*Value;[Property(get)];'value=NormAmps' NormalampereratingofLine.NormAmps [in]Type:doubleValue;[Property(put)];'NormAmps=value' NormalampereratingofLine.EmergAmps [out,retval]Type:double*Value;[Property(get)];'value=EmergAmps' Emergency(maximumEmergAmps [in]Type:doubleValue;[Property(put)];'EmergAmps=value' Emergency(maximumGeometry [out,retval]Type:BSTR*Value;[Property(get)];'value=Geometry' LinegeometrycodeGeometry [in]Type:BSTRValue;[Property(put)];'Geometry=value' LinegeometrycodeRg [out,retval]Type:double*Value;[Property(get)];'value=Rg' EarthreturnresistancevalueusedtocomputelineimpedancesatpowerfrequencyRg [in]Type:doubleValue;[Property(put)];'Rg=value' EarthreturnresistancevalueusedtocomputelineimpedancesatpowerfrequencyXg [out,retval]Type:double*Value;[Property(get)];'value=Xg' EarthreturnreactancevalueusedtocomputelineimpedancesatpowerfrequencyXg [in]Type:doubleValue;[Property(put)];'Xg=value' EarthreturnreactancevalueusedtocomputelineimpedancesatpowerfrequencyRho [out,retval]Type:double*Value;[Property(get)];'value=Rho' EarthResistivity,mohmsRho [in]Type:doubleValue;[Property(put)];'Rho=value' EarthResistivity,mohmsYprim [out,retval]Type:VARIANT*Value;[Property(get)];'value=Yprim' Yprimitive:DoesNothingatpresentonPut;DangerousYprim [in]Type:VARIANTValue;[Property(put)];'Yprim=value' Yprimitive:DoesNothingatpresentonPut;Dangerous

    30

  • NumCust [out,retval]Type:long*Value;[Property(get)];'value=NumCust' Numberofcustomersonthislinesection.TotalCust [out,retval]Type:long*Value;[Property(get)];'value=TotalCust' TotalNumberofcustomersservedfromthislinesection.Parent [out,retval]Type:long*Value;[Property(get)];'value=Parent' SetsParentoftheactiveLinetobetheactiveline.Returns0ifnoparentoractionfails.Count [out,retval]Type:long*Value;[Property(get)];'value=Count' NumberofLineobjectsinActiveCircuit.Spacing [out,retval]Type:BSTR*Value;[Property(get)];'value=Spacing' LinespacingcodeSpacing [in]Type:BSTRValue;[Property(put)];'Spacing=value' LinespacingcodeUnits [out,retval]Type:long*Value;[Property(get)];'value=Units' (noHelpstringavailable)Units [in]Type:longValue;[Property(put)];'Units=value' (noHelpstringavailable)

    CtrlQueueInterfaceClearQueue [void;[Method];'ClearQueue(arglist)' ClearcontrolqueueDelete [in]Type:longActionHandle;[Method];'Delete(arglist)' DeleteacontrolactionfromtheDSScontrolqueuebyreferencingthehandleoftheactionNumActions [out,retval]Type:long*Value;[Property(get)];'value=NumActions' NumberofActionsonthecurrentactionlist(thathavebeenpoppedoffthecontrolqueuebyCheckControlActionsAction [in]Type:longParam1;[Property(put)];'Action=value' SettheactiveactionbyindexActionCode [out,retval]Type:long*Value;[Property(get)];'value=ActionCode' Codefortheactiveaction.LongintegercodetotellthecontroldevicewhattodoDeviceHandle [out,retval]Type:long*Value;[Property(get)];'value=DeviceHandle' Handle(UserdefinedPush [in]Type:longHour,[in]Type:doubleSeconds,[in]Type:longActionCode,[in]Type:longDeviceHandle,[out,retval]Type:long*Value;[Method];'Push(arglist)' PushacontrolactionontotheDSScontrolqueuebytime,actioncode,anddevicehandle(userdefined

    31

  • Show [void;[Method];'Show(arglist)' ShowentirecontrolqueueinCSVformatClearActions [void;[Method];'ClearActions(arglist)' CleartheActionlist.PopAction [out,retval]Type:long*Value;[Property(get)];'value=PopAction' Popsnextactionofftheactionlistandmakesittheactiveaction.Returnszeroifnone.

    LoadsInterfaceAllNames [out,retval]Type:VARIANT*Value;[Property(get)];'value=AllNames' VariantarrayofstringscontainingallLoadnamesFirst [out,retval]Type:long*Value;[Property(get)];'value=First' SetfirstLoadelementtobeactive;returns0ifnone.Next [out,retval]Type:long*Value;[Property(get)];'value=Next' SetsnextLoadelementtobeactive;returns0ofnoneelseindexofactiveload.Name [out,retval]Type:BSTR*Value;[Property(get)];'value=Name' Setactiveloadbyname.Name [in]Type:BSTRValue;[Property(put)];'Name=value' Setactiveloadbyname.Idx [out,retval]Type:long*Value;[Property(get)];'value=Idx' Setsactiveloadbyindexintoloadlist.1..CountIdx [in]Type:longValue;[Property(put)];'Idx=value' Setsactiveloadbyindexintoloadlist.1..CountkW [out,retval]Type:double*Value;[Property(get)];'value=kW' SetkWforactiveLoad.UpdateskvarbasedonpresentPF.kW [in]Type:doubleValue;[Property(put)];'kW=value' SetkWforactiveLoad.UpdateskvarbasedonpresentPF.kV [out,retval]Type:double*Value;[Property(get)];'value=kV' SetkVratingforactiveLoad.For2ormorephasessetLineLinekV.ElseactualkVacrossterminals.kV [in]Type:doubleValue;[Property(put)];'kV=value' SetkVratingforactiveLoad.For2ormorephasessetLineLinekV.ElseactualkVacrossterminals.kvar [out,retval]Type:double*Value;[Property(get)];'value=kvar' SetkvarforactiveLoad.UpdatesPFbasedinpresentkW.kvar [in]Type:doubleValue;[Property(put)];'kvar=value' SetkvarforactiveLoad.UpdatesPFbasedonpresentkW.PF [out,retval]Type:double*Value;[Property(get)];

    32

  • 'value=PF' SetPowerFactorforActiveLoad.SpecifyleadingPFasnegative.UpdateskvarbasedonkWvaluePF [in]Type:doubleValue;[Property(put)];'PF=value' SetPowerFactorforActiveLoad.SpecifyleadingPFasnegative.UpdateskvarbasedonpresentvalueofkW.Count [out,retval]Type:long*Value;[Property(get)];'value=Count' NumberofLoadobjectsinactivecircuit.PctMean [out,retval]Type:double*Value;[Property(get)];'value=PctMean' AveragepercentofnominalloadinMonteCarlostudies;onlyifnoloadshapedefinedforthisload.PctMean [in]Type:doubleValue;[Property(put)];'PctMean=value' (noHelpstringavailable)PctStdDev [out,retval]Type:double*Value;[Property(get)];'value=PctStdDev' PercentstandarddeviationforMonteCarloloadstudies;ifthereisnoloadshapeassignedtothisload.PctStdDev [in]Type:doubleValue;[Property(put)];'PctStdDev=value' (noHelpstringavailable)AllocationFactor [out,retval]Type:double*Value;[Property(get)];'value=AllocationFactor' FactorforallocatingloadsbyconnectedxfkvaAllocationFactor [in]Type:doubleValue;[Property(put)];'AllocationFactor=value' (noHelpstringavailable)Cfactor [out,retval]Type:double*Value;[Property(get)];'value=Cfactor' Factorrelatesaveragetopeakkw.Usedforallocationwithkwhandkwhdays/Cfactor [in]Type:doubleValue;[Property(put)];'Cfactor=value' (noHelpstringavailable)Class [out,retval]Type:long*Value;[Property(get)];'value=Class' Acodenumberusedtoseparateloadsbyclassorgroup.Noeffectonthesolution.Class [in]Type:longValue;[Property(put)];'Class=value' (noHelpstringavailable)IsDelta [out,retval]Type:VARIANT_BOOL*Value;[Property(get)];'value=IsDelta' Deltaloadsareconnectedlinetoline.IsDelta [in]Type:VARIANT_BOOLValue;[Property(put)];'IsDelta=value' (noHelpstringavailable)CVRcurve [out,retval]Type:BSTR*Value;[Property(get)];'value=CVRcurve' NameofaloadshapewithbothMultandQmult,forCVRfactorsasafunctionoftime.CVRcurve [in]Type:BSTRValue;[Property(put)];

    33

  • 'CVRcurve=value' (noHelpstringavailable)CVRwatts [out,retval]Type:double*Value;[Property(get)];'value=CVRwatts' PercentreductioninPforpercentreductioninV.MustbeusedwithdssLoadModelCVR.CVRwatts [in]Type:doubleValue;[Property(put)];'CVRwatts=value' (noHelpstringavailable)CVRvars [out,retval]Type:double*Value;[Property(get)];'value=CVRvars' PercentreductioninQforpercentreductioninV.MustbeusedwithdssLoadModelCVR.CVRvars [in]Type:doubleValue;[Property(put)];'CVRvars=value' (noHelpstringavailable)daily [out,retval]Type:BSTR*Value;[Property(get)];'value=daily' Nameoftheloadshapeforadailyloadprofile.daily [in]Type:BSTRValue;[Property(put)];'daily=value' (noHelpstringavailable)duty [out,retval]Type:BSTR*Value;[Property(get)];'value=duty' Nameoftheloadshapeforadutycyclesimulation.duty [in]Type:BSTRValue;[Property(put)];'duty=value' (noHelpstringavailable)kva [out,retval]Type:double*Value;[Property(get)];'value=kva' Baseloadkva.Alsodefinedkwandkvarorpfinput,orloadallocationbykwhorxfkva.kva [in]Type:doubleValue;[Property(put)];'kva=value' (noHelpstringavailable)kwh [out,retval]Type:double*Value;[Property(get)];'value=kwh' kwhbilledforthisperiod.CanbeusedwithCfactorforloadallocation.kwh [in]Type:doubleValue;[Property(put)];'kwh=value' (noHelpstringavailable)kwhdays [out,retval]Type:double*Value;[Property(get)];'value=kwhdays' Lengthofkwhbillingperiodforaveragedemandcalculation.Default30.kwhdays [in]Type:doubleValue;[Property(put)];'kwhdays=value' (noHelpstringavailable)Model [out,retval]Type:enumLoadModels*,[Value;[Property(get)];'value=Model' TheLoadModeldefinesvariationofPandQwithvoltage.Model [in]Type:enumLoadModels,[Value;[Property(put)];'Model=value' (noHelpstringavailable)NumCust [out,retval]Type:long*Value;[Property(get)];'value=NumCust' Numberofcustomersinthisload,defaultstoone.NumCust [in]Type:longValue;[Property(put)];

    34

  • 'NumCust=value' (noHelpstringavailable)Rneut [out,retval]Type:double*Value;[Property(get)];'value=Rneut' Neutralresistanceforwyeconnectedloads.Rneut [in]Type:doubleValue;[Property(put)];'Rneut=value' (noHelpstringavailable)Spectrum [out,retval]Type:BSTR*Value;[Property(get)];'value=Spectrum' Nameofharmoniccurrentspectrrumshape.Spectrum [in]Type:BSTRValue;[Property(put)];'Spectrum=value' (noHelpstringavailable)Vmaxpu [out,retval]Type:double*Value;[Property(get)];'value=Vmaxpu' Maximumperunitvoltagetousetheloadmodel.Abovethis,constantZapplies.Vmaxpu [in]Type:doubleValue;[Property(put)];'Vmaxpu=value' (noHelpstringavailable)Vminemerg [out,retval]Type:double*Value;[Property(get)];'value=Vminemerg' Minimumvoltageforunservedenergy(UEVminemerg [in]Type:doubleValue;[Property(put)];'Vminemerg=value' (noHelpstringavailable)Vminnorm [out,retval]Type:double*Value;[Property(get)];'value=Vminnorm' Minimumvoltageforenergyexceedingnormal(EENVminnorm [in]Type:doubleValue;[Property(put)];'Vminnorm=value' (noHelpstringavailable)Vminpu [out,retval]Type:double*Value;[Property(get)];'value=Vminpu' Minimumvoltagetoapplytheloadmodel.Belowthis,constantZisused.Vminpu [in]Type:doubleValue;[Property(put)];'Vminpu=value' (noHelpstringavailable)xfkVA [out,retval]Type:double*Value;[Property(get)];'value=xfkVA' RatedservicetransformerkVAforloadallocation,usingAllocationFactor.AffectskW,kvar,andpf.xfkVA [in]Type:doubleValue;[Property(put)];'xfkVA=value' (noHelpstringavailable)Xneut [out,retval]Type:double*Value;[Property(get)];'value=Xneut' Neutralreactanceforwyeconnectedloads.Xneut [in]Type:doubleValue;[Property(put)];'Xneut=value' (noHelpstringavailable)Yearly [out,retval]Type:BSTR*Value;[Property(get)];'value=Yearly' NameofyearlydurationloadshapeYearly [in]Type:BSTRValue;[Property(put)];'Yearly=value' (noHelpstringavailable)

    35

  • Status [out,retval]Type:enumLoadStatus*,[Value;[Property(get)];'value=Status' Responsetoloadmultipliers:Fixed(growthonlyStatus [in]Type:enumLoadStatus,[Value;[Property(put)];'Status=value' (noHelpstringavailable)Growth [out,retval]Type:BSTR*Value;[Property(get)];'value=Growth' Nameofthegrowthshapecurveforyearlyloadgrowthfactors.Growth [in]Type:BSTRValue;[Property(put)];'Growth=value' (noHelpstringavailable)ZIPV [out,retval]Type:VARIANT*Value;[Property(get)];'value=ZIPV' Arrayof7doubleswithvaluesforZIPVpropertyoftheLOADobjectZIPV [in]Type:VARIANTValue;[Property(put)];'ZIPV=value' (noHelpstringavailable)pctSeriesRL [out,retval]Type:double*Value;[Property(get)];'value=pctSeriesRL' (noHelpstringavailable)pctSeriesRL [in]Type:doubleValue;[Property(put)];'pctSeriesRL=value' PercentofLoadthatismodeledasseriesRLforharmonicsstudiesRelWeight [out,retval]Type:double*Value;[Property(get)];'value=RelWeight' RelativeWeightingfactorfortheactiveLOADRelWeight [in]Type:doubleValue;[Property(put)];'RelWeight=value' RelativeWeightingfactorfortheactiveLOAD

    DSSElementInterfaceName [out,retval]Type:BSTR*Value;[Property(get)];'value=Name' FullNameofActiveDSSObject(generalelementorcircuitelementProperties [in]Type:VARIANTIndx,[out,retval]Type:IDSSProperty**Value;[Property(get)];'value=Properties' CollectionofpropertiesforActiveDSSobject(generalelementorcircuitelementNumProperties [out,retval]Type:long*Value;[Property(get)];'value=NumProperties' NumberofPropertiesfortheactiveDSSobject.AllPropertyNames [out,retval]Type:VARIANT*Value;[Property(get)];'value=AllPropertyNames' VariantarrayofstringscontainingthenamesofallpropertiesfortheactiveDSSobject.

    ActiveClassInterfaceAllNames [out,retval]Type:VARIANT*Value;[Property(get)];'value=AllNames' Variantarrayofstringsconsistingofallelementnamesintheactiveclass.

    36

  • First [out,retval]Type:long*Value;[Property(get)];'value=First' SetsfirstelementintheactiveclasstobetheactiveDSSobject.IfobjectisaCktElement,ActiveCktELmentalsopointstothiselement.Returns0ifnone.Next [out,retval]Type:long*Value;[Property(get)];'value=Next' SetsnextelementinactiveclasstobetheactiveDSSobject.IfobjectisaCktElement,ActiveCktElementalsopointstothiselement.Returns0ifnomore.Name [out,retval]Type:BSTR*Value;[Property(get)];'value=Name' NameoftheActiveElementoftheActiveClassName [in]Type:BSTRValue;[Property(put)];'Name=value' (noHelpstringavailable)NumElements [out,retval]Type:long*Value;[Property(get)];'value=NumElements' Numberofelementsinthisclass.SameasCountproperty.ActiveClassName [out,retval]Type:BSTR*Value;[Property(get)];'value=ActiveClassName' Returnsnameofactiveclass.Count [out,retval]Type:long*Value;[Property(get)];'value=Count' NumberofelementsinActiveClass.SameasNumElementsProperty.

    CapacitorsInterfacekV [out,retval]Type:double*Value;[Property(get)];'value=kV' BankkVrating.UseLLfor2or3phases,oractualcanratingfor1phase.kV [in]Type:doubleValue;[Property(put)];'kV=value' BankkVrating.UseLLfor2or3phases,oractualcanratingfor1phase.kvar [out,retval]Type:double*Value;[Property(get)];'value=kvar' TotalbankKVAR,distributedequallyamongphasesandsteps.kvar [in]Type:doubleValue;[Property(put)];'kvar=value' TotalbankKVAR,distributedequallyamongphasesandsteps.NumSteps [out,retval]Type:long*Value;[Property(get)];'value=NumSteps' Numberofsteps(default1NumSteps [in]Type:longValue;[Property(put)];'NumSteps=value' Numberofsteps(default1IsDelta [out,retval]Type:VARIANT_BOOL*Value;[Property(get)];'value=IsDelta' Deltaconnectionorwye?IsDelta [in]Type:VARIANT_BOOLValue;[Property(put)];'IsDelta=value' Deltaconnectionorwye?AllNames [out,retval]Type:VARIANT*Value;[Property(get)];'value=AllNames' VariantarrayofstringswithallCapacitornamesinthecircuit.First [out,retval]Type:long*Value;[Property(get)];'value=First' SetsthefirstCapacitoractive.Returns0ifnomore.

    37

  • Next [out,retval]Type:long*Value;[Property(get)];'value=Next' SetsthenextCapacitoractive.Returns0ifnomore.Name [out,retval]Type:BSTR*Value;[Property(get)];'value=Name' SetstheacitveCapacitorbyName.Name [in]Type:BSTRValue;[Property(put)];'Name=value' SetstheacitveCapacitorbyName.Count [out,retval]Type:long*Value;[Property(get)];'value=Count' NumberofCapacitorobjectsinactivecircuit.AddStep [out,retval]Type:VARIANT_BOOL*value;[Method];'AddStep(arglist)' Addsonestepofthecapacitorifavailable.IfsuccessfulreturnsTRUE.SubtractStep [out,retval]Type:VARIANT_BOOL*Value;[Method];'SubtractStep(arglist)' Subtractonecapacitorstep.ReturnsFalseifnomoresteps.AvailableSteps [out,retval]Type:long*Value;[Property(get)];'value=AvailableSteps' NumberofStepsavailableincapbanktobeswitchedON.States [out,retval]Type:VARIANT*Value;[Property(get)];'value=States' Avariantarrayofinteger[0..numsteps1]indicatingstateofeachstep.Ifvalueis1anerrorhasoccurred.States [in]Type:VARIANTValue;[Property(put)];'States=value' Variantarrayofinteger[0..numSteps1]indicatingthestateofeachstepOpen [void;[Method];'Open(arglist)' Openallsteps,allphasesoftheCapacitorClose [void;[Method];'Close(arglist)' CloseallphasesofallstepsoftheCapacitor

    TransformersInterfaceNumWindings [out,retval]Type:long*Value;[Property(get)];'value=NumWindings' Numberofwindingsonthistransformer.Allocatesmemory;setorchangethispropertyfirst.NumWindings [in]Type:longValue;[Property(put)];'NumWindings=value' Numberofwindingsonthistransformer.Allocatesmemory;setorchangethispropertyfirst.XfmrCode [out,retval]Type:BSTR*Value;[Property(get)];'value=XfmrCode' NameofanXfrmCodethatsupplieselectircalparametersforthisTransformer.XfmrCode [in]Type:BSTRValue;[Property(put)];'XfmrCode=value' NameofanXfrmCodethatsupplieselectircalparametersforthisTransformer.Wdg [out,retval]Type:long*Value;[Property(get)];

    38

  • 'value=Wdg' ActiveWindingNumberfrom1..NumWindings.Updatethisbeforereadingorsettingasequenceofwindingproperties(R,Tap,kV,kVA,etc.Wdg [in]Type:longValue;[Property(put)];'Wdg=value' ActiveWindingNumberfrom1..NumWindings.Updatethisbeforereadingorsettingasequenceofwindingproperties(R,Tap,kV,kVA,etc.R [out,retval]Type:double*Value;[Property(get)];'value=R' ActiveWindingresistancein%R [in]Type:doubleValue;[Property(put)];'R=value' ActiveWindingresistancein%Tap [out,retval]Type:double*Value;[Property(get)];'value=Tap' ActiveWindingtapinperunit.Tap [in]Type:doubleValue;[Property(put)];'Tap=value' ActiveWindingtapinperunit.MinTap [out,retval]Type:double*Value;[Property(get)];'value=MinTap' ActiveWindingminimumtapinperunit.MinTap [in]Type:doubleValue;[Property(put)];'MinTap=value' ActiveWindingminimumtapinperunit.MaxTap [out,retval]Type:double*Value;[Property(get)];'value=MaxTap' ActiveWindingmaximumtapinperunit.MaxTap [in]Type:doubleValue;[Property(put)];'MaxTap=value' ActiveWindingmaximumtapinperunit.NumTaps [out,retval]Type:long*Value;[Property(get)];'value=NumTaps' ActiveWindingnumberoftapstepsbetweinMinTapandMaxTap.NumTaps [in]Type:longValue;[Property(put)];'NumTaps=value' ActiveWindingnumberoftapstepsbetweinMinTapandMaxTap.kV [out,retval]Type:double*Value;[Property(get)];'value=kV' ActiveWindingkVrating.Phasephasefor2or3phases,actualwindingkVfor1phasetransformer.kV [in]Type:doubleValue;[Property(put)];'kV=value' ActiveWindingkVrating.Phasephasefor2or3phases,actualwindingkVfor1phasetransformer.kVA [out,retval]Type:double*Value;[Property(get)];'value=kVA' ActiveWindingkVArating.Onwinding1,thisalsodeterminesnormalandemergencycurrentratingsforallwindings.kVA [in]Type:doubleValue;[Property(put)];'kVA=value' ActiveWindingkVArating.Onwinding1,thisalsodeterminesnormalandemergencycurrentratingsforallwindings.Xneut [out,retval]Type:double*Value;[Property(get)];'value=Xneut' ActiveWindingneutralreactance[ohms]forwyeconnections.

    39

  • Xneut [in]Type:doubleValue;[Property(put)];'Xneut=value' ActiveWindingneutralreactance[ohms]forwyeconnections.Rneut [out,retval]Type:double*Value;[Property(get)];'value=Rneut' ActiveWindingneutralresistance[ohms]forwyeconnections.Setlessthanzeroforungroundedwye.Rneut [in]Type:doubleValue;[Property(put)];'Rneut=value' ActiveWindingneutralresistance[ohms]forwyeconnections.Setlessthanzeroforungroundedwye.IsDelta [out,retval]Type:VARIANT_BOOL*Value;[Property(get)];'value=IsDelta' ActiveWindingdeltaorwyeconnection?IsDelta [in]Type:VARIANT_BOOLValue;[Property(put)];'IsDelta=value' ActiveWindingdeltaorwyeconnection?Xhl [out,retval]Type:double*Value;[Property(get)];'value=Xhl' Percentreactancebetweenwindings1and2,onwinding1kVAbase.Usefor2windingor3windingtransformers.Xhl [in]Type:doubleValue;[Property(put)];'Xhl=value' Percentreactancebetweenwindings1and2,onwinding1kVAbase.Usefor2windingor3windingtransformers.Xht [out,retval]Type:double*Value;[Property(get)];'value=Xht' Percentreactancebetweenwindigns1and3,onwinding1kVAbase.Usefor3windingtransformersonly.Xht [in]Type:doubleValue;[Property(put)];'Xht=value' Percentreactancebetweenwindigns1and3,onwinding1kVAbase.Usefor3windingtransformersonly.Xlt [out,retval]Type:double*Value;[Property(get)];'value=Xlt' Percentreactancebetweenwindings2and3,onwinding_1_kVAbase.Usefor3windingtransformersonly.Xlt [in]Type:doubleValue;[Property(put)];'Xlt=value' Percentreactancebetweenwindings2and3,onwinding_1_kVAbase.Usefor3windingtransformersonly.Name [out,retval]Type:BSTR*Value;[Property(get)];'value=Name' SetsaTransformeractivebyName.and3,onwinding_1_kVAbase.Usefor3windingtransformersonly.Name [in]Type:BSTRValue;[Property(put)];'Name=value' SetsaTransformeractivebyName.and3,onwinding_1_kVAbase.Usefor3windingtransformersonly.First [out,retval]Type:long*Value;[Property(get)];'value=First' SetsthefirstTransformeractive.Returns0ifnomore.Next [out,retval]Type:long*Value;[Property(get)];

    40

  • 'value=Next' SetsthenextTransformeractive.Returns0ifnomore.AllNames [out,retval]Type:VARIANT*Value;[Property(get)];'value=AllNames' VariantarrayofstringswithallTransformernamesintheactivecircuit.Count [out,retval]Type:long*Value;[Property(get)];'value=Count' (noHelpstringavailable)

    SwtControlsInterfaceAllNames [out,retval]Type:VARIANT*Value;[Property(get)];'value=AllNames' VariantarrayofstringswithallSwtControlnamesintheactivecircuit.Name [out,retval]Type:BSTR*Value;[Property(get)];'value=Name' SetsaSwtControlactivebyName.Name [in]Type:BSTRValue;[Property(put)];'Name=value' SetsaSwtControlactivebyName.First [out,retval]Type:long*Value;[Property(get)];'value=First' SetsthefirstSwtControlactive.Returns0ifnomore.Next [out,retval]Type:long*Value;[Property(get)];'value=Next' SetsthenextSwtControlactive.Returns0ifnomore.Action [out,retval]Type:enumActionCodes*,[Value;[Property(get)];'value=Action' OpenorClosetheswitch.Noeffectifswitchislocked.However,Resetremovesanylockandthenclosestheswitch(shelfstateAction [in]Type:enumActionCodes,[Value;[Property(put)];'Action=value' OpenorClosetheswitch.Noeffectifswitchislocked.However,Resetremovesanylockandthenclosestheswitch(shelfstateIsLocked [out,retval]Type:VARIANT_BOOL*Value;[Property(get)];'value=IsLocked' Thelockpreventsbothmanualandautomaticswitchoperation.IsLocked [in]Type:VARIANT_BOOLValue;[Property(put)];'IsLocked=value' Thelockpreventsbothmanualandautomaticswitchoperation.Delay [out,retval]Type:double*Value;[Property(get)];'value=Delay' Timedelay[s]betwenarmingandopeningorclosingtheswitch.Controlmayresetbeforeactuallyoperatingtheswitch.Delay [in]Type:doubleValue;[Property(put)];'Delay=value' Timedelay[s]betwenarmingandopeningorclosingtheswitch.Controlmayresetbeforeactuallyoperatingtheswitch.SwitchedObj [out,retval]Type:BSTR*Value;[Property(get)];'value=SwitchedObj' Fullnameoftheswitchedelement.SwitchedObj [in]Type:BSTRValue;[Property(put)];'SwitchedObj=value' Fullnameoftheswitchedelement.SwitchedTerm [out,retval]Type:long*Value;[Property(get)];

    41

  • 'value=SwitchedTerm' TerminalnumberwheretheswitchislocatedontheSwitchedObjSwitchedTerm [in]Type:longValue;[Property(put)];'SwitchedTerm=value' TerminalnumberwheretheswitchislocatedontheSwitchedObjCount [out,retval]Type:long*Value;[Property(get)];'value=Count' (noHelpstringavailable)

    CapControlsInterfaceAllNames [out,retval]Type:VARIANT*Value;[Property(get)];'value=AllNames' VariantarrayofstringswithallCapControlnames.Name [out,retval]Type:BSTR*Value;[Property(get)];'value=Name' SetsaCapControlactivebyname.Name [in]Type:BSTRValue;[Property(put)];'Name=value' SetsaCapControlactivebyname.First [out,retval]Type:long*Value;[Property(get)];'value=First' SetsthefirstCapControlasactive.Return0ifnone.Next [out,retval]Type:long*Value;[Property(get)];'value=Next' GetsthenextCapControlinthecircut.Returns0ifnone.Mode [out,retval]Type:enumCapControlModes*,[Value;[Property(get)];'value=Mode' Typeofautomaticcontroller.Mode [in]Type:enumCapControlModes,[Value;[Property(put)];'Mode=value' Typeofautomaticcontroller.Capacitor [out,retval]Type:BSTR*Value;[Property(get)];'value=Capacitor' NameoftheCapacitorthatiscontrolled.Capacitor [in]Type:BSTRValue;[Property(put)];'Capacitor=value' NameoftheCapacitorthatiscontrolled.MonitoredObj [out,retval]Type:BSTR*Value;[Property(get)];'value=MonitoredObj' FullnameoftheelementthatPTandCTareconnectedto.MonitoredObj [in]Type:BSTRValue;[Property(put)];'MonitoredObj=value' FullnameoftheelementthatPTandCTareconnectedto.MonitoredTerm [out,retval]Type:long*Value;[Property(get)];'value=MonitoredTerm' TerminalnumberontheelementthatPTandCTareconnectedto.MonitoredTerm [in]Type:longValue;[Property(put)];'MonitoredTerm=value' TerminalnumberontheelementthatPTandCTareconnectedto.CTratio [out,retval]Type:double*Value;[Property(get)];'value=CTratio' Transducerratiofrompirmarycurrenttocontrolcurrent.CTratio [in]Type:doubleValue;[Property(put)];'CTratio=value' Transducerratiofrompirmarycurrenttocontrolcurrent.PTratio [out,retval]Type:double*Value;[Property(get)];

    42

  • 'value=PTratio' Transducerratiofromprimaryfeedertocontrolvoltage.PTratio [in]Type:doubleValue;[Property(put)];'PTratio=value' Transducerratiofromprimaryfeedertocontrolvoltage.ONSetting [out,retval]Type:double*Value;[Property(get)];'value=ONSetting' Thresholdtoarmorswitchonastep.SeeModeforunits.ONSetting [in]Type:doubleValue;[Property(put)];'ONSetting=value' Thresholdtoarmorswitchonastep.SeeModeforunits.OFFSetting [out,retval]Type:double*Value;[Property(get)];'value=OFFSetting' Thresholdtoswitchoffastep.SeeModeforunits.OFFSetting [in]Type:doubleValue;[Property(put)];'OFFSetting=value' Thresholdtoswitchoffastep.SeeModeforunits.Vmax [out,retval]Type:double*Value;[Property(get)];'value=Vmax' WithVoltOverride,swtichoffwheneverPTvoltageexceedsthislevel.Vmax [in]Type:doubleValue;[Property(put)];'Vmax=value' WithVoltOverride,swtichoffwheneverPTvoltageexceedsthislevel.Vmin [out,retval]Type:double*Value;[Property(get)];'value=Vmin' WithVoltOverride,switchONwheneverPTvoltagedropsbelowthislevel.Vmin [in]Type:doubleValue;[Property(put)];'Vmin=value' WithVoltOverride,switchONwheneverPTvoltagedropsbelowthislevel.UseVoltOverride [out,retval]Type:VARIANT_BOOL*Value;[Property(get)];'value=UseVoltOverride' EnablesVminandVmaxtooverridethecontrolModeUseVoltOverride [in]Type:VARIANT_BOOLValue;[Property(put)];'UseVoltOverride=value' EnablesVminandVmaxtooverridethecontrolModeDelay [out,retval]Type:double*Value;[Property(get)];'value=Delay' Timedelay[s]toswitchonafterarming.Controlmayresetbeforeactuallyswitching.Delay [in]Type:doubleValue;[Property(put)];'Delay=value' Timedelay[s]toswitchonafterarming.Controlmayresetbeforeactuallyswitching.DelayOff [out,retval]Type:double*Value;[Property(get)];'value=DelayOff' Timedelay[s]beforeswithcingoffastep.Controlmayresetbeforeactuallyswitching.DelayOff [in]Type:doubleValue;[Property(put)];'DelayOff=value' Timedelay[s]beforeswithcingoffastep.Controlmayresetbeforeactuallyswitching.DeadTime [out,retval]Type:double*Value;[Property(get)];'value=DeadTime' (noHelpstringavailable)DeadTime [in]Type:doubleValue;[Property(put)];'DeadTime=value' (noHelpstringavailable)

    43

  • Count [out,retval]Type:long*Value;[Property(get)];'value=Count' NumberofCapControlsinActiveCircuit

    RegControlsInterfaceAllNames [out,retval]Type:VARIANT*Value;[Property(get)];'value=AllNames' VariantarrayofstringscontainingallRegControlnamesName [out,retval]Type:BSTR*Value;[Property(get)];'value=Name' Get/setActiveRegControlnameName [in]Type:BSTRValue;[Property(put)];'Name=value' SetsaRegControlactivebynameFirst [out,retval]Type:long*Value;[Property(get)];'value=First' SetsthefirstRegControlactive.Returns0ifnone.Next [out,retval]Type:long*Value;[Property(get)];'value=Next' SetsthenextRegControlactive.Returns0ifnone.MonitoredBus [out,retval]Type:BSTR*Value;[Property(get)];'value=MonitoredBus' Nameofaremoteregulatedbus,inlieuofLDCsettingsMonitoredBus [in]Type:BSTRValue;[Property(put)];'MonitoredBus=value' Nameofaremoteregulatedbus,inlieuofLDCsettingsTransformer [out,retval]Type:BSTR*Value;[Property(get)];'value=Transformer' NameofthetransformerthisregulatorcontrolsTransformer [in]Type:BSTRValue;[Property(put)];'Transformer=value' NameofthetransformerthisregulatorcontrolsTapWinding [out,retval]Type:long*Value;[Property(get)];'value=TapWinding' TappedwindingnumberTapWinding [in]Type:longValue;[Property(put)];'TapWinding=value' TappedwindingnumberWinding [out,retval]Type:long*Value;[Property(get)];'value=Winding' WindingnumberforPTandCTconnectionsWinding [in]Type:longValue;[Property(put)];'Winding=value' WindingnumberforPTandCTconnectionsCTPrimary [out,retval]Type:double*Value;[Property(get)];'value=CTPrimary' CTprimaryampererating(secondaryis0.2amperesCTPrimary [in]Type:doubleValue;[Property(put)];'CTPrimary=value' CTprimaryampererating(secondaryis0.2amperesPTratio [out,retval]Type:double*Value;[Property(get)];'value=PTratio' PTratioforvoltagecontrolsettingsPTratio [in]Type:doubleValue;[Property(put)];'PTratio=value' PTratioforvoltagecontrolsettings

    44

  • ForwardR [out,retval]Type:double*Value;[Property(get)];'value=ForwardR' LDCRsettinginVoltsForwardR [in]Type:doubleValue;[Property(put)];'ForwardR=value' LDCRsettinginVoltsForwardX [out,retval]Type:double*Value;[Property(get)];'value=ForwardX' LDCXsettinginVoltsForwardX [in]Type:doubleValue;[Property(put)];'ForwardX=value' LDCXsettinginVoltsReverseR [out,retval]Type:double*Value;[Property(get)];'value=ReverseR' ReverseLDCRsettinginVolts.ReverseR [in]Type:doubleValue;[Property(put)];'ReverseR=value' ReverseLDCRsettinginVolts.ReverseX [out,retval]Type:double*Value;[Property(get)];'value=ReverseX' ReverseLDCXsettinginvolts.ReverseX [in]Type:doubleValue;[Property(put)];'ReverseX=value' ReverseLDCXsettinginvolts.IsReversible [out,retval]Type:VARIANT_BOOL*Value;[Property(get)];'value=IsReversible' Regulatorcanusedifferentsettingsinthereversedirection.Usuallynotapplicabletosubstationtransformers.IsReversible [in]Type:VARIANT_BOOLValue;[Property(put)];'IsReversible=value' Regulatorcanusedifferentsettingsinthereversedirection.Usuallynotapplicabletosubstationtransformers.IsInverseTime [out,retval]Type:VARIANT_BOOL*Value;[Property(get)];'value=IsInverseTime' Timedelayisinverselyadjsuted,proportinaltotheamountofvoltageoutsidetheregulatingband.IsInverseTime [in]Type:VARIANT_BOOLValue;[Property(put)];'IsInverseTime=value' Timedelayisinverselyadjsuted,proportinaltotheamountofvoltageoutsidetheregulatingband.Delay [out,retval]Type:double*Value;[Property(get)];'value=Delay' Timedelay[s]afterarmingbeforethefirsttapchange.Controlmayresetbeforeactuallychangingtaps.Delay [in]Type:doubleValue;[Property(put)];'Delay=value' Timedelay[s]afterarmingbeforethefirsttapchange.Controlmayresetbeforeactuallychangingtaps.TapDelay [out,retval]Type:double*Value;[Property(get)];'value=TapDelay' Timedelay[s]forsubsequenttapchangesinaset.Controlmayresetbeforeactuallychangingtaps.TapDelay [in]Type:doubleValue;[Property(put)];'TapDelay=value' Timedelay[s]forsubsequenttapchangesinaset.Controlmayresetbefore

    45

  • actuallychangingtaps.MaxTapChange [out,retval]Type:long*Value;[Property(get)];'value=MaxTapChange' MaximumtapchangeperiterationinSTATICsolutionmode.1ismorerealistic,16isthedefaultforafastersoluiton.MaxTapChange [in]Type:longValue;[Property(put)];'MaxTapChange=value' MaximumtapchangeperiterationinSTATICsolutionmode.1ismorerealistic,16isthedefaultforafastersoluiton.VoltageLimit [out,retval]Type:double*Value;[Property(get)];'value=VoltageLimit' FirsthousevoltagelimitonPTsecondarybase.Settingto0disablesthisfunction.VoltageLimit [in]Type:doubleValue;[Property(put)];'VoltageLimit=value' FirsthousevoltagelimitonPTsecondarybase.Settingto0disablesthisfunction.ForwardBand [out,retval]Type:double*Value;[Property(get)];'value=ForwardBand' Regulationbandwidthinforwarddireciton,centeredonVregForwardBand [in]Type:doubleValue;[Property(put)];'ForwardBand=value' Regulationbandwidthinforwarddireciton,centeredonVregForwardVreg [out,retval]Type:double*Value;[Property(get)];'value=ForwardVreg' Targetvoltageintheforwarddirection,onPTsecondarybase.ForwardVreg [in]Type:doubleValue;[Property(put)];'ForwardVreg=value' Targetvoltageintheforwarddirection,onPTsecondarybase.ReverseBand [out,retval]Type:double*Value;[Property(get)];'value=ReverseBand' Bandwidthinreversedirection,centeredonreverseVreg.ReverseBand [in]Type:doubleValue;[Property(put)];'ReverseBand=value' Bandwidthinreversedirection,centeredonreverseVreg.ReverseVreg [out,retval]Type:double*Value;[Property(get)];'value=ReverseVreg' Targetvoltageintherevesedirection,onPTsecondarybase.ReverseVreg [in]Type:doubleValue;[Property(put)];'ReverseVreg=value' Targetvoltageintherevesedirection,onPTsecondarybase.Count [out,retval]Type:long*Value;[Property(get)];'value=Count' NumberofRegControlobjectsinActiveCircuitTapNumber [out,retval]Type:long*Value;[Property(get)];'value=TapNumber' (noHelpstringavailable)TapNumber [in]Type:longValue;[Property(put)];'TapNumber=value' Integernumberofthetapthatthecontrolledtransformerwindingiscurrentliyon.

    TopologyInterface

    46

  • NumLoops [out,retval]Type:long*Value;[Property(get)];'value=NumLoops' NumberofloopsNumIsolatedBranches [out,retval]Type:long*Value;[Property(get)];'value=NumIsolatedBranches' Numberofisolatedbranches(PDelementsandcapacitorsAllLoopedPairs [out,retval]Type:VARIANT*Value;[Property(get)];'value=AllLoopedPairs' Variantarrayofallloopedelementnames,bypairs.AllIsolatedBranches [out,retval]Type:VARIANT*Value;[Property(get)];'value=AllIsolatedBranches' Variantarrayofallisolatedbranchnames.NumIsolatedLoads [out,retval]Type:long*Value;[Property(get)];'value=NumIsolatedLoads' NumberofisolatedloadsAllIsolatedLoads [out,retval]Type:VARIANT*Value;[Property(get)];'value=AllIsolatedLoads' Variantarrayofallisolatedloadnames.BranchName [out,retval]Type:BSTR*Value;[Property(get)];'value=BranchName' Nameoftheactivebranch.BranchName [in]Type:BSTRValue;[Property(put)];'BranchName=value' (noHelpstringavailable)First [out,retval]Type:long*Value;[Property(get)];'value=First' Setsthefirstbranchactive,returns0ifnone.Next [out,retval]Type:long*Value;[Property(get)];'value=Next' Setsthenextbranchactive,returns0ifnomore.ActiveBranch [out,retval]Type:long*Value;[Property(get)];'value=ActiveBranch' ReturnsindexoftheactivebranchForwardBranch [out,retval]Type:long*Value;[Property(get)];'value=ForwardBranch' Moveforwardinthetree,returni