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

// CipServiceRequest is the corresponding interface of CipServiceRequest
type CipServiceRequest interface {
	CipServiceRequestContract
	CipServiceRequestRequirements
	fmt.Stringer
	utils.LengthAware
	utils.Serializable
	utils.Copyable
	// IsCipServiceRequest is a marker method to prevent unintentional type checks (interfaces of same signature)
	IsCipServiceRequest()
	// CreateBuilder creates a CipServiceRequestBuilder
	CreateCipServiceRequestBuilder() CipServiceRequestBuilder
}

// CipServiceRequestContract provides a set of functions which can be overwritten by a sub struct
type CipServiceRequestContract interface {
	CipServiceContract
	// GetResponse returns Response (discriminator field)
	GetResponse() bool
	// IsCipServiceRequest is a marker method to prevent unintentional type checks (interfaces of same signature)
	IsCipServiceRequest()
	// CreateBuilder creates a CipServiceRequestBuilder
	CreateCipServiceRequestBuilder() CipServiceRequestBuilder
}

// CipServiceRequestRequirements provides a set of functions which need to be implemented by a sub struct
type CipServiceRequestRequirements interface {
	CipServiceRequirements
	GetLengthInBits(ctx context.Context) uint64
	GetLengthInBytes(ctx context.Context) uint64
	// GetService returns Service (discriminator field)
	GetService() uint8
}

// _CipServiceRequest is the data-structure of this message
type _CipServiceRequest struct {
	CipServiceContract
	_SubType interface {
		CipServiceRequestContract
		CipServiceRequestRequirements
	}
}

var _ CipServiceRequestContract = (*_CipServiceRequest)(nil)

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

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

// CipServiceRequestBuilder is a builder for CipServiceRequest
type CipServiceRequestBuilder interface {
	utils.Copyable
	// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
	WithMandatoryFields() CipServiceRequestBuilder
	// AsGetAttributeAllRequest converts this build to a subType of CipServiceRequest. It is always possible to return to current builder using Done()
	AsGetAttributeAllRequest() GetAttributeAllRequestBuilder
	// AsSetAttributeAllRequest converts this build to a subType of CipServiceRequest. It is always possible to return to current builder using Done()
	AsSetAttributeAllRequest() SetAttributeAllRequestBuilder
	// AsGetAttributeListRequest converts this build to a subType of CipServiceRequest. It is always possible to return to current builder using Done()
	AsGetAttributeListRequest() GetAttributeListRequestBuilder
	// AsSetAttributeListRequest converts this build to a subType of CipServiceRequest. It is always possible to return to current builder using Done()
	AsSetAttributeListRequest() SetAttributeListRequestBuilder
	// AsMultipleServiceRequest converts this build to a subType of CipServiceRequest. It is always possible to return to current builder using Done()
	AsMultipleServiceRequest() MultipleServiceRequestBuilder
	// AsGetAttributeSingleRequest converts this build to a subType of CipServiceRequest. It is always possible to return to current builder using Done()
	AsGetAttributeSingleRequest() GetAttributeSingleRequestBuilder
	// AsSetAttributeSingleRequest converts this build to a subType of CipServiceRequest. It is always possible to return to current builder using Done()
	AsSetAttributeSingleRequest() SetAttributeSingleRequestBuilder
	// AsCipReadRequest converts this build to a subType of CipServiceRequest. It is always possible to return to current builder using Done()
	AsCipReadRequest() CipReadRequestBuilder
	// AsCipWriteRequest converts this build to a subType of CipServiceRequest. It is always possible to return to current builder using Done()
	AsCipWriteRequest() CipWriteRequestBuilder
	// AsCipConnectionManagerCloseRequest converts this build to a subType of CipServiceRequest. It is always possible to return to current builder using Done()
	AsCipConnectionManagerCloseRequest() CipConnectionManagerCloseRequestBuilder
	// AsCipUnconnectedRequest converts this build to a subType of CipServiceRequest. It is always possible to return to current builder using Done()
	AsCipUnconnectedRequest() CipUnconnectedRequestBuilder
	// AsCipConnectedRequest converts this build to a subType of CipServiceRequest. It is always possible to return to current builder using Done()
	AsCipConnectedRequest() CipConnectedRequestBuilder
	// AsCipConnectionManagerRequest converts this build to a subType of CipServiceRequest. It is always possible to return to current builder using Done()
	AsCipConnectionManagerRequest() CipConnectionManagerRequestBuilder
	// Build builds the CipServiceRequest or returns an error if something is wrong
	PartialBuild() (CipServiceRequestContract, error)
	// MustBuild does the same as Build but panics on error
	PartialMustBuild() CipServiceRequestContract
	// 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 CipServiceRequest or returns an error if something is wrong
	Build() (CipServiceRequest, error)
	// MustBuild does the same as Build but panics on error
	MustBuild() CipServiceRequest
}

