model

Documentation

Overview

Package model provides data structures and helper functions for loading common Oneliner equipment models.

Index

• type Bus
  • func GetBus(c *goolx.Client, hnd int) (*Bus, error)

Types

type Bus

type Bus struct {
	HND       int     // ASPEN Oneliner equipment handle
	Name      string  // BUSsName
	KVNominal float64 // BUSdKVnominal
	Number    int     // BUSnNumber
	Area      int     // BUSnArea
	Zone      int     // BUSnZone
	Tap       int     // BUSnTapBus
	Comment   string  // BUSsComment (aka Memo field)
}

Bus represents a bus equipment data structure. This does not represent all fields from ASPEN model, future fields may be added as needed.

func GetBus

func GetBus(c *goolx.Client, hnd int) (*Bus, error)

GetBus retrieves the bus with the given handle using the provided api client. Data is Scanned into a new bus object and returned if no errors.