plc4go/protocols/eip/readwrite/model/SetAttributeSingleRequest.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/errors"
	"github.com/apache/plc4x/plc4go/spi/utils"
)

// Code generated by code-generation. DO NOT EDIT.

// SetAttributeSingleRequest is the corresponding interface of SetAttributeSingleRequest
type SetAttributeSingleRequest interface {
	fmt.Stringer
	utils.LengthAware
	utils.Serializable
	utils.Copyable
	CipService
	// IsSetAttributeSingleRequest is a marker method to prevent unintentional type checks (interfaces of same signature)
	IsSetAttributeSingleRequest()
	// CreateBuilder creates a SetAttributeSingleRequestBuilder
	CreateSetAttributeSingleRequestBuilder() SetAttributeSingleRequestBuilder
}

// _SetAttributeSingleRequest is the data-structure of this message
type _SetAttributeSingleRequest struct {
	CipServiceContract
}

var _ SetAttributeSingleRequest = (*_SetAttributeSingleRequest)(nil)
var _ CipServiceRequirements = (*_SetAttributeSingleRequest)(nil)

// NewSetAttributeSingleRequest factory function for _SetAttributeSingleRequest
func NewSetAttributeSingleRequest() *_SetAttributeSingleRequest {
	_result := &_SetAttributeSingleRequest{
		CipServiceContract: NewCipService(),
	}
	_result.CipServiceContract.(*_CipService)._SubType = _result
	return _result
}

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

// SetAttributeSingleRequestBuilder is a builder for SetAttributeSingleRequest
type SetAttributeSingleRequestBuilder interface {
	utils.Copyable
	// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
	WithMandatoryFields() SetAttributeSingleRequestBuilder
	// Done is used to finish work on this child and return (or create one if none) to the parent builder
	Done() CipServiceBuilder
	// Build builds the SetAttributeSingleRequest or returns an error if something is wrong
	Build() (SetAttributeSingleRequest, error)
	// MustBuild does the same as Build but panics on error
	MustBuild() SetAttributeSingleRequest
}

// NewSetAttributeSingleRequestBuilder() creates a SetAttributeSingleRequestBuilder
func NewSetAttributeSingleRequestBuilder() SetAttributeSingleRequestBuilder {
	return &_SetAttributeSingleRequestBuilder{_SetAttributeSingleRequest: new(_SetAttributeSingleRequest)}
}

type _SetAttributeSingleRequestBuilder struct {
	*_SetAttributeSingleRequest

	parentBuilder *_CipServiceBuilder

	collectedErr []error
}

var _ (SetAttributeSingleRequestBuilder) = (*_SetAttributeSingleRequestBuilder)(nil)

func (b *_SetAttributeSingleRequestBuilder) setParent(contract CipServiceContract) {
	b.CipServiceContract = contract
	contract.(*_CipService)._SubType = b._SetAttributeSingleRequest
}

func (b *_SetAttributeSingleRequestBuilder) WithMandatoryFields() SetAttributeSingleRequestBuilder {
	return b
}

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

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

func (b *_SetAttributeSingleRequestBuilder) Done() CipServiceBuilder {
	if b.parentBuilder == nil {
		b.parentBuilder = NewCipServiceBuilder().(*_CipServiceBuilder)
	}
	return b.parentBuilder
}

func (b *_SetAttributeSingleRequestBuilder) buildForCipService() (CipService, error) {
	return b.Build()
}

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

// CreateSetAttributeSingleRequestBuilder creates a SetAttributeSingleRequestBuilder
func (b *_SetAttributeSingleRequest) CreateSetAttributeSingleRequestBuilder() SetAttributeSingleRequestBuilder {
	if b == nil {
		return NewSetAttributeSingleRequestBuilder()
	}
	return &_SetAttributeSingleRequestBuilder{_SetAttributeSingleRequest: b.deepCopy()}
}

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

///////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////
/////////////////////// Accessors for discriminator values.
///////////////////////

func (m *_SetAttributeSingleRequest) GetService() uint8 {
	return 0x10
}

func (m *_SetAttributeSingleRequest) GetResponse() bool {
	return bool(false)
}

func (m *_SetAttributeSingleRequest) GetConnected() bool {
	return false
}

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

func (m *_SetAttributeSingleRequest) GetParent() CipServiceContract {
	return m.CipServiceContract
}

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

func (m *_SetAttributeSingleRequest) GetPlx4xTypeName() string {
	return "SetAttributeSingleRequest"
}

func (m *_SetAttributeSingleRequest) GetLengthInBits(ctx context.Context) uint16 {
	lengthInBits := uint16(m.CipServiceContract.(*_CipService).getLengthInBits(ctx))

	return lengthInBits
}

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

func (m *_SetAttributeSingleRequest) parse(ctx context.Context, readBuffer utils.ReadBuffer, parent *_CipService, connected bool, serviceLen uint16) (__setAttributeSingleRequest SetAttributeSingleRequest, err error) {
	m.CipServiceContract = parent
	parent._SubType = m
	positionAware := readBuffer
	_ = positionAware
	if pullErr := readBuffer.PullContext("SetAttributeSingleRequest"); pullErr != nil {
		return nil, errors.Wrap(pullErr, "Error pulling for SetAttributeSingleRequest")
	}
	currentPos := positionAware.GetPos()
	_ = currentPos

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

	return m, nil
}

func (m *_SetAttributeSingleRequest) 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 *_SetAttributeSingleRequest) SerializeWithWriteBuffer(ctx context.Context, writeBuffer utils.WriteBuffer) error {
	positionAware := writeBuffer
	_ = positionAware
	log := zerolog.Ctx(ctx)
	_ = log
	ser := func() error {
		if pushErr := writeBuffer.PushContext("SetAttributeSingleRequest"); pushErr != nil {
			return errors.Wrap(pushErr, "Error pushing for SetAttributeSingleRequest")
		}

		if popErr := writeBuffer.PopContext("SetAttributeSingleRequest"); popErr != nil {
			return errors.Wrap(popErr, "Error popping for SetAttributeSingleRequest")
		}
		return nil
	}
	return m.CipServiceContract.(*_CipService).serializeParent(ctx, writeBuffer, m, ser)
}

func (m *_SetAttributeSingleRequest) IsSetAttributeSingleRequest() {}

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

func (m *_SetAttributeSingleRequest) deepCopy() *_SetAttributeSingleRequest {
	if m == nil {
		return nil
	}
	_SetAttributeSingleRequestCopy := &_SetAttributeSingleRequest{
		m.CipServiceContract.(*_CipService).deepCopy(),
	}
	_SetAttributeSingleRequestCopy.CipServiceContract.(*_CipService)._SubType = m
	return _SetAttributeSingleRequestCopy
}

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