// NewCipServiceRequestBuilder() creates a CipServiceRequestBuilder
func NewCipServiceRequestBuilder() CipServiceRequestBuilder {
	return &_CipServiceRequestBuilder{_CipServiceRequest: new(_CipServiceRequest)}
}

type _CipServiceRequestChildBuilder interface {
	utils.Copyable
	setParent(CipServiceRequestContract)
	buildForCipServiceRequest() (CipServiceRequest, error)
}

type _CipServiceRequestBuilder struct {
	*_CipServiceRequest

	parentBuilder *_CipServiceBuilder

	childBuilder _CipServiceRequestChildBuilder

	collectedErr []error
}

var _ (CipServiceRequestBuilder) = (*_CipServiceRequestBuilder)(nil)

func (b *_CipServiceRequestBuilder) setParent(contract CipServiceContract) {
	b.CipServiceContract = contract
	contract.(*_CipService)._SubType = b._CipServiceRequest
}

func (b *_CipServiceRequestBuilder) WithMandatoryFields() CipServiceRequestBuilder {
	return b
}

func (b *_CipServiceRequestBuilder) PartialBuild() (CipServiceRequestContract, error) {
	if err := stdErrors.Join(b.collectedErr...); err != nil {
		return nil, errors.Wrap(err, "error occurred during build")
	}
	return b._CipServiceRequest.deepCopy(), nil
}

func (b *_CipServiceRequestBuilder) PartialMustBuild() CipServiceRequestContract {
	build, err := b.PartialBuild()
	if err != nil {
		panic(err)
	}
	return build
}

func (b *_CipServiceRequestBuilder) AsGetAttributeAllRequest() GetAttributeAllRequestBuilder {
	if cb, ok := b.childBuilder.(GetAttributeAllRequestBuilder); ok {
		return cb
	}
	cb := NewGetAttributeAllRequestBuilder().(*_GetAttributeAllRequestBuilder)
	cb.parentBuilder = b
	b.childBuilder = cb
	return cb
}

func (b *_CipServiceRequestBuilder) AsSetAttributeAllRequest() SetAttributeAllRequestBuilder {
	if cb, ok := b.childBuilder.(SetAttributeAllRequestBuilder); ok {
		return cb
	}
	cb := NewSetAttributeAllRequestBuilder().(*_SetAttributeAllRequestBuilder)
	cb.parentBuilder = b
	b.childBuilder = cb
	return cb
}

func (b *_CipServiceRequestBuilder) AsGetAttributeListRequest() GetAttributeListRequestBuilder {
	if cb, ok := b.childBuilder.(GetAttributeListRequestBuilder); ok {
		return cb
	}
	cb := NewGetAttributeListRequestBuilder().(*_GetAttributeListRequestBuilder)
	cb.parentBuilder = b
	b.childBuilder = cb
	return cb
}

func (b *_CipServiceRequestBuilder) AsSetAttributeListRequest() SetAttributeListRequestBuilder {
	if cb, ok := b.childBuilder.(SetAttributeListRequestBuilder); ok {
		return cb
	}
	cb := NewSetAttributeListRequestBuilder().(*_SetAttributeListRequestBuilder)
	cb.parentBuilder = b
	b.childBuilder = cb
	return cb
}

