plc4go/protocols/ads/readwrite/model/AdsNotificationSample.go

/*
 * 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"
	stdErrors "errors"
	"fmt"

	"github.com/rs/zerolog"

	. "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.

// AdsNotificationSample is the corresponding interface of AdsNotificationSample
type AdsNotificationSample interface {
	fmt.Stringer
	utils.LengthAware
	utils.Serializable
	utils.Copyable
	// GetNotificationHandle returns NotificationHandle (property field)
	// 4 bytes	Handle of notification
	GetNotificationHandle() uint32
	// GetSampleSize returns SampleSize (property field)
	// 4 Bytes	Size of data range in bytes.
	GetSampleSize() uint32
	// GetData returns Data (property field)
	// n Bytes	Data
	GetData() []byte
	// IsAdsNotificationSample is a marker method to prevent unintentional type checks (interfaces of same signature)
	IsAdsNotificationSample()
	// CreateBuilder creates a AdsNotificationSampleBuilder
	CreateAdsNotificationSampleBuilder() AdsNotificationSampleBuilder
}

// _AdsNotificationSample is the data-structure of this message
type _AdsNotificationSample struct {
	NotificationHandle uint32
	SampleSize         uint32
	Data               []byte
}

var _ AdsNotificationSample = (*_AdsNotificationSample)(nil)

// NewAdsNotificationSample factory function for _AdsNotificationSample
func NewAdsNotificationSample(notificationHandle uint32, sampleSize uint32, data []byte) *_AdsNotificationSample {
	return &_AdsNotificationSample{NotificationHandle: notificationHandle, SampleSize: sampleSize, Data: data}
}

///////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////
/////////////////////// Builder
///////////////////////

// AdsNotificationSampleBuilder is a builder for AdsNotificationSample
type AdsNotificationSampleBuilder interface {
	utils.Copyable
	// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
	WithMandatoryFields(notificationHandle uint32, sampleSize uint32, data []byte) AdsNotificationSampleBuilder
	// WithNotificationHandle adds NotificationHandle (property field)
	WithNotificationHandle(uint32) AdsNotificationSampleBuilder
	// WithSampleSize adds SampleSize (property field)
	WithSampleSize(uint32) AdsNotificationSampleBuilder
	// WithData adds Data (property field)
	WithData(...byte) AdsNotificationSampleBuilder
	// Build builds the AdsNotificationSample or returns an error if something is wrong
	Build() (AdsNotificationSample, error)
	// MustBuild does the same as Build but panics on error
	MustBuild() AdsNotificationSample
}

// NewAdsNotificationSampleBuilder() creates a AdsNotificationSampleBuilder
func NewAdsNotificationSampleBuilder() AdsNotificationSampleBuilder {
	return &_AdsNotificationSampleBuilder{_AdsNotificationSample: new(_AdsNotificationSample)}
}

type _AdsNotificationSampleBuilder struct {
	*_AdsNotificationSample

	collectedErr []error
}

var _ (AdsNotificationSampleBuilder) = (*_AdsNotificationSampleBuilder)(nil)

func (b *_AdsNotificationSampleBuilder) WithMandatoryFields(notificationHandle uint32, sampleSize uint32, data []byte) AdsNotificationSampleBuilder {
	return b.WithNotificationHandle(notificationHandle).WithSampleSize(sampleSize).WithData(data...)
}

func (b *_AdsNotificationSampleBuilder) WithNotificationHandle(notificationHandle uint32) AdsNotificationSampleBuilder {
	b.NotificationHandle = notificationHandle
	return b
}

func (b *_AdsNotificationSampleBuilder) WithSampleSize(sampleSize uint32) AdsNotificationSampleBuilder {
	b.SampleSize = sampleSize
	return b
}

func (b *_AdsNotificationSampleBuilder) WithData(data ...byte) AdsNotificationSampleBuilder {
	b.Data = data
	return b
}

func (b *_AdsNotificationSampleBuilder) Build() (AdsNotificationSample, error) {
	if err := stdErrors.Join(b.collectedErr...); err != nil {
		return nil, errors.Wrap(err, "error occurred during build")
	}
	return b._AdsNotificationSample.deepCopy(), nil
}

func (b *_AdsNotificationSampleBuilder) MustBuild() AdsNotificationSample {
	build, err := b.Build()
	if err != nil {
		panic(err)
	}
	return build
}

func (b *_AdsNotificationSampleBuilder) DeepCopy() any {
	_copy := b.CreateAdsNotificationSampleBuilder().(*_AdsNotificationSampleBuilder)
	if b.collectedErr != nil {
		copy(_copy.collectedErr, b.collectedErr)
	}
	return _copy
}

// CreateAdsNotificationSampleBuilder creates a AdsNotificationSampleBuilder
func (b *_AdsNotificationSample) CreateAdsNotificationSampleBuilder() AdsNotificationSampleBuilder {
	if b == nil {
		return NewAdsNotificationSampleBuilder()
	}
	return &_AdsNotificationSampleBuilder{_AdsNotificationSample: b.deepCopy()}
}

///////////////////////
///////////////////////
///////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////

///////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////
/////////////////////// Accessors for property fields.
///////////////////////

func (m *_AdsNotificationSample) GetNotificationHandle() uint32 {
	return m.NotificationHandle
}

func (m *_AdsNotificationSample) GetSampleSize() uint32 {
	return m.SampleSize
}

func (m *_AdsNotificationSample) GetData() []byte {
	return m.Data
}

///////////////////////
///////////////////////
///////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////

// Deprecated: use the interface for direct cast
func CastAdsNotificationSample(structType any) AdsNotificationSample {
	if casted, ok := structType.(AdsNotificationSample); ok {
		return casted
	}
	if casted, ok := structType.(*AdsNotificationSample); ok {
		return *casted
	}
	return nil
}

func (m *_AdsNotificationSample) GetPlx4xTypeName() string {
	return "AdsNotificationSample"
}

func (m *_AdsNotificationSample) GetLengthInBits(ctx context.Context) uint16 {
	lengthInBits := uint16(0)

	// Simple field (notificationHandle)
	lengthInBits += 32

	// Simple field (sampleSize)
	lengthInBits += 32

	// Array field
	if len(m.Data) > 0 {
		lengthInBits += 8 * uint16(len(m.Data))
	}

	return lengthInBits
}

func (m *_AdsNotificationSample) GetLengthInBytes(ctx context.Context) uint16 {
	return m.GetLengthInBits(ctx) / 8
}

func AdsNotificationSampleParse(ctx context.Context, theBytes []byte) (AdsNotificationSample, error) {
	return AdsNotificationSampleParseWithBuffer(ctx, utils.NewReadBufferByteBased(theBytes))
}

func AdsNotificationSampleParseWithBufferProducer() func(ctx context.Context, readBuffer utils.ReadBuffer) (AdsNotificationSample, error) {
	return func(ctx context.Context, readBuffer utils.ReadBuffer) (AdsNotificationSample, error) {
		return AdsNotificationSampleParseWithBuffer(ctx, readBuffer)
	}
}

func AdsNotificationSampleParseWithBuffer(ctx context.Context, readBuffer utils.ReadBuffer) (AdsNotificationSample, error) {
	v, err := (new(_AdsNotificationSample)).parse(ctx, readBuffer)
	if err != nil {
		return nil, err
	}
	return v, nil
}

func (m *_AdsNotificationSample) parse(ctx context.Context, readBuffer utils.ReadBuffer) (__adsNotificationSample AdsNotificationSample, err error) {
	positionAware := readBuffer
	_ = positionAware
	if pullErr := readBuffer.PullContext("AdsNotificationSample"); pullErr != nil {
		return nil, errors.Wrap(pullErr, "Error pulling for AdsNotificationSample")
	}
	currentPos := positionAware.GetPos()
	_ = currentPos

	notificationHandle, err := ReadSimpleField(ctx, "notificationHandle", ReadUnsignedInt(readBuffer, uint8(32)))
	if err != nil {
		return nil, errors.Wrap(err, fmt.Sprintf("Error parsing 'notificationHandle' field"))
	}
	m.NotificationHandle = notificationHandle

	sampleSize, err := ReadSimpleField(ctx, "sampleSize", ReadUnsignedInt(readBuffer, uint8(32)))
	if err != nil {
		return nil, errors.Wrap(err, fmt.Sprintf("Error parsing 'sampleSize' field"))
	}
	m.SampleSize = sampleSize

	data, err := readBuffer.ReadByteArray("data", int(sampleSize))
	if err != nil {
		return nil, errors.Wrap(err, fmt.Sprintf("Error parsing 'data' field"))
	}
	m.Data = data

	if closeErr := readBuffer.CloseContext("AdsNotificationSample"); closeErr != nil {
		return nil, errors.Wrap(closeErr, "Error closing for AdsNotificationSample")
	}

	return m, nil
}

func (m *_AdsNotificationSample) Serialize() ([]byte, error) {
	wb := utils.NewWriteBufferByteBased(utils.WithInitialSizeForByteBasedBuffer(int(m.GetLengthInBytes(context.Background()))))
	if err := m.SerializeWithWriteBuffer(context.Background(), wb); err != nil {
		return nil, err
	}
	return wb.GetBytes(), nil
}

func (m *_AdsNotificationSample) SerializeWithWriteBuffer(ctx context.Context, writeBuffer utils.WriteBuffer) error {
	positionAware := writeBuffer
	_ = positionAware
	log := zerolog.Ctx(ctx)
	_ = log
	if pushErr := writeBuffer.PushContext("AdsNotificationSample"); pushErr != nil {
		return errors.Wrap(pushErr, "Error pushing for AdsNotificationSample")
	}

	if err := WriteSimpleField[uint32](ctx, "notificationHandle", m.GetNotificationHandle(), WriteUnsignedInt(writeBuffer, 32)); err != nil {
		return errors.Wrap(err, "Error serializing 'notificationHandle' field")
	}

	if err := WriteSimpleField[uint32](ctx, "sampleSize", m.GetSampleSize(), WriteUnsignedInt(writeBuffer, 32)); err != nil {
		return errors.Wrap(err, "Error serializing 'sampleSize' field")
	}

	if err := WriteByteArrayField(ctx, "data", m.GetData(), WriteByteArray(writeBuffer, 8)); err != nil {
		return errors.Wrap(err, "Error serializing 'data' field")
	}

	if popErr := writeBuffer.PopContext("AdsNotificationSample"); popErr != nil {
		return errors.Wrap(popErr, "Error popping for AdsNotificationSample")
	}
	return nil
}

func (m *_AdsNotificationSample) IsAdsNotificationSample() {}

func (m *_AdsNotificationSample) DeepCopy() any {
	return m.deepCopy()
}

func (m *_AdsNotificationSample) deepCopy() *_AdsNotificationSample {
	if m == nil {
		return nil
	}
	_AdsNotificationSampleCopy := &_AdsNotificationSample{
		m.NotificationHandle,
		m.SampleSize,
		utils.DeepCopySlice[byte, byte](m.Data),
	}
	return _AdsNotificationSampleCopy
}

func (m *_AdsNotificationSample) 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()
}