ClockType.go

// Package dlms implements DLMS/COSEM client and server functionality.
//
// The ClockType enumeration represents the different clock formats
// supported by DLMS devices. It is used when encoding or decoding
// time values exchanged with meters.
package dlms

//
// --------------------------------------------------------------------------
//  Gurux Ltd
//
//
//
// Filename:        $HeadURL$
//
// Version:         $Revision$,
//                  $Date$
//                  $Author$
//
// Copyright (c) Gurux Ltd
//
//---------------------------------------------------------------------------
//
//  DESCRIPTION
//
// This file is a part of Gurux Device Framework.
//
// Gurux Device Framework is Open Source software; you can redistribute it
// and/or modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; version 2 of the License.
// Gurux Device Framework is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
// See the GNU General Public License for more details.
//
// More information of Gurux products: https://www.gurux.org
//
// This code is licensed under the GNU General Public License v2.
// Full text may be retrieved at http://www.gnu.org/licenses/gpl-2.0.txt
//---------------------------------------------------------------------------

import (
	"fmt"
	"strings"

	"github.com/Gurux/gxcommon-go"
)

type ClockType int

const (
	// ClockTypeClock defines that the normal clock object.
	ClockTypeClock ClockType = iota
	// ClockTypeUnix defines that the unix time.
	ClockTypeUnix
	// ClockTypeHighResolution defines that the time in ms.
	ClockTypeHighResolution
)

// ClockTypeParse converts the given string into a ClockType value.
//
// It returns the corresponding ClockType constant if the string matches
// a known level name, or an error if the input is invalid.
func ClockTypeParse(value string) (ClockType, error) {
	var ret ClockType
	var err error
	switch strings.ToUpper(value) {
	case "CLOCK":
		ret = ClockTypeClock
	case "UNIX":
		ret = ClockTypeUnix
	case "HIGHRESOLUTION":
		ret = ClockTypeHighResolution
	default:
		err = fmt.Errorf("%w: %q", gxcommon.ErrUnknownEnum, value)
	}
	return ret, err
}

// String returns the canonical name of the ClockType.
// It satisfies fmt.Stringer.
func (g ClockType) String() string {
	var ret string
	switch g {
	case ClockTypeClock:
		ret = "CLOCK"
	case ClockTypeUnix:
		ret = "UNIX"
	case ClockTypeHighResolution:
		ret = "HIGHRESOLUTION"
	}
	return ret
}