func (b *_CipServiceRequestBuilder) AsMultipleServiceRequest() MultipleServiceRequestBuilder {
	if cb, ok := b.childBuilder.(MultipleServiceRequestBuilder); ok {
		return cb
	}
	cb := NewMultipleServiceRequestBuilder().(*_MultipleServiceRequestBuilder)
	cb.parentBuilder = b
	b.childBuilder = cb
	return cb
}

func (b *_CipServiceRequestBuilder) AsGetAttributeSingleRequest() GetAttributeSingleRequestBuilder {
	if cb, ok := b.childBuilder.(GetAttributeSingleRequestBuilder); ok {
		return cb
	}
	cb := NewGetAttributeSingleRequestBuilder().(*_GetAttributeSingleRequestBuilder)
	cb.parentBuilder = b
	b.childBuilder = cb
	return cb
}

func (b *_CipServiceRequestBuilder) AsSetAttributeSingleRequest() SetAttributeSingleRequestBuilder {
	if cb, ok := b.childBuilder.(SetAttributeSingleRequestBuilder); ok {
		return cb
	}
	cb := NewSetAttributeSingleRequestBuilder().(*_SetAttributeSingleRequestBuilder)
	cb.parentBuilder = b
	b.childBuilder = cb
	return cb
}

func (b *_CipServiceRequestBuilder) AsCipReadRequest() CipReadRequestBuilder {
	if cb, ok := b.childBuilder.(CipReadRequestBuilder); ok {
		return cb
	}
	cb := NewCipReadRequestBuilder().(*_CipReadRequestBuilder)
	cb.parentBuilder = b
	b.childBuilder = cb
	return cb
}

func (b *_CipServiceRequestBuilder) AsCipWriteRequest() CipWriteRequestBuilder {
	if cb, ok := b.childBuilder.(CipWriteRequestBuilder); ok {
		return cb
	}
	cb := NewCipWriteRequestBuilder().(*_CipWriteRequestBuilder)
	cb.parentBuilder = b
	b.childBuilder = cb
	return cb
}

func (b *_CipServiceRequestBuilder) AsCipConnectionManagerCloseRequest() CipConnectionManagerCloseRequestBuilder {
	if cb, ok := b.childBuilder.(CipConnectionManagerCloseRequestBuilder); ok {
		return cb
	}
	cb := NewCipConnectionManagerCloseRequestBuilder().(*_CipConnectionManagerCloseRequestBuilder)
	cb.parentBuilder = b
	b.childBuilder = cb
	return cb
}

func (b *_CipServiceRequestBuilder) AsCipUnconnectedRequest() CipUnconnectedRequestBuilder {
	if cb, ok := b.childBuilder.(CipUnconnectedRequestBuilder); ok {
		return cb
	}
	cb := NewCipUnconnectedRequestBuilder().(*_CipUnconnectedRequestBuilder)
	cb.parentBuilder = b
	b.childBuilder = cb
	return cb
}

func (b *_CipServiceRequestBuilder) AsCipConnectedRequest() CipConnectedRequestBuilder {
	if cb, ok := b.childBuilder.(CipConnectedRequestBuilder); ok {
		return cb
	}
	cb := NewCipConnectedRequestBuilder().(*_CipConnectedRequestBuilder)
	cb.parentBuilder = b
	b.childBuilder = cb
	return cb
}

func (b *_CipServiceRequestBuilder) AsCipConnectionManagerRequest() CipConnectionManagerRequestBuilder {
	if cb, ok := b.childBuilder.(CipConnectionManagerRequestBuilder); ok {
		return cb
	}
	cb := NewCipConnectionManagerRequestBuilder().(*_CipConnectionManagerRequestBuilder)
	cb.parentBuilder = b
	b.childBuilder = cb
	return cb
}

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

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

func (b *_CipServiceRequestBuilder) Build() (CipServiceRequest, error) {
	v, err := b.PartialBuild()
	if err != nil {
		return nil, errors.Wrap(err, "error occurred during partial build")
	}
	if b.childBuilder == nil {
		return nil, errors.New("no child builder present")
	}
	b.childBuilder.setParent(v)
	return b.childBuilder.buildForCipServiceRequest()
}

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

