plc4go/protocols/eip/readwrite/model/CipConnectionManagerResponseFailure.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.

// CipConnectionManagerResponseFailure is the corresponding interface of CipConnectionManagerResponseFailure
// Unsuccessful Forward_Open Response format: no connection ids or APIs,
// and remainingPathSize tells the originator how much of the connection
// path was left unprocessed when the request was refused.
type CipConnectionManagerResponseFailure interface {
	fmt.Stringer
	utils.LengthAware
	utils.Serializable
	utils.Copyable
	CipConnectionManagerResponse
	// GetConnectionSerialNumber returns ConnectionSerialNumber (property field)
	GetConnectionSerialNumber() uint16
	// GetOriginatorVendorId returns OriginatorVendorId (property field)
	GetOriginatorVendorId() uint16
	// GetOriginatorSerialNumber returns OriginatorSerialNumber (property field)
	GetOriginatorSerialNumber() uint32
	// GetRemainingPathSize returns RemainingPathSize (property field)
	GetRemainingPathSize() uint8
	// IsCipConnectionManagerResponseFailure is a marker method to prevent unintentional type checks (interfaces of same signature)
	IsCipConnectionManagerResponseFailure()
	// CreateBuilder creates a CipConnectionManagerResponseFailureBuilder
	CreateCipConnectionManagerResponseFailureBuilder() CipConnectionManagerResponseFailureBuilder
}

// _CipConnectionManagerResponseFailure is the data-structure of this message
type _CipConnectionManagerResponseFailure struct {
	CipConnectionManagerResponseContract
	ConnectionSerialNumber uint16
	OriginatorVendorId     uint16
	OriginatorSerialNumber uint32
	RemainingPathSize      uint8
	// Reserved Fields
	reservedField0 *uint8
}

var _ CipConnectionManagerResponseFailure = (*_CipConnectionManagerResponseFailure)(nil)
var _ CipConnectionManagerResponseRequirements = (*_CipConnectionManagerResponseFailure)(nil)

// NewCipConnectionManagerResponseFailure factory function for _CipConnectionManagerResponseFailure
func NewCipConnectionManagerResponseFailure(status uint8, extStatus []uint16, connectionSerialNumber uint16, originatorVendorId uint16, originatorSerialNumber uint32, remainingPathSize uint8) *_CipConnectionManagerResponseFailure {
	_result := &_CipConnectionManagerResponseFailure{
		CipConnectionManagerResponseContract: NewCipConnectionManagerResponse(status, extStatus),
		ConnectionSerialNumber:               connectionSerialNumber,
		OriginatorVendorId:                   originatorVendorId,
		OriginatorSerialNumber:               originatorSerialNumber,
		RemainingPathSize:                    remainingPathSize,
	}
	_result.CipConnectionManagerResponseContract.(*_CipConnectionManagerResponse)._SubType = _result
	return _result
}

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

// CipConnectionManagerResponseFailureBuilder is a builder for CipConnectionManagerResponseFailure
type CipConnectionManagerResponseFailureBuilder interface {
	utils.Copyable
	// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
	WithMandatoryFields(connectionSerialNumber uint16, originatorVendorId uint16, originatorSerialNumber uint32, remainingPathSize uint8) CipConnectionManagerResponseFailureBuilder
	// WithConnectionSerialNumber adds ConnectionSerialNumber (property field)
	WithConnectionSerialNumber(uint16) CipConnectionManagerResponseFailureBuilder
	// WithOriginatorVendorId adds OriginatorVendorId (property field)
	WithOriginatorVendorId(uint16) CipConnectionManagerResponseFailureBuilder
	// WithOriginatorSerialNumber adds OriginatorSerialNumber (property field)
	WithOriginatorSerialNumber(uint32) CipConnectionManagerResponseFailureBuilder
	// WithRemainingPathSize adds RemainingPathSize (property field)
	WithRemainingPathSize(uint8) CipConnectionManagerResponseFailureBuilder
	// Done is used to finish work on this child and return (or create one if none) to the parent builder
	Done() CipConnectionManagerResponseBuilder
	// Build builds the CipConnectionManagerResponseFailure or returns an error if something is wrong
	Build() (CipConnectionManagerResponseFailure, error)
	// MustBuild does the same as Build but panics on error
	MustBuild() CipConnectionManagerResponseFailure
}

