blob: 223af9d943bfdc490cfbbafe1ac43a070cba456f [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"
"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.
// S7PayloadNotify8 is the corresponding interface of S7PayloadNotify8
type S7PayloadNotify8 interface {
fmt.Stringer
utils.LengthAware
utils.Serializable
utils.Copyable
S7PayloadUserDataItem
// GetAlarmMessage returns AlarmMessage (property field)
GetAlarmMessage() AlarmMessagePushType
// IsS7PayloadNotify8 is a marker method to prevent unintentional type checks (interfaces of same signature)
IsS7PayloadNotify8()
// CreateBuilder creates a S7PayloadNotify8Builder
CreateS7PayloadNotify8Builder() S7PayloadNotify8Builder
}
// _S7PayloadNotify8 is the data-structure of this message
type _S7PayloadNotify8 struct {
S7PayloadUserDataItemContract
AlarmMessage AlarmMessagePushType
}
var _ S7PayloadNotify8 = (*_S7PayloadNotify8)(nil)
var _ S7PayloadUserDataItemRequirements = (*_S7PayloadNotify8)(nil)
// NewS7PayloadNotify8 factory function for _S7PayloadNotify8
func NewS7PayloadNotify8(returnCode DataTransportErrorCode, transportSize DataTransportSize, dataLength uint16, alarmMessage AlarmMessagePushType) *_S7PayloadNotify8 {
if alarmMessage == nil {
panic("alarmMessage of type AlarmMessagePushType for S7PayloadNotify8 must not be nil")
}
_result := &_S7PayloadNotify8{
S7PayloadUserDataItemContract: NewS7PayloadUserDataItem(returnCode, transportSize, dataLength),
AlarmMessage: alarmMessage,
}
_result.S7PayloadUserDataItemContract.(*_S7PayloadUserDataItem)._SubType = _result
return _result
}
///////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////
/////////////////////// Builder
///////////////////////
// S7PayloadNotify8Builder is a builder for S7PayloadNotify8
type S7PayloadNotify8Builder interface {
utils.Copyable
// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
WithMandatoryFields(alarmMessage AlarmMessagePushType) S7PayloadNotify8Builder
// WithAlarmMessage adds AlarmMessage (property field)
WithAlarmMessage(AlarmMessagePushType) S7PayloadNotify8Builder
// WithAlarmMessageBuilder adds AlarmMessage (property field) which is build by the builder
WithAlarmMessageBuilder(func(AlarmMessagePushTypeBuilder) AlarmMessagePushTypeBuilder) S7PayloadNotify8Builder
// Done is used to finish work on this child and return (or create one if none) to the parent builder
Done() S7PayloadUserDataItemBuilder
// Build builds the S7PayloadNotify8 or returns an error if something is wrong
Build() (S7PayloadNotify8, error)
// MustBuild does the same as Build but panics on error
MustBuild() S7PayloadNotify8
}
// NewS7PayloadNotify8Builder() creates a S7PayloadNotify8Builder
func NewS7PayloadNotify8Builder() S7PayloadNotify8Builder {
return &_S7PayloadNotify8Builder{_S7PayloadNotify8: new(_S7PayloadNotify8)}
}
type _S7PayloadNotify8Builder struct {
*_S7PayloadNotify8
parentBuilder *_S7PayloadUserDataItemBuilder
err *utils.MultiError
}
var _ (S7PayloadNotify8Builder) = (*_S7PayloadNotify8Builder)(nil)
func (b *_S7PayloadNotify8Builder) setParent(contract S7PayloadUserDataItemContract) {
b.S7PayloadUserDataItemContract = contract
contract.(*_S7PayloadUserDataItem)._SubType = b._S7PayloadNotify8
}
func (b *_S7PayloadNotify8Builder) WithMandatoryFields(alarmMessage AlarmMessagePushType) S7PayloadNotify8Builder {
return b.WithAlarmMessage(alarmMessage)
}
func (b *_S7PayloadNotify8Builder) WithAlarmMessage(alarmMessage AlarmMessagePushType) S7PayloadNotify8Builder {
b.AlarmMessage = alarmMessage
return b
}
func (b *_S7PayloadNotify8Builder) WithAlarmMessageBuilder(builderSupplier func(AlarmMessagePushTypeBuilder) AlarmMessagePushTypeBuilder) S7PayloadNotify8Builder {
builder := builderSupplier(b.AlarmMessage.CreateAlarmMessagePushTypeBuilder())
var err error
b.AlarmMessage, err = builder.Build()
if err != nil {
if b.err == nil {
b.err = &utils.MultiError{MainError: errors.New("sub builder failed")}
}
b.err.Append(errors.Wrap(err, "AlarmMessagePushTypeBuilder failed"))
}
return b
}
func (b *_S7PayloadNotify8Builder) Build() (S7PayloadNotify8, error) {
if b.AlarmMessage == nil {
if b.err == nil {
b.err = new(utils.MultiError)
}
b.err.Append(errors.New("mandatory field 'alarmMessage' not set"))
}
if b.err != nil {
return nil, errors.Wrap(b.err, "error occurred during build")
}
return b._S7PayloadNotify8.deepCopy(), nil
}
func (b *_S7PayloadNotify8Builder) MustBuild() S7PayloadNotify8 {
build, err := b.Build()
if err != nil {
panic(err)
}
return build
}
func (b *_S7PayloadNotify8Builder) Done() S7PayloadUserDataItemBuilder {
if b.parentBuilder == nil {
b.parentBuilder = NewS7PayloadUserDataItemBuilder().(*_S7PayloadUserDataItemBuilder)
}
return b.parentBuilder
}
func (b *_S7PayloadNotify8Builder) buildForS7PayloadUserDataItem() (S7PayloadUserDataItem, error) {
return b.Build()
}
func (b *_S7PayloadNotify8Builder) DeepCopy() any {
_copy := b.CreateS7PayloadNotify8Builder().(*_S7PayloadNotify8Builder)
if b.err != nil {
_copy.err = b.err.DeepCopy().(*utils.MultiError)
}
return _copy
}
// CreateS7PayloadNotify8Builder creates a S7PayloadNotify8Builder
func (b *_S7PayloadNotify8) CreateS7PayloadNotify8Builder() S7PayloadNotify8Builder {
if b == nil {
return NewS7PayloadNotify8Builder()
}
return &_S7PayloadNotify8Builder{_S7PayloadNotify8: b.deepCopy()}
}
///////////////////////
///////////////////////
///////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////
/////////////////////// Accessors for discriminator values.
///////////////////////
func (m *_S7PayloadNotify8) GetCpuFunctionGroup() uint8 {
return 0x04
}
func (m *_S7PayloadNotify8) GetCpuFunctionType() uint8 {
return 0x00
}
func (m *_S7PayloadNotify8) GetCpuSubfunction() uint8 {
return 0x16
}
///////////////////////
///////////////////////
///////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////
func (m *_S7PayloadNotify8) GetParent() S7PayloadUserDataItemContract {
return m.S7PayloadUserDataItemContract
}
///////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////
/////////////////////// Accessors for property fields.
///////////////////////
func (m *_S7PayloadNotify8) GetAlarmMessage() AlarmMessagePushType {
return m.AlarmMessage
}
///////////////////////
///////////////////////
///////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////
// Deprecated: use the interface for direct cast
func CastS7PayloadNotify8(structType any) S7PayloadNotify8 {
if casted, ok := structType.(S7PayloadNotify8); ok {
return casted
}
if casted, ok := structType.(*S7PayloadNotify8); ok {
return *casted
}
return nil
}
func (m *_S7PayloadNotify8) GetTypeName() string {
return "S7PayloadNotify8"
}
func (m *_S7PayloadNotify8) GetLengthInBits(ctx context.Context) uint16 {
lengthInBits := uint16(m.S7PayloadUserDataItemContract.(*_S7PayloadUserDataItem).getLengthInBits(ctx))
// Simple field (alarmMessage)
lengthInBits += m.AlarmMessage.GetLengthInBits(ctx)
return lengthInBits
}
func (m *_S7PayloadNotify8) GetLengthInBytes(ctx context.Context) uint16 {
return m.GetLengthInBits(ctx) / 8
}
func (m *_S7PayloadNotify8) parse(ctx context.Context, readBuffer utils.ReadBuffer, parent *_S7PayloadUserDataItem, cpuFunctionGroup uint8, cpuFunctionType uint8, cpuSubfunction uint8) (__s7PayloadNotify8 S7PayloadNotify8, err error) {
m.S7PayloadUserDataItemContract = parent
parent._SubType = m
positionAware := readBuffer
_ = positionAware
if pullErr := readBuffer.PullContext("S7PayloadNotify8"); pullErr != nil {
return nil, errors.Wrap(pullErr, "Error pulling for S7PayloadNotify8")
}
currentPos := positionAware.GetPos()
_ = currentPos
alarmMessage, err := ReadSimpleField[AlarmMessagePushType](ctx, "alarmMessage", ReadComplex[AlarmMessagePushType](AlarmMessagePushTypeParseWithBuffer, readBuffer))
if err != nil {
return nil, errors.Wrap(err, fmt.Sprintf("Error parsing 'alarmMessage' field"))
}
m.AlarmMessage = alarmMessage
if closeErr := readBuffer.CloseContext("S7PayloadNotify8"); closeErr != nil {
return nil, errors.Wrap(closeErr, "Error closing for S7PayloadNotify8")
}
return m, nil
}
func (m *_S7PayloadNotify8) 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 *_S7PayloadNotify8) SerializeWithWriteBuffer(ctx context.Context, writeBuffer utils.WriteBuffer) error {
positionAware := writeBuffer
_ = positionAware
log := zerolog.Ctx(ctx)
_ = log
ser := func() error {
if pushErr := writeBuffer.PushContext("S7PayloadNotify8"); pushErr != nil {
return errors.Wrap(pushErr, "Error pushing for S7PayloadNotify8")
}
if err := WriteSimpleField[AlarmMessagePushType](ctx, "alarmMessage", m.GetAlarmMessage(), WriteComplex[AlarmMessagePushType](writeBuffer)); err != nil {
return errors.Wrap(err, "Error serializing 'alarmMessage' field")
}
if popErr := writeBuffer.PopContext("S7PayloadNotify8"); popErr != nil {
return errors.Wrap(popErr, "Error popping for S7PayloadNotify8")
}
return nil
}
return m.S7PayloadUserDataItemContract.(*_S7PayloadUserDataItem).serializeParent(ctx, writeBuffer, m, ser)
}
func (m *_S7PayloadNotify8) IsS7PayloadNotify8() {}
func (m *_S7PayloadNotify8) DeepCopy() any {
return m.deepCopy()
}
func (m *_S7PayloadNotify8) deepCopy() *_S7PayloadNotify8 {
if m == nil {
return nil
}
_S7PayloadNotify8Copy := &_S7PayloadNotify8{
m.S7PayloadUserDataItemContract.(*_S7PayloadUserDataItem).deepCopy(),
utils.DeepCopy[AlarmMessagePushType](m.AlarmMessage),
}
_S7PayloadNotify8Copy.S7PayloadUserDataItemContract.(*_S7PayloadUserDataItem)._SubType = m
return _S7PayloadNotify8Copy
}
func (m *_S7PayloadNotify8) 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()
}