func (b *_CipServiceRequestBuilder) DeepCopy() any {
	_copy := b.CreateCipServiceRequestBuilder().(*_CipServiceRequestBuilder)
	_copy.childBuilder = b.childBuilder.DeepCopy().(_CipServiceRequestChildBuilder)
	_copy.childBuilder.setParent(_copy)
	if b.collectedErr != nil {
		copy(_copy.collectedErr, b.collectedErr)
	}
	return _copy
}

// CreateCipServiceRequestBuilder creates a CipServiceRequestBuilder
func (b *_CipServiceRequest) CreateCipServiceRequestBuilder() CipServiceRequestBuilder {
	if b == nil {
		return NewCipServiceRequestBuilder()
	}
	return &_CipServiceRequestBuilder{_CipServiceRequest: b.deepCopy()}
}

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

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

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

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

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

func (m *_CipServiceRequest) GetPlx4xTypeName() string {
	return "CipServiceRequest"
}

func (m *_CipServiceRequest) getLengthInBits(ctx context.Context) uint64 {
	lengthInBits := uint64(m.CipServiceContract.(*_CipService).getLengthInBits(ctx))
	// Discriminator Field (service)
	lengthInBits += 7

	return lengthInBits
}

func (m *_CipServiceRequest) GetLengthInBits(ctx context.Context) uint64 {
	return m._SubType.GetLengthInBits(ctx)
}

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

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

	service, err := ReadDiscriminatorField[uint8](ctx, "service", ReadUnsignedByte(readBuffer, uint8(7)))
	if err != nil {
		return nil, errors.Wrap(err, fmt.Sprintf("Error parsing 'service' field"))
	}

	// Switch Field (Depending on the discriminator values, passes the instantiation to a sub-type)
	var _child CipServiceRequest
	switch {
	case service == 0x01: // GetAttributeAllRequest
		if _child, err = new(_GetAttributeAllRequest).parse(ctx, readBuffer, m, connected, uint16(serviceLen)); err != nil {
			return nil, errors.Wrap(err, "Error parsing sub-type GetAttributeAllRequest for type-switch of CipServiceRequest")
		}
	case service == 0x02: // SetAttributeAllRequest
		if _child, err = new(_SetAttributeAllRequest).parse(ctx, readBuffer, m, connected, uint16(serviceLen)); err != nil {
			return nil, errors.Wrap(err, "Error parsing sub-type SetAttributeAllRequest for type-switch of CipServiceRequest")
		}
	case service == 0x03: // GetAttributeListRequest
		if _child, err = new(_GetAttributeListRequest).parse(ctx, readBuffer, m, connected, uint16(serviceLen)); err != nil {
			return nil, errors.Wrap(err, "Error parsing sub-type GetAttributeListRequest for type-switch of CipServiceRequest")
		}
	case service == 0x04: // SetAttributeListRequest
		if _child, err = new(_SetAttributeListRequest).parse(ctx, readBuffer, m, connected, uint16(serviceLen)); err != nil {
			return nil, errors.Wrap(err, "Error parsing sub-type SetAttributeListRequest for type-switch of CipServiceRequest")
		}
	case service == 0x0A: // MultipleServiceRequest
		if _child, err = new(_MultipleServiceRequest).parse(ctx, readBuffer, m, connected, uint16(serviceLen)); err != nil {
			return nil, errors.Wrap(err, "Error parsing sub-type MultipleServiceRequest for type-switch of CipServiceRequest")
		}
	case service == 0x0E: // GetAttributeSingleRequest
		if _child, err = new(_GetAttributeSingleRequest).parse(ctx, readBuffer, m, connected, uint16(serviceLen)); err != nil {
			return nil, errors.Wrap(err, "Error parsing sub-type GetAttributeSingleRequest for type-switch of CipServiceRequest")
		}
	case service == 0x10: // SetAttributeSingleRequest
		if _child, err = new(_SetAttributeSingleRequest).parse(ctx, readBuffer, m, connected, uint16(serviceLen)); err != nil {
			return nil, errors.Wrap(err, "Error parsing sub-type SetAttributeSingleRequest for type-switch of CipServiceRequest")
		}
	case service == 0x4C: // CipReadRequest
		if _child, err = new(_CipReadRequest).parse(ctx, readBuffer, m, connected, uint16(serviceLen)); err != nil {
			return nil, errors.Wrap(err, "Error parsing sub-type CipReadRequest for type-switch of CipServiceRequest")
		}
	case service == 0x4D: // CipWriteRequest
		if _child, err = new(_CipWriteRequest).parse(ctx, readBuffer, m, connected, uint16(serviceLen)); err != nil {
			return nil, errors.Wrap(err, "Error parsing sub-type CipWriteRequest for type-switch of CipServiceRequest")
		}
	case service == 0x4E: // CipConnectionManagerCloseRequest
		if _child, err = new(_CipConnectionManagerCloseRequest).parse(ctx, readBuffer, m, connected, uint16(serviceLen)); err != nil {
			return nil, errors.Wrap(err, "Error parsing sub-type CipConnectionManagerCloseRequest for type-switch of CipServiceRequest")
		}
	case service == 0x52 && connected == bool(false): // CipUnconnectedRequest
		if _child, err = new(_CipUnconnectedRequest).parse(ctx, readBuffer, m, connected, uint16(serviceLen)); err != nil {
			return nil, errors.Wrap(err, "Error parsing sub-type CipUnconnectedRequest for type-switch of CipServiceRequest")
		}
	case service == 0x52 && connected == bool(true): // CipConnectedRequest
		if _child, err = new(_CipConnectedRequest).parse(ctx, readBuffer, m, connected, uint16(serviceLen)); err != nil {
			return nil, errors.Wrap(err, "Error parsing sub-type CipConnectedRequest for type-switch of CipServiceRequest")
		}
	case service == 0x5B: // CipConnectionManagerRequest
		if _child, err = new(_CipConnectionManagerRequest).parse(ctx, readBuffer, m, connected, uint16(serviceLen)); err != nil {
			return nil, errors.Wrap(err, "Error parsing sub-type CipConnectionManagerRequest for type-switch of CipServiceRequest")
		}
	default:
		return nil, errors.Errorf("Unmapped type for parameters [service=%v, connected=%v]", service, connected)
	}

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

	parent._SubType = _child
	return _child, nil
}

