plc4go/spi/values/PlcList.go (146 lines of code) (raw):

/* * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * https://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. */ package values import ( "context" "encoding/binary" "fmt" "strings" "time" "github.com/pkg/errors" "github.com/rs/zerolog/log" apiValues "github.com/apache/plc4x/plc4go/pkg/api/values" "github.com/apache/plc4x/plc4go/spi/utils" ) type PlcList struct { Values []apiValues.PlcValue PlcValueAdapter } func NewPlcList(values []apiValues.PlcValue) PlcList { return PlcList{ Values: values, } } func singleOrAdapter[R any](plcList PlcList, f func(apiValues.PlcValue) R) R { if len(plcList.Values) == 1 { return f(plcList.Values[0]) } else { return f(plcList.PlcValueAdapter) } } //// // Simple Types func (m PlcList) IsSimple() bool { return singleOrAdapter(m, apiValues.PlcValue.IsSimple) } func (m PlcList) IsNullable() bool { return singleOrAdapter(m, apiValues.PlcValue.IsNullable) } func (m PlcList) IsNull() bool { return singleOrAdapter(m, apiValues.PlcValue.IsNull) } // /// //// // Boolean func (m PlcList) IsBool() bool { return singleOrAdapter(m, apiValues.PlcValue.IsBool) } func (m PlcList) GetBoolLength() uint32 { return singleOrAdapter(m, apiValues.PlcValue.GetBoolLength) } func (m PlcList) GetBool() bool { return singleOrAdapter(m, apiValues.PlcValue.GetBool) } func (m PlcList) GetBoolAt(index uint32) bool { return m.PlcValueAdapter.GetBoolAt(index) } func (m PlcList) GetBoolArray() []bool { return singleOrAdapter(m, apiValues.PlcValue.GetBoolArray) } // /// //// // Byte func (m PlcList) IsByte() bool { return singleOrAdapter(m, apiValues.PlcValue.IsByte) } func (m PlcList) GetByte() byte { return singleOrAdapter(m, apiValues.PlcValue.GetByte) } // /// //// // Integer func (m PlcList) IsUint8() bool { return singleOrAdapter(m, apiValues.PlcValue.IsUint8) } func (m PlcList) GetUint8() uint8 { return singleOrAdapter(m, apiValues.PlcValue.GetUint8) } func (m PlcList) IsUint16() bool { return singleOrAdapter(m, apiValues.PlcValue.IsUint16) } func (m PlcList) GetUint16() uint16 { return singleOrAdapter(m, apiValues.PlcValue.GetUint16) } func (m PlcList) IsUint32() bool { return singleOrAdapter(m, apiValues.PlcValue.IsUint32) } func (m PlcList) GetUint32() uint32 { return singleOrAdapter(m, apiValues.PlcValue.GetUint32) } func (m PlcList) IsUint64() bool { return singleOrAdapter(m, apiValues.PlcValue.IsUint64) } func (m PlcList) GetUint64() uint64 { return singleOrAdapter(m, apiValues.PlcValue.GetUint64) } func (m PlcList) IsInt8() bool { return singleOrAdapter(m, apiValues.PlcValue.IsInt8) } func (m PlcList) GetInt8() int8 { return singleOrAdapter(m, apiValues.PlcValue.GetInt8) } func (m PlcList) IsInt16() bool { return singleOrAdapter(m, apiValues.PlcValue.IsInt16) } func (m PlcList) GetInt16() int16 { return singleOrAdapter(m, apiValues.PlcValue.GetInt16) } func (m PlcList) IsInt32() bool { return singleOrAdapter(m, apiValues.PlcValue.IsInt32) } func (m PlcList) GetInt32() int32 { return singleOrAdapter(m, apiValues.PlcValue.GetInt32) } func (m PlcList) IsInt64() bool { return singleOrAdapter(m, apiValues.PlcValue.IsInt64) } func (m PlcList) GetInt64() int64 { return singleOrAdapter(m, apiValues.PlcValue.GetInt64) } // /// //// // Floating Point func (m PlcList) IsFloat32() bool { return singleOrAdapter(m, apiValues.PlcValue.IsFloat32) } func (m PlcList) GetFloat32() float32 { return singleOrAdapter(m, apiValues.PlcValue.GetFloat32) } func (m PlcList) IsFloat64() bool { return singleOrAdapter(m, apiValues.PlcValue.IsFloat64) } func (m PlcList) GetFloat64() float64 { return singleOrAdapter(m, apiValues.PlcValue.GetFloat64) } // /// //// // String func (m PlcList) IsString() bool { return singleOrAdapter(m, apiValues.PlcValue.IsString) } func (m PlcList) GetString() string { stringValues := make([]string, len(m.Values)) for i, v := range m.Values { stringValues[i] = v.GetString() } return strings.Join(stringValues, ", ") } // /// //// // Time func (m PlcList) IsTime() bool { return singleOrAdapter(m, apiValues.PlcValue.IsTime) } func (m PlcList) GetTime() time.Time { return singleOrAdapter(m, apiValues.PlcValue.GetTime) } func (m PlcList) IsDate() bool { return singleOrAdapter(m, apiValues.PlcValue.IsDate) } func (m PlcList) GetDate() time.Time { return singleOrAdapter(m, apiValues.PlcValue.GetDate) } func (m PlcList) IsDateTime() bool { return singleOrAdapter(m, apiValues.PlcValue.IsDateTime) } func (m PlcList) GetDateTime() time.Time { return singleOrAdapter(m, apiValues.PlcValue.GetDateTime) } // /// //// // Raw Access func (m PlcList) IsRaw() bool { return true } func (m PlcList) GetRaw() []byte { if theBytes, err := m.Serialize(); err != nil { log.Error().Err(err).Msg("Error getting raw") return nil } else { return theBytes } } // /// //// // List Methods func (m PlcList) IsList() bool { return true } func (m PlcList) GetLength() uint32 { return uint32(len(m.Values)) } func (m PlcList) GetIndex(i uint32) apiValues.PlcValue { return m.Values[i] } func (m PlcList) GetList() []apiValues.PlcValue { return m.Values } // /// //// // Struct Methods func (m PlcList) IsStruct() bool { return singleOrAdapter(m, apiValues.PlcValue.IsStruct) } func (m PlcList) GetKeys() []string { return singleOrAdapter(m, apiValues.PlcValue.GetKeys) } func (m PlcList) HasKey(key string) bool { if len(m.Values) == 1 { return m.Values[0].HasKey(key) } else { return m.PlcValueAdapter.HasKey(key) } } func (m PlcList) GetValue(key string) apiValues.PlcValue { if len(m.Values) == 1 { return m.Values[0].GetValue(key) } else { return m.PlcValueAdapter.GetValue(key) } } func (m PlcList) GetStruct() map[string]apiValues.PlcValue { return singleOrAdapter(m, apiValues.PlcValue.GetStruct) } // /// func (m PlcList) GetPlcValueType() apiValues.PlcValueType { return apiValues.List } func (m PlcList) Serialize() ([]byte, error) { wb := utils.NewWriteBufferByteBased(utils.WithByteOrderForByteBasedBuffer(binary.BigEndian)) if err := m.SerializeWithWriteBuffer(context.Background(), wb); err != nil { return nil, err } return wb.GetBytes(), nil } func (m PlcList) SerializeWithWriteBuffer(ctx context.Context, writeBuffer utils.WriteBuffer) error { if err := writeBuffer.PushContext("PlcList"); err != nil { return err } for _, listItem := range m.GetList() { if listItemSerializable, ok := listItem.(utils.Serializable); ok { if err := listItemSerializable.SerializeWithWriteBuffer(ctx, writeBuffer); err != nil { return err } } else { return errors.New("Error serializing. List item doesn't implement Serializable") } } if err := writeBuffer.PopContext("PlcList"); err != nil { return err } return nil } func (m PlcList) String() string { allBits := 0 // TODO: do we want to aggregate the bit length? return fmt.Sprintf("%s(%dbit):%v", m.GetPlcValueType(), allBits, m.Values) }