blob: 8c1bb13f69f2585bbe60679a033a09d1939ae7c3 [file]
/*
* 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 model
import (
"context"
"encoding/binary"
stdErrors "errors"
"fmt"
"github.com/rs/zerolog"
"github.com/apache/plc4x/plc4go/spi/codegen"
. "github.com/apache/plc4x/plc4go/spi/codegen/fields"
. "github.com/apache/plc4x/plc4go/spi/codegen/io"
"github.com/apache/plc4x/plc4go/spi/errors"
"github.com/apache/plc4x/plc4go/spi/utils"
)
// Code generated by code-generation. DO NOT EDIT.
// AdsTableSizes is the corresponding interface of AdsTableSizes
type AdsTableSizes interface {
fmt.Stringer
utils.LengthAware
utils.Serializable
utils.Copyable
// GetSymbolCount returns SymbolCount (property field)
GetSymbolCount() uint32
// GetSymbolLength returns SymbolLength (property field)
GetSymbolLength() uint32
// GetDataTypeCount returns DataTypeCount (property field)
GetDataTypeCount() uint32
// GetDataTypeLength returns DataTypeLength (property field)
GetDataTypeLength() uint32
// GetAliasCount returns AliasCount (property field)
GetAliasCount() uint32
// GetAliasLength returns AliasLength (property field)
GetAliasLength() uint32
// IsAdsTableSizes is a marker method to prevent unintentional type checks (interfaces of same signature)
IsAdsTableSizes()
// CreateBuilder creates a AdsTableSizesBuilder
CreateAdsTableSizesBuilder() AdsTableSizesBuilder
}
// _AdsTableSizes is the data-structure of this message
type _AdsTableSizes struct {
SymbolCount uint32
SymbolLength uint32
DataTypeCount uint32
DataTypeLength uint32
AliasCount uint32
AliasLength uint32
}
var _ AdsTableSizes = (*_AdsTableSizes)(nil)
// NewAdsTableSizes factory function for _AdsTableSizes
func NewAdsTableSizes(symbolCount uint32, symbolLength uint32, dataTypeCount uint32, dataTypeLength uint32, aliasCount uint32, aliasLength uint32) *_AdsTableSizes {
return &_AdsTableSizes{SymbolCount: symbolCount, SymbolLength: symbolLength, DataTypeCount: dataTypeCount, DataTypeLength: dataTypeLength, AliasCount: aliasCount, AliasLength: aliasLength}
}
///////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////
/////////////////////// Builder
///////////////////////
// AdsTableSizesBuilder is a builder for AdsTableSizes
type AdsTableSizesBuilder interface {
utils.Copyable
// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
WithMandatoryFields(symbolCount uint32, symbolLength uint32, dataTypeCount uint32, dataTypeLength uint32, aliasCount uint32, aliasLength uint32) AdsTableSizesBuilder
// WithSymbolCount adds SymbolCount (property field)
WithSymbolCount(uint32) AdsTableSizesBuilder
// WithSymbolLength adds SymbolLength (property field)
WithSymbolLength(uint32) AdsTableSizesBuilder
// WithDataTypeCount adds DataTypeCount (property field)
WithDataTypeCount(uint32) AdsTableSizesBuilder
// WithDataTypeLength adds DataTypeLength (property field)
WithDataTypeLength(uint32) AdsTableSizesBuilder
// WithAliasCount adds AliasCount (property field)
WithAliasCount(uint32) AdsTableSizesBuilder
// WithAliasLength adds AliasLength (property field)
WithAliasLength(uint32) AdsTableSizesBuilder
// Build builds the AdsTableSizes or returns an error if something is wrong
Build() (AdsTableSizes, error)
// MustBuild does the same as Build but panics on error
MustBuild() AdsTableSizes
}
// NewAdsTableSizesBuilder() creates a AdsTableSizesBuilder
func NewAdsTableSizesBuilder() AdsTableSizesBuilder {
return &_AdsTableSizesBuilder{_AdsTableSizes: new(_AdsTableSizes)}
}
type _AdsTableSizesBuilder struct {
*_AdsTableSizes
collectedErr []error
}
var _ (AdsTableSizesBuilder) = (*_AdsTableSizesBuilder)(nil)
func (b *_AdsTableSizesBuilder) WithMandatoryFields(symbolCount uint32, symbolLength uint32, dataTypeCount uint32, dataTypeLength uint32, aliasCount uint32, aliasLength uint32) AdsTableSizesBuilder {
return b.WithSymbolCount(symbolCount).WithSymbolLength(symbolLength).WithDataTypeCount(dataTypeCount).WithDataTypeLength(dataTypeLength).WithAliasCount(aliasCount).WithAliasLength(aliasLength)
}
func (b *_AdsTableSizesBuilder) WithSymbolCount(symbolCount uint32) AdsTableSizesBuilder {
b.SymbolCount = symbolCount
return b
}
func (b *_AdsTableSizesBuilder) WithSymbolLength(symbolLength uint32) AdsTableSizesBuilder {
b.SymbolLength = symbolLength
return b
}
func (b *_AdsTableSizesBuilder) WithDataTypeCount(dataTypeCount uint32) AdsTableSizesBuilder {
b.DataTypeCount = dataTypeCount
return b
}
func (b *_AdsTableSizesBuilder) WithDataTypeLength(dataTypeLength uint32) AdsTableSizesBuilder {
b.DataTypeLength = dataTypeLength
return b
}
func (b *_AdsTableSizesBuilder) WithAliasCount(aliasCount uint32) AdsTableSizesBuilder {
b.AliasCount = aliasCount
return b
}
func (b *_AdsTableSizesBuilder) WithAliasLength(aliasLength uint32) AdsTableSizesBuilder {
b.AliasLength = aliasLength
return b
}
func (b *_AdsTableSizesBuilder) Build() (AdsTableSizes, error) {
if err := stdErrors.Join(b.collectedErr...); err != nil {
return nil, errors.Wrap(err, "error occurred during build")
}
return b._AdsTableSizes.deepCopy(), nil
}
func (b *_AdsTableSizesBuilder) MustBuild() AdsTableSizes {
build, err := b.Build()
if err != nil {
panic(err)
}
return build
}
func (b *_AdsTableSizesBuilder) DeepCopy() any {
_copy := b.CreateAdsTableSizesBuilder().(*_AdsTableSizesBuilder)
if b.collectedErr != nil {
copy(_copy.collectedErr, b.collectedErr)
}
return _copy
}
// CreateAdsTableSizesBuilder creates a AdsTableSizesBuilder
func (b *_AdsTableSizes) CreateAdsTableSizesBuilder() AdsTableSizesBuilder {
if b == nil {
return NewAdsTableSizesBuilder()
}
return &_AdsTableSizesBuilder{_AdsTableSizes: b.deepCopy()}
}
///////////////////////
///////////////////////
///////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////
/////////////////////// Accessors for property fields.
///////////////////////
func (m *_AdsTableSizes) GetSymbolCount() uint32 {
return m.SymbolCount
}
func (m *_AdsTableSizes) GetSymbolLength() uint32 {
return m.SymbolLength
}
func (m *_AdsTableSizes) GetDataTypeCount() uint32 {
return m.DataTypeCount
}
func (m *_AdsTableSizes) GetDataTypeLength() uint32 {
return m.DataTypeLength
}
func (m *_AdsTableSizes) GetAliasCount() uint32 {
return m.AliasCount
}
func (m *_AdsTableSizes) GetAliasLength() uint32 {
return m.AliasLength
}
///////////////////////
///////////////////////
///////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////
// Deprecated: use the interface for direct cast
func CastAdsTableSizes(structType any) AdsTableSizes {
if casted, ok := structType.(AdsTableSizes); ok {
return casted
}
if casted, ok := structType.(*AdsTableSizes); ok {
return *casted
}
return nil
}
func (m *_AdsTableSizes) GetPlx4xTypeName() string {
return "AdsTableSizes"
}
func (m *_AdsTableSizes) GetLengthInBits(ctx context.Context) uint16 {
lengthInBits := uint16(0)
// Simple field (symbolCount)
lengthInBits += 32
// Simple field (symbolLength)
lengthInBits += 32
// Simple field (dataTypeCount)
lengthInBits += 32
// Simple field (dataTypeLength)
lengthInBits += 32
// Simple field (aliasCount)
lengthInBits += 32
// Simple field (aliasLength)
lengthInBits += 32
return lengthInBits
}
func (m *_AdsTableSizes) GetLengthInBytes(ctx context.Context) uint16 {
return m.GetLengthInBits(ctx) / 8
}
func AdsTableSizesParse(ctx context.Context, theBytes []byte) (AdsTableSizes, error) {
return AdsTableSizesParseWithBuffer(ctx, utils.NewReadBufferByteBased(theBytes, utils.WithByteOrderForReadBufferByteBased(binary.LittleEndian)))
}
func AdsTableSizesParseWithBufferProducer() func(ctx context.Context, readBuffer utils.ReadBuffer) (AdsTableSizes, error) {
return func(ctx context.Context, readBuffer utils.ReadBuffer) (AdsTableSizes, error) {
return AdsTableSizesParseWithBuffer(ctx, readBuffer)
}
}
func AdsTableSizesParseWithBuffer(ctx context.Context, readBuffer utils.ReadBuffer) (AdsTableSizes, error) {
v, err := (new(_AdsTableSizes)).parse(ctx, readBuffer)
if err != nil {
return nil, err
}
return v, nil
}
func (m *_AdsTableSizes) parse(ctx context.Context, readBuffer utils.ReadBuffer) (__adsTableSizes AdsTableSizes, err error) {
positionAware := readBuffer
_ = positionAware
if pullErr := readBuffer.PullContext("AdsTableSizes"); pullErr != nil {
return nil, errors.Wrap(pullErr, "Error pulling for AdsTableSizes")
}
currentPos := positionAware.GetPos()
_ = currentPos
symbolCount, err := ReadSimpleField(ctx, "symbolCount", ReadUnsignedInt(readBuffer, uint8(32)), codegen.WithByteOrder(binary.LittleEndian))
if err != nil {
return nil, errors.Wrap(err, fmt.Sprintf("Error parsing 'symbolCount' field"))
}
m.SymbolCount = symbolCount
symbolLength, err := ReadSimpleField(ctx, "symbolLength", ReadUnsignedInt(readBuffer, uint8(32)), codegen.WithByteOrder(binary.LittleEndian))
if err != nil {
return nil, errors.Wrap(err, fmt.Sprintf("Error parsing 'symbolLength' field"))
}
m.SymbolLength = symbolLength
dataTypeCount, err := ReadSimpleField(ctx, "dataTypeCount", ReadUnsignedInt(readBuffer, uint8(32)), codegen.WithByteOrder(binary.LittleEndian))
if err != nil {
return nil, errors.Wrap(err, fmt.Sprintf("Error parsing 'dataTypeCount' field"))
}
m.DataTypeCount = dataTypeCount
dataTypeLength, err := ReadSimpleField(ctx, "dataTypeLength", ReadUnsignedInt(readBuffer, uint8(32)), codegen.WithByteOrder(binary.LittleEndian))
if err != nil {
return nil, errors.Wrap(err, fmt.Sprintf("Error parsing 'dataTypeLength' field"))
}
m.DataTypeLength = dataTypeLength
aliasCount, err := ReadSimpleField(ctx, "aliasCount", ReadUnsignedInt(readBuffer, uint8(32)), codegen.WithByteOrder(binary.LittleEndian))
if err != nil {
return nil, errors.Wrap(err, fmt.Sprintf("Error parsing 'aliasCount' field"))
}
m.AliasCount = aliasCount
aliasLength, err := ReadSimpleField(ctx, "aliasLength", ReadUnsignedInt(readBuffer, uint8(32)), codegen.WithByteOrder(binary.LittleEndian))
if err != nil {
return nil, errors.Wrap(err, fmt.Sprintf("Error parsing 'aliasLength' field"))
}
m.AliasLength = aliasLength
if closeErr := readBuffer.CloseContext("AdsTableSizes"); closeErr != nil {
return nil, errors.Wrap(closeErr, "Error closing for AdsTableSizes")
}
return m, nil
}
func (m *_AdsTableSizes) Serialize() ([]byte, error) {
wb := utils.NewWriteBufferByteBased(utils.WithInitialSizeForByteBasedBuffer(int(m.GetLengthInBytes(context.Background()))), utils.WithByteOrderForByteBasedBuffer(binary.LittleEndian))
if err := m.SerializeWithWriteBuffer(context.Background(), wb); err != nil {
return nil, err
}
return wb.GetBytes(), nil
}
func (m *_AdsTableSizes) SerializeWithWriteBuffer(ctx context.Context, writeBuffer utils.WriteBuffer) error {
positionAware := writeBuffer
_ = positionAware
log := zerolog.Ctx(ctx)
_ = log
if pushErr := writeBuffer.PushContext("AdsTableSizes"); pushErr != nil {
return errors.Wrap(pushErr, "Error pushing for AdsTableSizes")
}
if err := WriteSimpleField[uint32](ctx, "symbolCount", m.GetSymbolCount(), WriteUnsignedInt(writeBuffer, 32), codegen.WithByteOrder(binary.LittleEndian)); err != nil {
return errors.Wrap(err, "Error serializing 'symbolCount' field")
}
if err := WriteSimpleField[uint32](ctx, "symbolLength", m.GetSymbolLength(), WriteUnsignedInt(writeBuffer, 32), codegen.WithByteOrder(binary.LittleEndian)); err != nil {
return errors.Wrap(err, "Error serializing 'symbolLength' field")
}
if err := WriteSimpleField[uint32](ctx, "dataTypeCount", m.GetDataTypeCount(), WriteUnsignedInt(writeBuffer, 32), codegen.WithByteOrder(binary.LittleEndian)); err != nil {
return errors.Wrap(err, "Error serializing 'dataTypeCount' field")
}
if err := WriteSimpleField[uint32](ctx, "dataTypeLength", m.GetDataTypeLength(), WriteUnsignedInt(writeBuffer, 32), codegen.WithByteOrder(binary.LittleEndian)); err != nil {
return errors.Wrap(err, "Error serializing 'dataTypeLength' field")
}
if err := WriteSimpleField[uint32](ctx, "aliasCount", m.GetAliasCount(), WriteUnsignedInt(writeBuffer, 32), codegen.WithByteOrder(binary.LittleEndian)); err != nil {
return errors.Wrap(err, "Error serializing 'aliasCount' field")
}
if err := WriteSimpleField[uint32](ctx, "aliasLength", m.GetAliasLength(), WriteUnsignedInt(writeBuffer, 32), codegen.WithByteOrder(binary.LittleEndian)); err != nil {
return errors.Wrap(err, "Error serializing 'aliasLength' field")
}
if popErr := writeBuffer.PopContext("AdsTableSizes"); popErr != nil {
return errors.Wrap(popErr, "Error popping for AdsTableSizes")
}
return nil
}
func (m *_AdsTableSizes) IsAdsTableSizes() {}
func (m *_AdsTableSizes) DeepCopy() any {
return m.deepCopy()
}
func (m *_AdsTableSizes) deepCopy() *_AdsTableSizes {
if m == nil {
return nil
}
_AdsTableSizesCopy := &_AdsTableSizes{
m.SymbolCount,
m.SymbolLength,
m.DataTypeCount,
m.DataTypeLength,
m.AliasCount,
m.AliasLength,
}
return _AdsTableSizesCopy
}
func (m *_AdsTableSizes) String() string {
if m == nil {
return "<nil>"
}
wb := utils.NewWriteBufferBoxBased(
utils.WithWriteBufferBoxBasedMergeSingleBoxes(),
utils.WithWriteBufferBoxBasedOmitEmptyBoxes(),
utils.WithWriteBufferBoxBasedPrintPosLengthFooter(),
)
if err := wb.WriteSerializable(context.Background(), m); err != nil {
return err.Error()
}
return wb.GetBox().String()
}