README
¶
Overview
goolx is an unofficial Go wrapper around ASPEN's Oneliner API. It can be utilized to create programs which interact with Oneliner through the provided API functions. Additionally, it provides helper functions for common analysis tasks.
The goal of this module is to provide generic unopinionated abstractions for fault analysis. These functions can be used as a building block for useful fault analysis application development.
This library is in Version 0.x.x, and may have breaking API changes during development.
Installation
It is required users of this Go module have authorized licenses for the underlying ASPEN software v15.4 or newer. Obtaining this third-party software is outside the scope of this README.
The module can be installed using the following go get
command.
go get -u github.com/readpe/goolx
This library is only designed for use on Windows 386 architecture. To properly build, ensure your GOOS
and GOARCH
environment variables are set appropriately:
GOOS=windows
GARCH=386
Usage Example
import (
"fmt"
"log"
"github.com/readpe/goolx"
"github.com/readpe/goolx/constants"
"github.com/readpe/goolx/model"
)
func main() {
c := goolx.NewClient()
defer c.Release() // releases api dll at function return
// Print the olxapi info.
info := c.Info()
fmt.Println(info)
// Load a oneliner case into memory.
err := c.LoadDataFile("system.olr")
if err != nil {
log.Fatal(err)
}
// Loop through all buses in case using NextEquipment iterator.
buses := c.NextEquipment(constants.TCBus)
for buses.Next() {
hnd := buses.Hnd()
// Get bus data
b, err := model.GetBus(c, hnd)
if err != nil {
log.Println(fmt.Errorf("could not get bus data: %v", err))
continue
}
fmt.Printf("found bus %s %fkV with handle: %d", b.Name, b.KVNominal, b.HND)
}
}
Disclaimer
This project is not endorsed or affiliated with ASPEN Inc.
Acknowledgements
Thanks to ASPEN Inc. for providing the Python API which inspired the development of this module.
Documentation
¶
Index ¶
- Constants
- type Client
- func (c *Client) BuildNumber() (int, error)
- func (c *Client) CloseDataFile() error
- func (c *Client) DeleteEquipment(hnd int) error
- func (c *Client) DoFault(hnd int, config *FaultConfig) error
- func (c *Client) DoSteppedEvent(hnd int, cfg *SteppedEventConfig) error
- func (c *Client) EquipmentType(hnd int) (int, error)
- func (c *Client) FaultDescription(index int) string
- func (c *Client) FindBusByName(name string, kv float64) (int, error)
- func (c *Client) FindBusNo(n int) (int, error)
- func (c *Client) GetData(hnd int, tokens ...int) Data
- func (c *Client) GetSCCurrentPhase(hnd int) (Ia, Ib, Ic Phasor, err error)
- func (c *Client) GetSCCurrentSeq(hnd int) (I0, I1, I2 Phasor, err error)
- func (c *Client) GetSCVoltagePhase(hnd int) (Va, Vb, Vc Phasor, err error)
- func (c *Client) GetSCVoltageSeq(hnd int) (V0, V1, V2 Phasor, err error)
- func (c *Client) GetSteppedEvent(step int) (SteppedEvent, error)
- func (c *Client) Info() string
- func (c *Client) LoadDataFile(name string) error
- func (c *Client) MemoAppend(hnd int, s string) error
- func (c *Client) MemoContains(hnd int, substr string) bool
- func (c *Client) MemoGet(hnd int) (string, error)
- func (c *Client) MemoReplaceAll(hnd int, old, new string) error
- func (c *Client) MemoSet(hnd int, memo string) error
- func (c *Client) NextBusEquipment(busHnd, eqType int) HandleIterator
- func (c *Client) NextEquipment(eqType int) HandleIterator
- func (c *Client) NextEquipmentByTag(eqType int, tags ...string) HandleIterator
- func (c *Client) NextFault(tiers int) FaultIterator
- func (c *Client) NextRelay(rlyGroupHnd int) HandleIterator
- func (c *Client) NextSteppedEvent() *NextSteppedEvent
- func (c *Client) PickFault(indx, tiers int) error
- func (c *Client) ReadChangeFile(name string) error
- func (c *Client) Release() error
- func (c *Client) SaveDataFile(name string) error
- func (c *Client) TagReplace(hnd int, oldTag, newTag string) error
- func (c *Client) TagsAppend(hnd int, newTags ...string) error
- func (c *Client) TagsGet(hnd int) (tags []string, err error)
- func (c *Client) TagsSet(hnd int, tags ...string) error
- func (c *Client) Version() (string, error)
- type Data
- type FaultConfig
- type FaultIterator
- type FaultOption
- func FaultClearPrev(e bool) FaultOption
- func FaultCloseIn() FaultOption
- func FaultCloseInEndOpen() FaultOption
- func FaultCloseInEndOpenOutage(outageList []int, otgOpt OutageOption) FaultOption
- func FaultCloseInOutage(outageList []int, otgOpt OutageOption) FaultOption
- func FaultConn(conn ...FltConn) FaultOption
- func FaultIntermediate(percent float64) FaultOption
- func FaultIntermediateAuto(step, from, to float64) FaultOption
- func FaultIntermediateEndOpen(percent float64) FaultOption
- func FaultIntermediateEndOpenOutage(percent float64, outageList []int, otgOpt OutageOption) FaultOption
- func FaultIntermediateOutage(percent float64, outageList []int, otgOpt OutageOption) FaultOption
- func FaultLineEnd() FaultOption
- func FaultLineEndOutage(outageList []int, otgOpt OutageOption) FaultOption
- func FaultOptions(options ...FaultOption) FaultOption
- func FaultRX(r, x float64) FaultOption
- func FaultRemoteBus() FaultOption
- func FaultRemoteBusOutage(outageList []int, otgOpt OutageOption) FaultOption
- type FltConn
- type HandleIterator
- type NextBusEquipment
- type NextEquipment
- type NextEquipmentByTag
- type NextFault
- type NextRelay
- type NextSteppedEvent
- type OutageOption
- type Phasor
- type SteppedEvent
- type SteppedEventConfig
- type SteppedEventOption
- func SteppedEventAll() SteppedEventOption
- func SteppedEventCloseIn() SteppedEventOption
- func SteppedEventConn(conn FltConn) SteppedEventOption
- func SteppedEventDSGnd() SteppedEventOption
- func SteppedEventDSPh() SteppedEventOption
- func SteppedEventDiffRelay() SteppedEventOption
- func SteppedEventIntermediate(percent float64) SteppedEventOption
- func SteppedEventLogicScheme() SteppedEventOption
- func SteppedEventLogicVoltRelay() SteppedEventOption
- func SteppedEventOCGnd() SteppedEventOption
- func SteppedEventOCPh() SteppedEventOption
- func SteppedEventOptions(options ...SteppedEventOption) SteppedEventOption
- func SteppedEventRX(r, x float64) SteppedEventOption
- func SteppedEventTiers(n int) SteppedEventOption
Examples ¶
Constants ¶
const ( OnelinerVersionSupported = 15.4 OnelinerBuildSupported = 17321 )
Supported Oneliner Version/Build
const ( KiB = 1 << (10 * 1) MiB = 1 << (10 * 2) )
Byte size constants
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client represents a new goolx api client.
func (*Client) BuildNumber ¶
BuildNumber parses the build number from the olxapi.dll info function.
func (*Client) CloseDataFile ¶ added in v0.0.4
CloseDataFile closes the currently loaded *.olr data file.
func (*Client) DeleteEquipment ¶ added in v0.0.4
DeleteEquipment deletes the equipment with the provided handle.
func (*Client) DoFault ¶ added in v0.0.3
func (c *Client) DoFault(hnd int, config *FaultConfig) error
DoFault runs a fault for the given equipment handle with the providedfault configurations. PickFault or NextFault must be called prior to accessing results data.
func (*Client) DoSteppedEvent ¶ added in v0.0.4
func (c *Client) DoSteppedEvent(hnd int, cfg *SteppedEventConfig) error
DoSteppedEvent runs a stepped event analysis for the given equipment with the provided config parameters.
func (*Client) EquipmentType ¶
EquipmentType returns the equipment type code for the equipment with the provided handle
func (*Client) FaultDescription ¶ added in v0.0.4
FaultDescription returns the fault description string for the specified index.
func (*Client) FindBusByName ¶ added in v0.0.4
FindBusByName returns the bus handle for the given bus name and kv, if found
func (*Client) FindBusNo ¶
FindBusNo returns the bus with the provided bus number. Or returns 0 and an error if not found.
func (*Client) GetData ¶
GetData returns data for the object handle, and all parameter tokens provided. The data for each token can be retrieved using the Scan method on the Data type. This is similar to the Row.Scan in the sql package.
func (*Client) GetSCCurrentPhase ¶ added in v0.0.9
GetSCCurrentPhase gets the short circuit phase current for the equipment with the provided handle. Returns Ia, Ib, Ic Phasor types. PickFault must be called first.
func (*Client) GetSCCurrentSeq ¶ added in v0.0.9
GetSCCurrentSeq gets the short circuit sequence current for the equipment with the provided handle. Returns I0, I1, I2 Phasor types. PickFault must be called first.
func (*Client) GetSCVoltagePhase ¶ added in v0.0.8
GetSCVoltagePhase gets the short circuit phase voltage for the equipment with the provided handle. Returns Va, Vb, Vc Phasor types. PickFault must be called first.
func (*Client) GetSCVoltageSeq ¶ added in v0.0.8
GetSCVoltageSeq gets the short circuit sequence voltagse for the equipment with the provided handle. Returns V0, V1, V2 Phasor types.
func (*Client) GetSteppedEvent ¶ added in v0.0.9
func (c *Client) GetSteppedEvent(step int) (SteppedEvent, error)
GetSteppedEvent gets the stepped event data for the provided step. Returns an error if step index is out of range.
func (*Client) LoadDataFile ¶
LoadDataFile loads *.olr file from disk
func (*Client) MemoAppend ¶ added in v0.0.9
MemoAppend appends a new line followed by s to the object memo field.
func (*Client) MemoContains ¶ added in v0.0.9
MemoContains reports whether substr is within the objects memo field.
func (*Client) MemoReplaceAll ¶ added in v0.0.9
MemoReplaceAll replaces all non-overlapping instances of old replaced by new in the object memo field.
func (*Client) MemoSet ¶ added in v0.0.9
MemoSet sets the object memo field, overwrites existing data.
func (*Client) NextBusEquipment ¶ added in v0.0.7
func (c *Client) NextBusEquipment(busHnd, eqType int) HandleIterator
NextBusEquipment returns an EquipmentIterator type. The EquipmentIterator will loop through all equipment handles at the provided bus in the case until it reaches the end. This is done using the Next() and Hnd() methods. See NextEquipment for more details.
func (*Client) NextEquipment ¶
func (c *Client) NextEquipment(eqType int) HandleIterator
NextEquipment returns an EquipmentIterator type. The EquipmentIterator will loop through all equipment handles in the case until it reaches the end. This is done using the Next() and Hnd() methods. Note: ASPEN equipment handle integers are not unique and are generated on data access. Therefore care should be taken when using handle across functions or applications. It is recommended to use the handle immediately after retrieving to get unique equipment identifiers.
func (*Client) NextEquipmentByTag ¶
func (c *Client) NextEquipmentByTag(eqType int, tags ...string) HandleIterator
NextEquipmentByTag returns a NextEquipmentTag type which satisfies the HandleIterator interface.
func (*Client) NextFault ¶ added in v0.0.9
func (c *Client) NextFault(tiers int) FaultIterator
NextFault returns a fault index iterator for looping through fault results. Will perform a PickFault function call for each fault simulation result.
func (*Client) NextRelay ¶ added in v0.0.7
func (c *Client) NextRelay(rlyGroupHnd int) HandleIterator
NextRelay returns an HandleIterator type. The HandleIterator will loop through all relay handles in the provided relay group until it reaches the end. This is done using the Next() and Hnd() methods. Note: ASPEN equipment handle integers are not unique and are generated on data access. Therefore care should be taken when using handle across functions or applications. It is recommended to use the handle immediately after retrieving to get unique equipment identifiers.
func (*Client) NextSteppedEvent ¶ added in v0.0.9
func (c *Client) NextSteppedEvent() *NextSteppedEvent
func (*Client) PickFault ¶ added in v0.0.8
PickFault must be called before accessing short circuit simulation data. The given index and number of tiers to be calculated are provided. See NextFault for an iterator which automatically switches from SFFirst to SFNext after the first fault until the last.
The index codes are: SFLast = -1 SFNext = -2 SFFirst = 1 SFPrevious = -4
func (*Client) ReadChangeFile ¶
ReadChangeFile reads *.chf file from disk and applies to case
func (*Client) SaveDataFile ¶
SaveDataFile saves *.olr file to disk
func (*Client) TagReplace ¶ added in v0.0.9
TagReplace replaces all occurences of the old tag with the new tag provided.
func (*Client) TagsAppend ¶ added in v0.0.9
TagsAppend appends the provided tags to the object tag string. Does not check for duplicate tags
func (*Client) TagsGet ¶ added in v0.0.9
TagsGet returns a slice of tag strings for the equipment with the provided handle.
type Data ¶
type Data struct {
// contains filtered or unexported fields
}
Data represents data returned via the GetData method.
func (Data) Scan ¶
Scan copies the data from the matched parameter token into the values pointed at by dest. The order of the destination pointers should match the parameters queried with GetData. Will return an error if any parameters produced an error during GetData call. Data will not be populated in this case.
Example ¶
Output: Name: TENNESSEE kV: 132.00
type FaultConfig ¶ added in v0.0.3
type FaultConfig struct {
// contains filtered or unexported fields
}
FaultConfig represents configuration parameters required to run the Oneliner DoFault procedure. Options are configured by passing one or more of the FaultOption functions provided into the NewFaultConfig function.
func New1LGFaultConfig ¶ added in v0.0.3
func New1LGFaultConfig() *FaultConfig
New1LGFaultConfig is a helper function to return a new 1LG FaultConfig instance. See NewFaultConfig for more specifics.
func New3LGFaultConfig ¶ added in v0.0.3
func New3LGFaultConfig() *FaultConfig
New3LGFaultConfig is a helper function to return a new 3LG FaultConfig instance. See NewFaultConfig for more specifics.
func NewFaultConfig ¶ added in v0.0.3
func NewFaultConfig(options ...FaultOption) *FaultConfig
NewFaultConfig returns a pointer to a new instance of FaultConfig for use with the Oneliner DoFault procedure. Provide FaultOption functions to modify the underlying parameters.
type FaultIterator ¶ added in v0.0.9
FaultIterator is a iterator interface for fault results.
type FaultOption ¶ added in v0.0.4
type FaultOption func(*FaultConfig)
FaultOption represents configuration modification functions to apply to the FaultConfig data.
func FaultClearPrev ¶ added in v0.0.3
func FaultClearPrev(e bool) FaultOption
FaultClearPrev sets the clear previous flag. True will clear the previous fault results.
func FaultCloseIn ¶ added in v0.0.3
func FaultCloseIn() FaultOption
FaultCloseIn applies a close-in fault.
func FaultCloseInEndOpen ¶ added in v0.0.4
func FaultCloseInEndOpen() FaultOption
FaultCloseInEndOpen applies a close-in fault with the end open as determined by the Oneliner algorithm for determining the end of the line.
func FaultCloseInEndOpenOutage ¶ added in v0.0.4
func FaultCloseInEndOpenOutage(outageList []int, otgOpt OutageOption) FaultOption
FaultCloseInEndOpenOutage applies a close-in fault with outages and the end open as determined by the Oneliner algorithm for determining the end of the line. An outage list and options are required.
func FaultCloseInOutage ¶ added in v0.0.4
func FaultCloseInOutage(outageList []int, otgOpt OutageOption) FaultOption
FaultCloseInOutage applies a close-in fault with outages on the system. An outage list and options are required.
func FaultConn ¶ added in v0.0.3
func FaultConn(conn ...FltConn) FaultOption
FaultConn applies the provided fault connections. Overrides the previous fault connections.
func FaultIntermediate ¶ added in v0.0.4
func FaultIntermediate(percent float64) FaultOption
FaultIntermediate applies an intermediate fault at the provided percentage.
func FaultIntermediateAuto ¶ added in v0.0.4
func FaultIntermediateAuto(step, from, to float64) FaultOption
FaultIntermediateAuto applies an auto sequencing intermediate fault between from and to at the specified step.
func FaultIntermediateEndOpen ¶ added in v0.0.4
func FaultIntermediateEndOpen(percent float64) FaultOption
FaultIntermediate applies an intermediate fault with at the provided percentage with the end open.
func FaultIntermediateEndOpenOutage ¶ added in v0.0.4
func FaultIntermediateEndOpenOutage(percent float64, outageList []int, otgOpt OutageOption) FaultOption
FaultIntermediateEndOpenOutage applies an intermediate fault with at the provided percentage with the end open and outages. An outage list and options are required.
func FaultIntermediateOutage ¶ added in v0.0.4
func FaultIntermediateOutage(percent float64, outageList []int, otgOpt OutageOption) FaultOption
FaultIntermediate applies an intermediate fault with outage at the provided percentage. An outage list and options are required.
func FaultLineEnd ¶ added in v0.0.4
func FaultLineEnd() FaultOption
FaultLineEnd applies a line end fault, as determined by Oneliners algorithm for determining line end.
func FaultLineEndOutage ¶ added in v0.0.4
func FaultLineEndOutage(outageList []int, otgOpt OutageOption) FaultOption
FaultLineEndOutage applies a line end fault with outages. Line end is determined by Oneliners algorithm for determining line end. An outage list and options are required.
func FaultOptions ¶ added in v0.0.5
func FaultOptions(options ...FaultOption) FaultOption
FaultOptions consolidates a list of FaultOptions to a single FaultOption.
func FaultRX ¶ added in v0.0.3
func FaultRX(r, x float64) FaultOption
FaultRX sets the fault impedance in Ohms.
func FaultRemoteBus ¶ added in v0.0.4
func FaultRemoteBus() FaultOption
FaultRemoteBus applies a remote bus fault.
func FaultRemoteBusOutage ¶ added in v0.0.4
func FaultRemoteBusOutage(outageList []int, otgOpt OutageOption) FaultOption
FaultRemoteBusOutage applies a remote bus fault with outages. An outage list and options are required.
type FltConn ¶ added in v0.0.5
type FltConn int
FltConn represents a fault connection for use with the DoFault procedure. The codes are applied to FaultConfig and SteppedEventConfig as specified in ASPEN Oneliner documentation.
type HandleIterator ¶
HandleIterator is a iterator interface for equipment handles.
type NextBusEquipment ¶ added in v0.0.7
type NextBusEquipment struct {
// contains filtered or unexported fields
}
NextBusEquipment is an equipment handle iterator for getting the next equipment handle of the provided type at the specified bus. The Next() method will retrieve the next handle if available and populate it for access by Hnd(). If Next() returns false, then there was an error or the list was exhausted. Once the iterator is exhausted it cannot be reused.
func (*NextBusEquipment) Hnd ¶ added in v0.0.7
func (n *NextBusEquipment) Hnd() int
Hnd returns the current equipment handle, Next() must be called first.
func (*NextBusEquipment) Next ¶ added in v0.0.7
func (n *NextBusEquipment) Next() bool
Next retrieves the next equipment handle of type at the specified bus. Returns true if successful, and false if not. Hnd() should not be used if Next() is false. This can be used in for loops.
type NextEquipment ¶
type NextEquipment struct {
// contains filtered or unexported fields
}
NextEquipment is an equipment handle iterator for getting the next equipment handle of the provided type. The Next() method will retrieve the next handle if available and populate it for access by Hnd(). If Next() returns false, then there was an error or the list was exhausted. Once the iterator is exhausted it cannot be reused.
func (*NextEquipment) Hnd ¶
func (n *NextEquipment) Hnd() int
Hnd returns the current equipment handle, Next() must be called first.
func (*NextEquipment) Next ¶
func (n *NextEquipment) Next() bool
Next retrieves the next equipment handle of type. Returns true if successful, and false if not. Hnd() should not be used if Next() is false. This can be used in for loops.
type NextEquipmentByTag ¶
type NextEquipmentByTag struct {
// contains filtered or unexported fields
}
NextEquipmentByTag is an equipment handle iterator for getting the next equipment handle of the provided type with the listed tags. The Next() method will retrieve the next handle if available and populate it for access by Hnd(). If Next() returns false, then there was an error or the list was exhausted. Once the iterator is exhausted it cannot be reused.
func (*NextEquipmentByTag) Hnd ¶
func (n *NextEquipmentByTag) Hnd() int
Hnd returns the current equipment handle, Next() must be called first.
func (*NextEquipmentByTag) Next ¶
func (n *NextEquipmentByTag) Next() bool
Next retrieves the next equipment handle of type. Returns true if successful, and false if not. Hnd() should not be used if Next() is false. This can be used in for loops.
type NextFault ¶ added in v0.0.9
type NextFault struct {
// contains filtered or unexported fields
}
NextFault is a fault iterator for iterating through the available fault results, utilizing the PickFault function. Iterator may be reused after calling Reset method.
func (*NextFault) Indx ¶ added in v0.0.9
Indx returns the current picked fault index. Must only be called following a successful call to the Next method.
type NextRelay ¶ added in v0.0.7
type NextRelay struct {
// contains filtered or unexported fields
}
NextRelay is an handle iterator for getting the next relay handle in the provided relay group. The Next() method will retrieve the next handle if available and populate it for access by Hnd(). If Next() returns false, then there was an error or the list was exhausted. Once the iterator is exhausted it cannot be reused.
type NextSteppedEvent ¶ added in v0.0.9
type NextSteppedEvent struct {
// contains filtered or unexported fields
}
NextSteppedEvent is a stepped event result iterator for iterating through the available fault results, utilizing the GetSteppedEvent function. Iterator may be reused after calling Reset method.
func (*NextSteppedEvent) Data ¶ added in v0.0.9
func (n *NextSteppedEvent) Data() SteppedEvent
Data returns the underlying SteppedEvent data, must follow a successfull call to the Next method.
func (*NextSteppedEvent) Indx ¶ added in v0.0.9
func (n *NextSteppedEvent) Indx() int
Indx returns the current stepped event step index. Must only be called following a successful call to the Next method.
func (*NextSteppedEvent) Next ¶ added in v0.0.9
func (n *NextSteppedEvent) Next() bool
Next picks the next fault using GetSteppedEvent function. Returns true if successfull.
func (*NextSteppedEvent) Reset ¶ added in v0.0.9
func (n *NextSteppedEvent) Reset()
Reset resets the NextSteppedEvent iterator for reuse.
type OutageOption ¶ added in v0.0.3
type OutageOption int
OutageOption represents a the method outages are applied with use in the DoFault procedure.
const ( OutageOptionOnePer OutageOption = iota // One at a time OutageOptionTwoPer // Two at a time OutageOptionAll // All at once OutageOptionBF // Breaker failure )
type Phasor ¶ added in v0.0.8
type Phasor complex128
Phasor represents a phasor value for common power system calculations.
func PhaseToSeq ¶ added in v0.0.8
PhaseToSeq converts from phase values to sequential components. Three phase only.
func SeqToPhase ¶ added in v0.0.8
SeqToPhase converts from sequential compoents to phase values. Three phase only.
func (Phasor) Rect ¶ added in v0.0.8
func (p Phasor) Rect() complex128
Rect returns the complex128 representation.
type SteppedEvent ¶ added in v0.0.9
type SteppedEvent struct { Step int UserEvent bool Time float64 Current float64 EventDescription string FaultDescription string }
SteppedEvent represents the stepped event result data returned by GetSteppedEvent function.
type SteppedEventConfig ¶ added in v0.0.4
type SteppedEventConfig struct {
// contains filtered or unexported fields
}
SteppedEventConfig represents the configuration options for running stepped event analysis, for use with DoSteppedEvent function.
func NewSteppedEvent ¶ added in v0.0.4
func NewSteppedEvent(options ...SteppedEventOption) *SteppedEventConfig
NewSteppedEvent returns a new SteppedEventConfig instance with the applied options. The default number of tiers is 3, this can be changed using the SteppedEventTiers option.
type SteppedEventOption ¶ added in v0.0.4
type SteppedEventOption func(cfg *SteppedEventConfig)
SteppedEventOption represents a function to modify the SteppedEventConfig options.
func SteppedEventAll ¶ added in v0.0.4
func SteppedEventAll() SteppedEventOption
SteppedEventAll option enabled checking all relay types during stepped event simulation.
func SteppedEventCloseIn ¶ added in v0.0.4
func SteppedEventCloseIn() SteppedEventOption
SteppedEventCloseIn applies a close-in fault by setting the intermediate to 0.
func SteppedEventConn ¶ added in v0.0.4
func SteppedEventConn(conn FltConn) SteppedEventOption
SteppedEventConn sets the fault connection code.
func SteppedEventDSGnd ¶ added in v0.0.4
func SteppedEventDSGnd() SteppedEventOption
SteppedEventDSGnd option enables ground distance relays during stepped event simulation.
func SteppedEventDSPh ¶ added in v0.0.4
func SteppedEventDSPh() SteppedEventOption
SteppedEventDSPh option enables phase distance relays during stepped event simulation.
func SteppedEventDiffRelay ¶ added in v0.0.4
func SteppedEventDiffRelay() SteppedEventOption
SteppedEventDiffRelay option enables differential relays during stepped event simulation.
func SteppedEventIntermediate ¶ added in v0.0.4
func SteppedEventIntermediate(percent float64) SteppedEventOption
SteppedEventIntermediate applies an intermediate fault at the given percentage.
func SteppedEventLogicScheme ¶ added in v0.0.4
func SteppedEventLogicScheme() SteppedEventOption
SteppedEventLogicScheme option enables protection schemes during stepped event simulation.
func SteppedEventLogicVoltRelay ¶ added in v0.0.4
func SteppedEventLogicVoltRelay() SteppedEventOption
SteppedEventLogicVoltRelay option enables voltage relays during stepped event simulation.
func SteppedEventOCGnd ¶ added in v0.0.4
func SteppedEventOCGnd() SteppedEventOption
SteppedEventOCGnd option enables ground overcurrent relays during stepped event simulation.
func SteppedEventOCPh ¶ added in v0.0.4
func SteppedEventOCPh() SteppedEventOption
SteppedEventOCPh option enables phase overcurrent relays during stepped event simulation.
func SteppedEventOptions ¶ added in v0.0.4
func SteppedEventOptions(options ...SteppedEventOption) SteppedEventOption
SteppedEventOptions consolidates a list of SteppedEventOption's into a single SteppedEventOption.
func SteppedEventRX ¶ added in v0.0.4
func SteppedEventRX(r, x float64) SteppedEventOption
SteppedEventRX sets the stepped event fault impedance.
func SteppedEventTiers ¶ added in v0.0.4
func SteppedEventTiers(n int) SteppedEventOption
SteppedEventTiers option sets the number of tiers from the initiating equipment to be evaluated.