feat(plc4go): added GetPLCValueType() PLCValueType to plc_value.go

apache · Aug 19, 2022 · 1f14f81 · 1f14f81
1 parent 2a860ce
commit 1f14f81
Show file tree

Hide file tree

Showing 34 changed files with 277 additions and 76 deletions.
diff --git a/plc4go/pkg/api/values/plc_value.go b/plc4go/pkg/api/values/plc_value.go
@@ -129,6 +129,8 @@ type PlcValue interface {
 	GetStruct() map[string]PlcValue
 	//
 	///
+
+	GetPLCValueType() PLCValueType
 }
 
 // RawPlcValue This type is used in cases where the driver doesn't have access to type information and therefore can't decode
@@ -144,3 +146,40 @@ type RawPlcValue interface {
 	// RawReset Reset the internal read-buffer (For the case that a raw plc-value has to be parsed multiple times)
 	RawReset()
 }
+
+type PLCValueType uint8
+
+const (
+	BINT PLCValueType = iota
+	BIT_STRING
+	BOOL
+	BREAL
+	BYTE
+	BYTE_ARRAY
+	CHAR
+	DATE
+	DATE_AND_TIME
+	DINT
+	DWORD
+	INT
+	LINT
+	LIST
+	LREAL
+	LTIME
+	LWORD
+	NULL
+	RAW_PLC_VALUE
+	REAL
+	STRUCT
+	SINT
+	STRING
+	TIME
+	TIME_OF_DAY
+	UDINT
+	UINT
+	USINT
+	ULINT
+	WCHAR
+	WORD
+	WSTRING
+)
diff --git a/plc4go/spi/values/BINT.go b/plc4go/spi/values/BINT.go
@@ -20,6 +20,7 @@
 package values
 
 import (
+	apiValues "github.com/apache/plc4x/plc4go/pkg/api/values"
 	"github.com/apache/plc4x/plc4go/spi/utils"
 	"math"
 	"math/big"
@@ -126,6 +127,10 @@ func (m PlcBINT) GetString() string {
 	return strconv.Itoa(int(m.GetInt64()))
 }
 
+func (m PlcBINT) GetPLCValueType() apiValues.PLCValueType {
+	return apiValues.BINT
+}
+
 func (m PlcBINT) isZero() bool {
 	return m.value.Cmp(big.NewInt(0)) == 0
 }

diff --git a/plc4go/spi/values/BOOL.go b/plc4go/spi/values/BOOL.go
@@ -19,7 +19,10 @@
 
 package values
 
-import "github.com/apache/plc4x/plc4go/spi/utils"
+import (
+	apiValues "github.com/apache/plc4x/plc4go/pkg/api/values"
+	"github.com/apache/plc4x/plc4go/spi/utils"
+)
 
 type PlcBOOL struct {
 	value bool
@@ -74,6 +77,10 @@ func (m PlcBOOL) GetString() string {
 	}
 }
 
+func (m PlcBOOL) GetPLCValueType() apiValues.PLCValueType {
+	return apiValues.BOOL
+}
+
 func (m PlcBOOL) Serialize(writeBuffer utils.WriteBuffer) error {
 	return writeBuffer.WriteBit("PlcBOOL", m.value)
 }
diff --git a/plc4go/spi/values/BREAL.go b/plc4go/spi/values/BREAL.go
@@ -21,6 +21,7 @@ package values
 
 import (
 	"fmt"
+	apiValues "github.com/apache/plc4x/plc4go/pkg/api/values"
 	"github.com/apache/plc4x/plc4go/spi/utils"
 	"math"
 	"math/big"
@@ -156,6 +157,10 @@ func (m PlcBREAL) GetString() string {
 	return fmt.Sprintf("%g", m.GetFloat64())
 }
 
+func (m PlcBREAL) GetPLCValueType() apiValues.PLCValueType {
+	return apiValues.BREAL
+}
+
 func (m PlcBREAL) isZero() bool {
 	return m.value.Cmp(big.NewFloat(0.0)) == 0.0
 }

diff --git a/plc4go/spi/values/BYTE.go b/plc4go/spi/values/BYTE.go
@@ -20,6 +20,7 @@
 package values
 
 import (
+	apiValues "github.com/apache/plc4x/plc4go/pkg/api/values"
 	"github.com/apache/plc4x/plc4go/spi/utils"
 )
 
@@ -98,6 +99,10 @@ func (m PlcBYTE) GetString() string {
 	return strVal
 }
 
+func (m PlcBYTE) GetPLCValueType() apiValues.PLCValueType {
+	return apiValues.BYTE
+}
+
 func (m PlcBYTE) Serialize(writeBuffer utils.WriteBuffer) error {
 	return writeBuffer.WriteByte("PlcBYTE", m.value)
 }
diff --git a/plc4go/spi/values/CHAR.go b/plc4go/spi/values/CHAR.go
@@ -20,6 +20,7 @@
 package values
 
 import (
+	apiValues "github.com/apache/plc4x/plc4go/pkg/api/values"
 	"github.com/apache/plc4x/plc4go/spi/utils"
 )
 
@@ -47,6 +48,10 @@ func (m PlcCHAR) GetString() string {
 	return string(m.value)
 }
 
+func (m PlcCHAR) GetPLCValueType() apiValues.PLCValueType {
+	return apiValues.CHAR
+}
+
 func (m PlcCHAR) Serialize(writeBuffer utils.WriteBuffer) error {
 	return writeBuffer.WriteString("PlcBYTE", 16, "UTF-8", string(m.value))
 }
diff --git a/plc4go/spi/values/DATE.go b/plc4go/spi/values/DATE.go
@@ -20,6 +20,7 @@
 package values
 
 import (
+	apiValues "github.com/apache/plc4x/plc4go/pkg/api/values"
 	"github.com/apache/plc4x/plc4go/spi/utils"
 	"time"
 )
@@ -66,6 +67,10 @@ func (m PlcDATE) GetString() string {
 	return m.GetDate().Format("2006-01-02")
 }
 
+func (m PlcDATE) GetPLCValueType() apiValues.PLCValueType {
+	return apiValues.DATE
+}
+
 func (m PlcDATE) Serialize(writeBuffer utils.WriteBuffer) error {
 	return writeBuffer.WriteString("PlcDATE", uint32(len([]rune(m.GetString()))*8), "UTF-8", m.GetString())
 }
diff --git a/plc4go/spi/values/DATE_AND_TIME.go b/plc4go/spi/values/DATE_AND_TIME.go
@@ -21,6 +21,7 @@ package values
 
 import (
 	"fmt"
+	apiValues "github.com/apache/plc4x/plc4go/pkg/api/values"
 	"github.com/apache/plc4x/plc4go/spi/utils"
 	"time"
 )
@@ -53,6 +54,10 @@ func (m PlcDATE_AND_TIME) GetString() string {
 	return fmt.Sprintf("%v", m.GetDateTime())
 }
 
+func (m PlcDATE_AND_TIME) GetPLCValueType() apiValues.PLCValueType {
+	return apiValues.DATE_AND_TIME
+}
+
 func (m PlcDATE_AND_TIME) Serialize(writeBuffer utils.WriteBuffer) error {
 	return writeBuffer.WriteString("PlcDATE_AND_TIME", uint32(len([]rune(m.GetString()))*8), "UTF-8", m.GetString())
 }
diff --git a/plc4go/spi/values/DINT.go b/plc4go/spi/values/DINT.go
@@ -20,6 +20,7 @@
 package values
 
 import (
+	apiValues "github.com/apache/plc4x/plc4go/pkg/api/values"
 	"github.com/apache/plc4x/plc4go/spi/utils"
 	"math"
 	"strconv"
@@ -137,6 +138,10 @@ func (m PlcDINT) GetString() string {
 	return strconv.Itoa(int(m.GetInt64()))
 }
 
+func (m PlcDINT) GetPLCValueType() apiValues.PLCValueType {
+	return apiValues.DINT
+}
+
 func (m PlcDINT) Serialize(writeBuffer utils.WriteBuffer) error {
 	return writeBuffer.WriteInt32("PlcDINT", 32, m.value)
 }
diff --git a/plc4go/spi/values/DWORD.go b/plc4go/spi/values/DWORD.go
@@ -20,6 +20,7 @@
 package values
 
 import (
+	apiValues "github.com/apache/plc4x/plc4go/pkg/api/values"
 	"github.com/apache/plc4x/plc4go/spi/utils"
 )
 
@@ -97,6 +98,10 @@ func (m PlcDWORD) GetString() string {
 	return strVal
 }
 
+func (m PlcDWORD) GetPLCValueType() apiValues.PLCValueType {
+	return apiValues.DWORD
+}
+
 func (m PlcDWORD) Serialize(writeBuffer utils.WriteBuffer) error {
 	return writeBuffer.WriteUint32("PlcDINT", 32, m.value)
 }
diff --git a/plc4go/spi/values/INT.go b/plc4go/spi/values/INT.go
@@ -20,6 +20,7 @@
 package values
 
 import (
+	apiValues "github.com/apache/plc4x/plc4go/pkg/api/values"
 	"github.com/apache/plc4x/plc4go/spi/utils"
 	"math"
 	"strconv"
@@ -130,6 +131,10 @@ func (m PlcINT) GetString() string {
 	return strconv.Itoa(int(m.GetInt64()))
 }
 
+func (m PlcINT) GetPLCValueType() apiValues.PLCValueType {
+	return apiValues.INT
+}
+
 func (m PlcINT) Serialize(writeBuffer utils.WriteBuffer) error {
 	return writeBuffer.WriteInt16("PlcINT", 16, m.value)
 }
diff --git a/plc4go/spi/values/LINT.go b/plc4go/spi/values/LINT.go
@@ -20,6 +20,7 @@
 package values
 
 import (
+	apiValues "github.com/apache/plc4x/plc4go/pkg/api/values"
 	"github.com/apache/plc4x/plc4go/spi/utils"
 	"math"
 	"strconv"
@@ -144,6 +145,10 @@ func (m PlcLINT) GetString() string {
 	return strconv.Itoa(int(m.GetInt64()))
 }
 
+func (m PlcLINT) GetPLCValueType() apiValues.PLCValueType {
+	return apiValues.LINT
+}
+
 func (m PlcLINT) Serialize(writeBuffer utils.WriteBuffer) error {
 	return writeBuffer.WriteInt64("PlcLINT", 64, m.value)
 }
diff --git a/plc4go/spi/values/LREAL.go b/plc4go/spi/values/LREAL.go
@@ -21,6 +21,7 @@ package values
 
 import (
 	"fmt"
+	apiValues "github.com/apache/plc4x/plc4go/pkg/api/values"
 	"github.com/apache/plc4x/plc4go/spi/utils"
 	"math"
 )
@@ -160,6 +161,10 @@ func (m PlcLREAL) GetString() string {
 	return fmt.Sprintf("%g", m.GetFloat64())
 }
 
+func (m PlcLREAL) GetPLCValueType() apiValues.PLCValueType {
+	return apiValues.LREAL
+}
+
 func (m PlcLREAL) Serialize(writeBuffer utils.WriteBuffer) error {
 	return writeBuffer.WriteFloat64("PlcLREAL", 64, m.value)
 }
diff --git a/plc4go/spi/values/LTIME.go b/plc4go/spi/values/LTIME.go
@@ -21,6 +21,7 @@ package values
 
 import (
 	"fmt"
+	apiValues "github.com/apache/plc4x/plc4go/pkg/api/values"
 	"github.com/apache/plc4x/plc4go/spi/utils"
 	"time"
 )
@@ -58,6 +59,10 @@ func (m PlcLTIME) GetString() string {
 	return fmt.Sprintf("PT%0.fS", m.GetDuration().Seconds())
 }
 
+func (m PlcLTIME) GetPLCValueType() apiValues.PLCValueType {
+	return apiValues.LTIME
+}
+
 func (m PlcLTIME) Serialize(writeBuffer utils.WriteBuffer) error {
 	return writeBuffer.WriteString("PlcLTIME", uint32(len([]rune(m.GetString()))*8), "UTF-8", m.GetString())
 }
diff --git a/plc4go/spi/values/LWORD.go b/plc4go/spi/values/LWORD.go
@@ -20,6 +20,7 @@
 package values
 
 import (
+	apiValues "github.com/apache/plc4x/plc4go/pkg/api/values"
 	"github.com/apache/plc4x/plc4go/spi/utils"
 )
 
@@ -113,6 +114,10 @@ func (m PlcLWORD) GetString() string {
 	return strVal
 }
 
+func (m PlcLWORD) GetPLCValueType() apiValues.PLCValueType {
+	return apiValues.LWORD
+}
+
 func (m PlcLWORD) Serialize(writeBuffer utils.WriteBuffer) error {
 	return writeBuffer.WriteUint64("PlcLWORD", 64, m.value)
 }
diff --git a/plc4go/spi/values/NULL.go b/plc4go/spi/values/NULL.go
@@ -19,6 +19,8 @@
 
 package values
 
+import apiValues "github.com/apache/plc4x/plc4go/pkg/api/values"
+
 type PlcNULL struct {
 	PlcValueAdapter
 }
@@ -30,3 +32,7 @@ func NewPlcNULL() PlcNULL {
 func (m PlcNULL) GetRaw() []byte {
 	return []byte{}
 }
+
+func (m PlcNULL) GetPLCValueType() apiValues.PLCValueType {
+	return apiValues.NULL
+}
diff --git a/plc4go/spi/values/PlcBitString.go b/plc4go/spi/values/PlcBitString.go
@@ -20,7 +20,7 @@
 package values
 
 import (
-	api "github.com/apache/plc4x/plc4go/pkg/api/values"
+	apiValues "github.com/apache/plc4x/plc4go/pkg/api/values"
 	"github.com/apache/plc4x/plc4go/spi/utils"
 )
 
@@ -29,25 +29,25 @@ type PlcBitString struct {
 }
 
 func NewPlcBitString(value interface{}) PlcBitString {
-	var bools []api.PlcValue
+	var bools []apiValues.PlcValue
 	switch value.(type) {
 	case uint8:
-		bools = make([]api.PlcValue, 8)
+		bools = make([]apiValues.PlcValue, 8)
 		for i := 0; i < 8; i++ {
 			bools[i] = NewPlcBOOL(((value.(uint8) >> uint8((8-1)-i)) & 0x01) == 0x01)
 		}
 	case uint16:
-		bools = make([]api.PlcValue, 16)
+		bools = make([]apiValues.PlcValue, 16)
 		for i := 0; i < 16; i++ {
 			bools[i] = NewPlcBOOL(((value.(uint16) >> uint8((16-1)-i)) & 0x01) == 0x01)
 		}
 	case uint32:
-		bools = make([]api.PlcValue, 32)
+		bools = make([]apiValues.PlcValue, 32)
 		for i := 0; i < 32; i++ {
 			bools[i] = NewPlcBOOL(((value.(uint32) >> uint8((32-1)-i)) & 0x01) == 0x01)
 		}
 	case uint64:
-		bools = make([]api.PlcValue, 64)
+		bools = make([]apiValues.PlcValue, 64)
 		for i := 0; i < 64; i++ {
 			bools[i] = NewPlcBOOL(((value.(uint64) >> uint8((64-1)-i)) & 0x01) == 0x01)
 		}
@@ -72,10 +72,14 @@ func (m PlcBitString) GetLength() uint32 {
 	return uint32(len(m.Values))
 }
 
-func (m PlcBitString) GetIndex(i uint32) api.PlcValue {
+func (m PlcBitString) GetIndex(i uint32) apiValues.PlcValue {
 	return m.Values[i]
 }
 
-func (m PlcBitString) GetList() []api.PlcValue {
+func (m PlcBitString) GetList() []apiValues.PlcValue {
 	return m.Values
 }
+
+func (m PlcBitString) GetPLCValueType() apiValues.PLCValueType {
+	return apiValues.BIT_STRING
+}