func (pm *_CipServiceRequest) serializeParent(ctx context.Context, writeBuffer utils.WriteBuffer, child CipServiceRequest, serializeChildFunction func() error) error {
	// We redirect all calls through client as some methods are only implemented there
	m := child
	_ = m
	positionAware := writeBuffer
	_ = positionAware
	log := zerolog.Ctx(ctx)
	_ = log
	ser := func() error {
		if pushErr := writeBuffer.PushContext("CipServiceRequest"); pushErr != nil {
			return errors.Wrap(pushErr, "Error pushing for CipServiceRequest")
		}

		if err := WriteDiscriminatorField(ctx, "service", m.GetService(), WriteUnsignedByte(writeBuffer, 7)); err != nil {
			return errors.Wrap(err, "Error serializing 'service' field")
		}

		// Switch field (Depending on the discriminator values, passes the serialization to a sub-type)
		if _typeSwitchErr := serializeChildFunction(); _typeSwitchErr != nil {
			return errors.Wrap(_typeSwitchErr, "Error serializing sub-type field")
		}

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

func (m *_CipServiceRequest) IsCipServiceRequest() {}

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

func (m *_CipServiceRequest) deepCopy() *_CipServiceRequest {
	if m == nil {
		return nil
	}
	_CipServiceRequestCopy := &_CipServiceRequest{
		m.CipServiceContract.(*_CipService).deepCopy(),
		nil, // will be set by child
	}
	_CipServiceRequestCopy.CipServiceContract.(*_CipService)._SubType = m
	return _CipServiceRequestCopy
}