blob: 964ffd89f3d582db94edf3324dbcb1ba731097ed [file] [log] [blame]
/*
* 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/pkg/errors"
"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/utils"
)
// Code generated by code-generation. DO NOT EDIT.
// ModbusPDUReadFileRecordResponse is the corresponding interface of ModbusPDUReadFileRecordResponse
type ModbusPDUReadFileRecordResponse interface {
fmt.Stringer
utils.LengthAware
utils.Serializable
utils.Copyable
ModbusPDU
// GetItems returns Items (property field)
GetItems() []ModbusPDUReadFileRecordResponseItem
// IsModbusPDUReadFileRecordResponse is a marker method to prevent unintentional type checks (interfaces of same signature)
IsModbusPDUReadFileRecordResponse()
// CreateBuilder creates a ModbusPDUReadFileRecordResponseBuilder
CreateModbusPDUReadFileRecordResponseBuilder() ModbusPDUReadFileRecordResponseBuilder
}
// _ModbusPDUReadFileRecordResponse is the data-structure of this message
type _ModbusPDUReadFileRecordResponse struct {
ModbusPDUContract
Items []ModbusPDUReadFileRecordResponseItem
}
var _ ModbusPDUReadFileRecordResponse = (*_ModbusPDUReadFileRecordResponse)(nil)
var _ ModbusPDURequirements = (*_ModbusPDUReadFileRecordResponse)(nil)
// NewModbusPDUReadFileRecordResponse factory function for _ModbusPDUReadFileRecordResponse
func NewModbusPDUReadFileRecordResponse(items []ModbusPDUReadFileRecordResponseItem) *_ModbusPDUReadFileRecordResponse {
_result := &_ModbusPDUReadFileRecordResponse{
ModbusPDUContract: NewModbusPDU(),
Items: items,
}
_result.ModbusPDUContract.(*_ModbusPDU)._SubType = _result
return _result
}
///////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////
/////////////////////// Builder
///////////////////////
// ModbusPDUReadFileRecordResponseBuilder is a builder for ModbusPDUReadFileRecordResponse
type ModbusPDUReadFileRecordResponseBuilder interface {
utils.Copyable
// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
WithMandatoryFields(items []ModbusPDUReadFileRecordResponseItem) ModbusPDUReadFileRecordResponseBuilder
// WithItems adds Items (property field)
WithItems(...ModbusPDUReadFileRecordResponseItem) ModbusPDUReadFileRecordResponseBuilder
// Done is used to finish work on this child and return (or create one if none) to the parent builder
Done() ModbusPDUBuilder
// Build builds the ModbusPDUReadFileRecordResponse or returns an error if something is wrong
Build() (ModbusPDUReadFileRecordResponse, error)
// MustBuild does the same as Build but panics on error
MustBuild() ModbusPDUReadFileRecordResponse
}
// NewModbusPDUReadFileRecordResponseBuilder() creates a ModbusPDUReadFileRecordResponseBuilder
func NewModbusPDUReadFileRecordResponseBuilder() ModbusPDUReadFileRecordResponseBuilder {
return &_ModbusPDUReadFileRecordResponseBuilder{_ModbusPDUReadFileRecordResponse: new(_ModbusPDUReadFileRecordResponse)}
}
type _ModbusPDUReadFileRecordResponseBuilder struct {
*_ModbusPDUReadFileRecordResponse
parentBuilder *_ModbusPDUBuilder
collectedErr []error
}
var _ (ModbusPDUReadFileRecordResponseBuilder) = (*_ModbusPDUReadFileRecordResponseBuilder)(nil)
func (b *_ModbusPDUReadFileRecordResponseBuilder) setParent(contract ModbusPDUContract) {
b.ModbusPDUContract = contract
contract.(*_ModbusPDU)._SubType = b._ModbusPDUReadFileRecordResponse
}
func (b *_ModbusPDUReadFileRecordResponseBuilder) WithMandatoryFields(items []ModbusPDUReadFileRecordResponseItem) ModbusPDUReadFileRecordResponseBuilder {
return b.WithItems(items...)
}
func (b *_ModbusPDUReadFileRecordResponseBuilder) WithItems(items ...ModbusPDUReadFileRecordResponseItem) ModbusPDUReadFileRecordResponseBuilder {
b.Items = items
return b
}
func (b *_ModbusPDUReadFileRecordResponseBuilder) Build() (ModbusPDUReadFileRecordResponse, error) {
if err := stdErrors.Join(b.collectedErr...); err != nil {
return nil, errors.Wrap(err, "error occurred during build")
}
return b._ModbusPDUReadFileRecordResponse.deepCopy(), nil
}
func (b *_ModbusPDUReadFileRecordResponseBuilder) MustBuild() ModbusPDUReadFileRecordResponse {
build, err := b.Build()
if err != nil {
panic(err)
}
return build
}
func (b *_ModbusPDUReadFileRecordResponseBuilder) Done() ModbusPDUBuilder {
if b.parentBuilder == nil {
b.parentBuilder = NewModbusPDUBuilder().(*_ModbusPDUBuilder)
}
return b.parentBuilder
}
func (b *_ModbusPDUReadFileRecordResponseBuilder) buildForModbusPDU() (ModbusPDU, error) {
return b.Build()
}
func (b *_ModbusPDUReadFileRecordResponseBuilder) DeepCopy() any {
_copy := b.CreateModbusPDUReadFileRecordResponseBuilder().(*_ModbusPDUReadFileRecordResponseBuilder)
if b.collectedErr != nil {
copy(_copy.collectedErr, b.collectedErr)
}
return _copy
}
// CreateModbusPDUReadFileRecordResponseBuilder creates a ModbusPDUReadFileRecordResponseBuilder
func (b *_ModbusPDUReadFileRecordResponse) CreateModbusPDUReadFileRecordResponseBuilder() ModbusPDUReadFileRecordResponseBuilder {
if b == nil {
return NewModbusPDUReadFileRecordResponseBuilder()
}
return &_ModbusPDUReadFileRecordResponseBuilder{_ModbusPDUReadFileRecordResponse: b.deepCopy()}
}
///////////////////////
///////////////////////
///////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////
/////////////////////// Accessors for discriminator values.
///////////////////////
func (m *_ModbusPDUReadFileRecordResponse) GetErrorFlag() bool {
return bool(false)
}
func (m *_ModbusPDUReadFileRecordResponse) GetFunctionFlag() uint8 {
return 0x14
}
func (m *_ModbusPDUReadFileRecordResponse) GetResponse() bool {
return bool(true)
}
///////////////////////
///////////////////////
///////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////
func (m *_ModbusPDUReadFileRecordResponse) GetParent() ModbusPDUContract {
return m.ModbusPDUContract
}
///////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////
/////////////////////// Accessors for property fields.
///////////////////////
func (m *_ModbusPDUReadFileRecordResponse) GetItems() []ModbusPDUReadFileRecordResponseItem {
return m.Items
}
///////////////////////
///////////////////////
///////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////
// Deprecated: use the interface for direct cast
func CastModbusPDUReadFileRecordResponse(structType any) ModbusPDUReadFileRecordResponse {
if casted, ok := structType.(ModbusPDUReadFileRecordResponse); ok {
return casted
}
if casted, ok := structType.(*ModbusPDUReadFileRecordResponse); ok {
return *casted
}
return nil
}
func (m *_ModbusPDUReadFileRecordResponse) GetTypeName() string {
return "ModbusPDUReadFileRecordResponse"
}
func (m *_ModbusPDUReadFileRecordResponse) GetLengthInBits(ctx context.Context) uint16 {
lengthInBits := uint16(m.ModbusPDUContract.(*_ModbusPDU).getLengthInBits(ctx))
// Implicit Field (byteCount)
lengthInBits += 8
// Array field
if len(m.Items) > 0 {
for _, element := range m.Items {
lengthInBits += element.GetLengthInBits(ctx)
}
}
return lengthInBits
}
func (m *_ModbusPDUReadFileRecordResponse) GetLengthInBytes(ctx context.Context) uint16 {
return m.GetLengthInBits(ctx) / 8
}
func (m *_ModbusPDUReadFileRecordResponse) parse(ctx context.Context, readBuffer utils.ReadBuffer, parent *_ModbusPDU, response bool) (__modbusPDUReadFileRecordResponse ModbusPDUReadFileRecordResponse, err error) {
m.ModbusPDUContract = parent
parent._SubType = m
positionAware := readBuffer
_ = positionAware
if pullErr := readBuffer.PullContext("ModbusPDUReadFileRecordResponse"); pullErr != nil {
return nil, errors.Wrap(pullErr, "Error pulling for ModbusPDUReadFileRecordResponse")
}
currentPos := positionAware.GetPos()
_ = currentPos
byteCount, err := ReadImplicitField[uint8](ctx, "byteCount", ReadUnsignedByte(readBuffer, uint8(8)))
if err != nil {
return nil, errors.Wrap(err, fmt.Sprintf("Error parsing 'byteCount' field"))
}
_ = byteCount
items, err := ReadLengthArrayField[ModbusPDUReadFileRecordResponseItem](ctx, "items", ReadComplex[ModbusPDUReadFileRecordResponseItem](ModbusPDUReadFileRecordResponseItemParseWithBuffer, readBuffer), int(byteCount))
if err != nil {
return nil, errors.Wrap(err, fmt.Sprintf("Error parsing 'items' field"))
}
m.Items = items
if closeErr := readBuffer.CloseContext("ModbusPDUReadFileRecordResponse"); closeErr != nil {
return nil, errors.Wrap(closeErr, "Error closing for ModbusPDUReadFileRecordResponse")
}
return m, nil
}
func (m *_ModbusPDUReadFileRecordResponse) 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 *_ModbusPDUReadFileRecordResponse) SerializeWithWriteBuffer(ctx context.Context, writeBuffer utils.WriteBuffer) error {
positionAware := writeBuffer
_ = positionAware
log := zerolog.Ctx(ctx)
_ = log
itemsArraySizeInBytes := func(items []ModbusPDUReadFileRecordResponseItem) uint32 {
var sizeInBytes uint32 = 0
for _, v := range items {
sizeInBytes += uint32(v.GetLengthInBytes(ctx))
}
return sizeInBytes
}
ser := func() error {
if pushErr := writeBuffer.PushContext("ModbusPDUReadFileRecordResponse"); pushErr != nil {
return errors.Wrap(pushErr, "Error pushing for ModbusPDUReadFileRecordResponse")
}
byteCount := uint8(uint8(itemsArraySizeInBytes(m.GetItems())))
if err := WriteImplicitField(ctx, "byteCount", byteCount, WriteUnsignedByte(writeBuffer, 8)); err != nil {
return errors.Wrap(err, "Error serializing 'byteCount' field")
}
if err := WriteComplexTypeArrayField(ctx, "items", m.GetItems(), writeBuffer); err != nil {
return errors.Wrap(err, "Error serializing 'items' field")
}
if popErr := writeBuffer.PopContext("ModbusPDUReadFileRecordResponse"); popErr != nil {
return errors.Wrap(popErr, "Error popping for ModbusPDUReadFileRecordResponse")
}
return nil
}
return m.ModbusPDUContract.(*_ModbusPDU).serializeParent(ctx, writeBuffer, m, ser)
}
func (m *_ModbusPDUReadFileRecordResponse) IsModbusPDUReadFileRecordResponse() {}
func (m *_ModbusPDUReadFileRecordResponse) DeepCopy() any {
return m.deepCopy()
}
func (m *_ModbusPDUReadFileRecordResponse) deepCopy() *_ModbusPDUReadFileRecordResponse {
if m == nil {
return nil
}
_ModbusPDUReadFileRecordResponseCopy := &_ModbusPDUReadFileRecordResponse{
m.ModbusPDUContract.(*_ModbusPDU).deepCopy(),
utils.DeepCopySlice[ModbusPDUReadFileRecordResponseItem, ModbusPDUReadFileRecordResponseItem](m.Items),
}
_ModbusPDUReadFileRecordResponseCopy.ModbusPDUContract.(*_ModbusPDU)._SubType = m
return _ModbusPDUReadFileRecordResponseCopy
}
func (m *_ModbusPDUReadFileRecordResponse) 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()
}