generated

Documentation

Index

• func TransformToValidID(value string) string
• type Commodity
• type CommodityQuantity
• type ControlType
• type Currency
• type EnergyManagementRole
• type ID
  • func NewID() (*ID, error)
• type InstructionStatus
• type ReceptionStatusValues
• type RevokableObject
• type RoleType
• type SessionRequestType

Functions

func TransformToValidID

func TransformToValidID(value string) string

TransformToValidID transforms a string into a valid ID type

Types

type Commodity

type Commodity string

const (
	GAS         Commodity = "GAS"
	HEAT        Commodity = "HEAT"
	ELECTRICITY Commodity = "ELECTRICITY"
	OIL         Commodity = "OIL"
)

type CommodityQuantity

type CommodityQuantity string

const (
	ELECTRIC_POWER_L1                CommodityQuantity = "ELECTRIC.POWER.L1"
	ELECTRIC_POWER_L2                CommodityQuantity = "ELECTRIC.POWER.L2"
	ELECTRIC_POWER_L3                CommodityQuantity = "ELECTRIC.POWER.L3"
	ELECTRIC_POWER_3_PHASE_SYMMETRIC CommodityQuantity = "ELECTRIC.POWER.3_PHASE_SYMMETRIC"
	NATURAL_GAS_FLOW_RATE            CommodityQuantity = "NATURAL_GAS.FLOW_RATE"
	HYDROGEN_FLOW_RATE               CommodityQuantity = "HYDROGEN.FLOW_RATE"
	HEAT_TEMPERATURE                 CommodityQuantity = "HEAT.TEMPERATURE"
	HEAT_FLOW_RATE                   CommodityQuantity = "HEAT.FLOW_RATE"
	HEAT_THERMAL_POWER               CommodityQuantity = "HEAT.THERMAL_POWER"
	OIL_FLOW_RATE                    CommodityQuantity = "OIL.FLOW_RATE"
)

type ControlType

type ControlType string

const (
	POWER_ENVELOPE_BASED_CONTROL ControlType = "POWER_ENVELOPE_BASED_CONTROL"
	POWER_PROFILE_BASED_CONTROL  ControlType = "POWER_PROFILE_BASED_CONTROL"
	OPERATION_MODE_BASED_CONTROL ControlType = "OPERATION_MODE_BASED_CONTROL"
	FILL_RATE_BASED_CONTROL      ControlType = "FILL_RATE_BASED_CONTROL"
	DEMAND_DRIVEN_BASED_CONTROL  ControlType = "DEMAND_DRIVEN_BASED_CONTROL"
	NOT_CONTROLABLE              ControlType = "NOT_CONTROLABLE"
	NO_SELECTION                 ControlType = "NO_SELECTION"
)

type Currency

type Currency string

const (
	AED Currency = "AED"
	ANG Currency = "ANG"
	AUD Currency = "AUD"
	CHE Currency = "CHE"
	CHF Currency = "CHF"
	CHW Currency = "CHW"
	EUR Currency = "EUR"
	GBP Currency = "GBP"
	LBP Currency = "LBP"
	LKR Currency = "LKR"
	LRD Currency = "LRD"
	LSL Currency = "LSL"
	LYD Currency = "LYD"
	MAD Currency = "MAD"
	MDL Currency = "MDL"
	MGA Currency = "MGA"
	MKD Currency = "MKD"
	MMK Currency = "MMK"
	MNT Currency = "MNT"
	MOP Currency = "MOP"
	MRO Currency = "MRO"
	MUR Currency = "MUR"
	MVR Currency = "MVR"
	MWK Currency = "MWK"
	MXN Currency = "MXN"
	MXV Currency = "MXV"
	MYR Currency = "MYR"
	MZN Currency = "MZN"
	NAD Currency = "NAD"
	NGN Currency = "NGN"
	NIO Currency = "NIO"
	NOK Currency = "NOK"
	NPR Currency = "NPR"
	NZD Currency = "NZD"
	OMR Currency = "OMR"
	PAB Currency = "PAB"
	PEN Currency = "PEN"
	PGK Currency = "PGK"
	PHP Currency = "PHP"
	PKR Currency = "PKR"
	PLN Currency = "PLN"
	PYG Currency = "PYG"
	QAR Currency = "QAR"
	RON Currency = "RON"
	RSD Currency = "RSD"
	RUB Currency = "RUB"
	RWF Currency = "RWF"
	SAR Currency = "SAR"
	SBD Currency = "SBD"
	SCR Currency = "SCR"
	SDG Currency = "SDG"
	SEK Currency = "SEK"
	SGD Currency = "SGD"
	SHP Currency = "SHP"
	SLL Currency = "SLL"
	SOS Currency = "SOS"
	SRD Currency = "SRD"
	SSP Currency = "SSP"
	STD Currency = "STD"
	SYP Currency = "SYP"
	SZL Currency = "SZL"
	THB Currency = "THB"
	TJS Currency = "TJS"
	TMT Currency = "TMT"
	TND Currency = "TND"
	TOP Currency = "TOP"
	TRY Currency = "TRY"
	TTD Currency = "TTD"
	TWD Currency = "TWD"
	TZS Currency = "TZS"
	UAH Currency = "UAH"
	UGX Currency = "UGX"
	USD Currency = "USD"
	USN Currency = "USN"
	UYI Currency = "UYI"
	UYU Currency = "UYU"
	UZS Currency = "UZS"
	VEF Currency = "VEF"
	VND Currency = "VND"
	VUV Currency = "VUV"
	WST Currency = "WST"
	XAG Currency = "XAG"
	XAU Currency = "XAU"
	XBA Currency = "XBA"
	XBB Currency = "XBB"
	XBC Currency = "XBC"
	XBD Currency = "XBD"
	XCD Currency = "XCD"
	XOF Currency = "XOF"
	XPD Currency = "XPD"
	XPF Currency = "XPF"
	XPT Currency = "XPT"
	XSU Currency = "XSU"
	XUA Currency = "XUA"
	XXX Currency = "XXX"
	YER Currency = "YER"
	ZAR Currency = "ZAR"
	ZMW Currency = "ZMW"
	ZWL Currency = "ZWL"
)