// NewCipConnectionManagerResponseFailureBuilder() creates a CipConnectionManagerResponseFailureBuilder
func NewCipConnectionManagerResponseFailureBuilder() CipConnectionManagerResponseFailureBuilder {
	return &_CipConnectionManagerResponseFailureBuilder{_CipConnectionManagerResponseFailure: new(_CipConnectionManagerResponseFailure)}
}

type _CipConnectionManagerResponseFailureBuilder struct {
	*_CipConnectionManagerResponseFailure

	parentBuilder *_CipConnectionManagerResponseBuilder

	collectedErr []error
}

var _ (CipConnectionManagerResponseFailureBuilder) = (*_CipConnectionManagerResponseFailureBuilder)(nil)

func (b *_CipConnectionManagerResponseFailureBuilder) setParent(contract CipConnectionManagerResponseContract) {
	b.CipConnectionManagerResponseContract = contract
	contract.(*_CipConnectionManagerResponse)._SubType = b._CipConnectionManagerResponseFailure
}

func (b *_CipConnectionManagerResponseFailureBuilder) WithMandatoryFields(connectionSerialNumber uint16, originatorVendorId uint16, originatorSerialNumber uint32, remainingPathSize uint8) CipConnectionManagerResponseFailureBuilder {
	return b.WithConnectionSerialNumber(connectionSerialNumber).WithOriginatorVendorId(originatorVendorId).WithOriginatorSerialNumber(originatorSerialNumber).WithRemainingPathSize(remainingPathSize)
}

func (b *_CipConnectionManagerResponseFailureBuilder) WithConnectionSerialNumber(connectionSerialNumber uint16) CipConnectionManagerResponseFailureBuilder {
	b.ConnectionSerialNumber = connectionSerialNumber
	return b
}

func (b *_CipConnectionManagerResponseFailureBuilder) WithOriginatorVendorId(originatorVendorId uint16) CipConnectionManagerResponseFailureBuilder {
	b.OriginatorVendorId = originatorVendorId
	return b
}

func (b *_CipConnectionManagerResponseFailureBuilder) WithOriginatorSerialNumber(originatorSerialNumber uint32) CipConnectionManagerResponseFailureBuilder {
	b.OriginatorSerialNumber = originatorSerialNumber
	return b
}

func (b *_CipConnectionManagerResponseFailureBuilder) WithRemainingPathSize(remainingPathSize uint8) CipConnectionManagerResponseFailureBuilder {
	b.RemainingPathSize = remainingPathSize
	return b
}

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

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

func (b *_CipConnectionManagerResponseFailureBuilder) Done() CipConnectionManagerResponseBuilder {
	if b.parentBuilder == nil {
		b.parentBuilder = NewCipConnectionManagerResponseBuilder().(*_CipConnectionManagerResponseBuilder)
	}
	return b.parentBuilder
}

func (b *_CipConnectionManagerResponseFailureBuilder) buildForCipConnectionManagerResponse() (CipConnectionManagerResponse, error) {
	return b.Build()
}

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

// CreateCipConnectionManagerResponseFailureBuilder creates a CipConnectionManagerResponseFailureBuilder
func (b *_CipConnectionManagerResponseFailure) CreateCipConnectionManagerResponseFailureBuilder() CipConnectionManagerResponseFailureBuilder {
	if b == nil {
		return NewCipConnectionManagerResponseFailureBuilder()
	}
	return &_CipConnectionManagerResponseFailureBuilder{_CipConnectionManagerResponseFailure: b.deepCopy()}
}

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

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

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

func (m *_CipConnectionManagerResponseFailure) GetParent() CipConnectionManagerResponseContract {
	return m.CipConnectionManagerResponseContract
}

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

func (m *_CipConnectionManagerResponseFailure) GetConnectionSerialNumber() uint16 {
	return m.ConnectionSerialNumber
}

func (m *_CipConnectionManagerResponseFailure) GetOriginatorVendorId() uint16 {
	return m.OriginatorVendorId
}

func (m *_CipConnectionManagerResponseFailure) GetOriginatorSerialNumber() uint32 {
	return m.OriginatorSerialNumber
}

func (m *_CipConnectionManagerResponseFailure) GetRemainingPathSize() uint8 {
	return m.RemainingPathSize
}

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

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

func (m *_CipConnectionManagerResponseFailure) GetPlx4xTypeName() string {
	return "CipConnectionManagerResponseFailure"
}

