-
Notifications
You must be signed in to change notification settings - Fork 0
/
region.go
195 lines (174 loc) · 3.86 KB
/
region.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
// Package region provides access to region information used by AEMO.
package region
import (
"fmt"
"strings"
)
const (
// RegionUndefined is the undefined region.
RegionUndefined Region = iota
// RegionAAT is the AAT.
RegionAAT
// RegionACT is the ACT.
RegionACT
// RegionNSW is NSW.
RegionNSW
// RegionNT is the NT.
RegionNT
// RegionQLD is QLD.
RegionQLD
// RegionSA is SA.
RegionSA
// RegionTAS is RegionTAS.
RegionTAS
// RegionVIC is VIC.
RegionVIC
// RegionWA is WA.
RegionWA
)
var (
// RegionName mapping Region to the string.
RegionName = map[Region]string{ //nolint:gochecknoglobals
RegionUndefined: "UNDEFINED",
RegionAAT: "AAT",
RegionACT: "ACT",
RegionNSW: "NSW",
RegionNT: "NT",
RegionQLD: "QLD",
RegionSA: "SA",
RegionTAS: "TAS",
RegionVIC: "VIC",
RegionWA: "WA",
}
// RegionValue mapping string of a Region to the Region.
RegionValue = map[string]Region{ //nolint:gochecknoglobals
"UNDEFINED": RegionUndefined,
"AAT": RegionAAT,
"ACT": RegionACT,
"NSW": RegionNSW,
"NT": RegionNT,
"QLD": RegionQLD,
"SA": RegionSA,
"TAS": RegionTAS,
"VIC": RegionVIC,
"WA": RegionWA,
}
regions = []Region{ //nolint:gochecknoglobals
RegionUndefined,
RegionAAT,
RegionACT,
RegionNSW,
RegionNT,
RegionQLD,
RegionSA,
RegionTAS,
RegionVIC,
RegionWA,
}
regionLongNames = []string{ //nolint:gochecknoglobals
"Undefined",
"Australian Antarctic Territory",
"Australian Capital Territory",
"New South Wales",
"Northern Territory",
"Queensland",
"South Australia",
"Tasmania",
"Victoria",
"Western Australia",
}
regionNames = []string{ //nolint:gochecknoglobals
"UNDEFINED",
"AAT",
"ACT",
"NSW",
"NT",
"QLD",
"SA",
"TAS",
"VIC",
"WA",
}
regionMarketNodes = []Region{ //nolint:gochecknoglobals
RegionUndefined,
RegionUndefined,
RegionNSW,
RegionNSW,
RegionNT,
RegionQLD,
RegionSA,
RegionTAS,
RegionVIC,
RegionWA,
}
regionISOCodes = []string{ //nolint:gochecknoglobals
"UNDEFINED",
"UNDEFINED",
"AU-ACT",
"AU-NSW",
"AU-NT",
"AU-QLD",
"AU-SA",
"AU-TAS",
"AU-VIC",
"AU-WA",
}
)
// Region represents one of the regions that AEMO operates in.
type Region int32
// Info holds a structured set of data for a region.
type Info struct {
Region Region `json:"-"`
MarketNode Region `json:"marketNode"`
Name string `json:"name"`
LongName string `json:"longName"`
ISOCode string `json:"isoCode"`
}
// NewRegion returns a region for a string (matching short name).
func NewRegion(s string) (Region, error) {
r, ok := RegionValue[strings.ToUpper(s)]
if !ok {
return RegionUndefined, ErrRegionInvalid
}
return r, nil
}
// Regions returns all valid regions.
func Regions() []Region {
return regions[1:]
}
// GoString meets the gostring interface.
func (r Region) GoString() string {
return fmt.Sprintf(
"{Region: %d, MarketNode: %q, Name: %q, LongName: %q, ISOCode: %q}",
r, r.MarketNode().Name(), r.Name(), r.LongName(), r.ISOCode(),
)
}
// Info struct for a region.
func (r Region) Info() (*Info, error) {
if r == RegionUndefined {
return nil, fmt.Errorf("region '%d': %w", r, ErrRegionInvalid)
}
return &Info{
Region: r,
MarketNode: regionMarketNodes[r],
Name: regionNames[r],
LongName: regionLongNames[r],
ISOCode: regionISOCodes[r],
}, nil
}
// MarketNode returns the market node fo the region.
func (r Region) MarketNode() Region {
return regions[regionMarketNodes[r]]
}
// Name returns the name of the region.
func (r Region) Name() string {
return regionNames[r]
}
// LongName returns the long (full) name of the region.
func (r Region) LongName() string {
return regionLongNames[r]
}
// ISOCode returns the ISO code of the region.
func (r Region) ISOCode() string {
return regionISOCodes[r]
}