type EnergyManagementRole

type EnergyManagementRole string

const (
	CEM EnergyManagementRole = "CEM" // Types are added in case of changes in the future. With them omitted it would work the same way.
	RM  EnergyManagementRole = "RM"
)

type ID

type ID struct {
	Value string `json:"value" description:"An identifier expressed as a UUID"`
}

ID represents an identifier expressed as a UUID.

func NewID

func NewID() (*ID, error)

NewID creates a new ID following the specific pattern.

type InstructionStatus

type InstructionStatus string

const (
	NEW      InstructionStatus = "NEW"
	ACCEPTED InstructionStatus = "ACCEPTED"
	REJECTED InstructionStatus = "REJECTED"
	REVOKED  InstructionStatus = "REVOKED"
	STARTED  InstructionStatus = "STARTED"
	SUCCEDED InstructionStatus = "SUCCEDED"
	ABORTED  InstructionStatus = "ABORTED"
)

type ReceptionStatusValues

type ReceptionStatusValues string

const (
	INVALID_DATA    ReceptionStatusValues = "INVALID_DATA"
	INVALID_MESSAGE ReceptionStatusValues = "INVALID_MESSAGE"
	INVALID_CONTENT ReceptionStatusValues = "INVALID_CONTENT"
	TEMPORARY_ERROR ReceptionStatusValues = "TEMPORARY_ERROR"
	PERMANENT_ERROR ReceptionStatusValues = "PERMANENT_ERROR"
	OK              ReceptionStatusValues = "OK"
)

type RevokableObject

type RevokableObject string

const (
	PEBC_PowerConstraints             RevokableObject = "PEBC.PowerConstraints"
	PEBC_EnergyConstraint             RevokableObject = "PEBC.EnergyConstraint"
	PEBC_Instruction                  RevokableObject = "PEBC.Instruction"
	PPBC_PowerProfileDefinition       RevokableObject = "PPBC.PowerProfileDefinition"
	PPBC_ScheduleInstruction          RevokableObject = "PPBC.ScheduleInstruction"
	PPBC_StartInterruptionInstruction RevokableObject = "PPBC.StartInterruptionInstruction"
	PPBC_EndInterruptionInstruction   RevokableObject = "PPBC.EndInterruptionInstruction"
	OMBC_SystemDescription            RevokableObject = "OMBC.SystemDescription"
	OMBC_Instruction                  RevokableObject = "OMBC.Instruction"
	FRBC_SystemDescription            RevokableObject = "FRBC.SystemDescription"
	FRBC_Instruction                  RevokableObject = "FRBC.Instruction"
	DDBC_SystemDescription            RevokableObject = "DDBC.SystemDescription"
	DDBC_Instruction                  RevokableObject = "DDBC.Instruction"
)

type RoleType

type RoleType string

const (
	ENERGY_PRODUCER RoleType = "ENERGY_PRODUCER"
	ENERGY_CONSUMER RoleType = "ENERGY_CONSUMER"
	ENERGY_STORAGE  RoleType = "ENERGY_STORAGE"
)

type SessionRequestType

type SessionRequestType string

const (
	RECONNECT SessionRequestType = "RECONNECT"
	TERMINATE SessionRequestType = "TERMINATE"
)