func (m *_CipConnectionManagerResponseFailure) GetLengthInBits(ctx context.Context) uint64 {
	lengthInBits := uint64(m.CipConnectionManagerResponseContract.(*_CipConnectionManagerResponse).getLengthInBits(ctx))

	// Simple field (connectionSerialNumber)
	lengthInBits += 16

	// Simple field (originatorVendorId)
	lengthInBits += 16

	// Simple field (originatorSerialNumber)
	lengthInBits += 32

	// Simple field (remainingPathSize)
	lengthInBits += 8

	// Reserved Field (reserved)
	lengthInBits += 8

	return lengthInBits
}

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

func (m *_CipConnectionManagerResponseFailure) parse(ctx context.Context, readBuffer utils.ReadBuffer, parent *_CipConnectionManagerResponse, status uint8, connected bool, serviceLen uint16) (__cipConnectionManagerResponseFailure CipConnectionManagerResponseFailure, err error) {
	m.CipConnectionManagerResponseContract = parent
	parent._SubType = m
	positionAware := readBuffer
	_ = positionAware
	if pullErr := readBuffer.PullContext("CipConnectionManagerResponseFailure"); pullErr != nil {
		return nil, errors.Wrap(pullErr, "Error pulling for CipConnectionManagerResponseFailure")
	}
	currentPos := positionAware.GetPos()
	_ = currentPos

	connectionSerialNumber, err := ReadSimpleField(ctx, "connectionSerialNumber", ReadUnsignedShort(readBuffer, uint8(16)))
	if err != nil {
		return nil, errors.Wrap(err, fmt.Sprintf("Error parsing 'connectionSerialNumber' field"))
	}
	m.ConnectionSerialNumber = connectionSerialNumber

	originatorVendorId, err := ReadSimpleField(ctx, "originatorVendorId", ReadUnsignedShort(readBuffer, uint8(16)))
	if err != nil {
		return nil, errors.Wrap(err, fmt.Sprintf("Error parsing 'originatorVendorId' field"))
	}
	m.OriginatorVendorId = originatorVendorId

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

	remainingPathSize, err := ReadSimpleField(ctx, "remainingPathSize", ReadUnsignedByte(readBuffer, uint8(8)))
	if err != nil {
		return nil, errors.Wrap(err, fmt.Sprintf("Error parsing 'remainingPathSize' field"))
	}
	m.RemainingPathSize = remainingPathSize

	reservedField0, err := ReadReservedField(ctx, "reserved", ReadUnsignedByte(readBuffer, uint8(8)), uint8(0x00))
	if err != nil {
		return nil, errors.Wrap(err, fmt.Sprintf("Error parsing reserved field"))
	}
	m.reservedField0 = reservedField0

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

	return m, nil
}

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

		if err := WriteSimpleField[uint16](ctx, "connectionSerialNumber", m.GetConnectionSerialNumber(), WriteUnsignedShort(writeBuffer, 16)); err != nil {
			return errors.Wrap(err, "Error serializing 'connectionSerialNumber' field")
		}

		if err := WriteSimpleField[uint16](ctx, "originatorVendorId", m.GetOriginatorVendorId(), WriteUnsignedShort(writeBuffer, 16)); err != nil {
			return errors.Wrap(err, "Error serializing 'originatorVendorId' field")
		}

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

		if err := WriteSimpleField[uint8](ctx, "remainingPathSize", m.GetRemainingPathSize(), WriteUnsignedByte(writeBuffer, 8)); err != nil {
			return errors.Wrap(err, "Error serializing 'remainingPathSize' field")
		}

		if err := WriteReservedField[uint8](ctx, "reserved", uint8(0x00), WriteUnsignedByte(writeBuffer, 8)); err != nil {
			return errors.Wrap(err, "Error serializing 'reserved' field number 1")
		}

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

func (m *_CipConnectionManagerResponseFailure) IsCipConnectionManagerResponseFailure() {}

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

func (m *_CipConnectionManagerResponseFailure) deepCopy() *_CipConnectionManagerResponseFailure {
	if m == nil {
		return nil
	}
	_CipConnectionManagerResponseFailureCopy := &_CipConnectionManagerResponseFailure{
		m.CipConnectionManagerResponseContract.(*_CipConnectionManagerResponse).deepCopy(),
		m.ConnectionSerialNumber,
		m.OriginatorVendorId,
		m.OriginatorSerialNumber,
		m.RemainingPathSize,
		m.reservedField0,
	}
	_CipConnectionManagerResponseFailureCopy.CipConnectionManagerResponseContract.(*_CipConnectionManagerResponse)._SubType = m
	return _CipConnectionManagerResponseFailureCopy
}

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