plc4go/internal/plc4go/firmata/readwrite/model/FirmataMessage.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
//
//      http://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 (
	"github.com/apache/plc4x/plc4go/internal/plc4go/spi/utils"
	"github.com/pkg/errors"
)

// Code generated by build-utils. DO NOT EDIT.

// The data-structure of this message
type FirmataMessage struct {
	Child IFirmataMessageChild
}

// The corresponding interface
type IFirmataMessage interface {
	MessageType() uint8
	LengthInBytes() uint16
	LengthInBits() uint16
	Serialize(writeBuffer utils.WriteBuffer) error
}

type IFirmataMessageParent interface {
	SerializeParent(writeBuffer utils.WriteBuffer, child IFirmataMessage, serializeChildFunction func() error) error
	GetTypeName() string
}

type IFirmataMessageChild interface {
	Serialize(writeBuffer utils.WriteBuffer) error
	InitializeParent(parent *FirmataMessage)
	GetTypeName() string
	IFirmataMessage
}

func NewFirmataMessage() *FirmataMessage {
	return &FirmataMessage{}
}

func CastFirmataMessage(structType interface{}) *FirmataMessage {
	castFunc := func(typ interface{}) *FirmataMessage {
		if casted, ok := typ.(FirmataMessage); ok {
			return &casted
		}
		if casted, ok := typ.(*FirmataMessage); ok {
			return casted
		}
		return nil
	}
	return castFunc(structType)
}

func (m *FirmataMessage) GetTypeName() string {
	return "FirmataMessage"
}

func (m *FirmataMessage) LengthInBits() uint16 {
	return m.LengthInBitsConditional(false)
}

func (m *FirmataMessage) LengthInBitsConditional(lastItem bool) uint16 {
	return m.Child.LengthInBits()
}

func (m *FirmataMessage) ParentLengthInBits() uint16 {
	lengthInBits := uint16(0)
	// Discriminator Field (messageType)
	lengthInBits += 4

	return lengthInBits
}

func (m *FirmataMessage) LengthInBytes() uint16 {
	return m.LengthInBits() / 8
}

func FirmataMessageParse(readBuffer utils.ReadBuffer, response bool) (*FirmataMessage, error) {
	if pullErr := readBuffer.PullContext("FirmataMessage"); pullErr != nil {
		return nil, pullErr
	}

	// Discriminator Field (messageType) (Used as input to a switch field)
	messageType, _messageTypeErr := readBuffer.ReadUint8("messageType", 4)
	if _messageTypeErr != nil {
		return nil, errors.Wrap(_messageTypeErr, "Error parsing 'messageType' field")
	}

	// Switch Field (Depending on the discriminator values, passes the instantiation to a sub-type)
	var _parent *FirmataMessage
	var typeSwitchError error
	switch {
	case messageType == 0xE: // FirmataMessageAnalogIO
		_parent, typeSwitchError = FirmataMessageAnalogIOParse(readBuffer)
	case messageType == 0x9: // FirmataMessageDigitalIO
		_parent, typeSwitchError = FirmataMessageDigitalIOParse(readBuffer)
	case messageType == 0xC: // FirmataMessageSubscribeAnalogPinValue
		_parent, typeSwitchError = FirmataMessageSubscribeAnalogPinValueParse(readBuffer)
	case messageType == 0xD: // FirmataMessageSubscribeDigitalPinValue
		_parent, typeSwitchError = FirmataMessageSubscribeDigitalPinValueParse(readBuffer)
	case messageType == 0xF: // FirmataMessageCommand
		_parent, typeSwitchError = FirmataMessageCommandParse(readBuffer, response)
	default:
		// TODO: return actual type
		typeSwitchError = errors.New("Unmapped type")
	}
	if typeSwitchError != nil {
		return nil, errors.Wrap(typeSwitchError, "Error parsing sub-type for type-switch.")
	}

	if closeErr := readBuffer.CloseContext("FirmataMessage"); closeErr != nil {
		return nil, closeErr
	}

	// Finish initializing
	_parent.Child.InitializeParent(_parent)
	return _parent, nil
}

func (m *FirmataMessage) Serialize(writeBuffer utils.WriteBuffer) error {
	return m.Child.Serialize(writeBuffer)
}

func (m *FirmataMessage) SerializeParent(writeBuffer utils.WriteBuffer, child IFirmataMessage, serializeChildFunction func() error) error {
	if pushErr := writeBuffer.PushContext("FirmataMessage"); pushErr != nil {
		return pushErr
	}

	// Discriminator Field (messageType) (Used as input to a switch field)
	messageType := uint8(child.MessageType())
	_messageTypeErr := writeBuffer.WriteUint8("messageType", 4, (messageType))

	if _messageTypeErr != nil {
		return errors.Wrap(_messageTypeErr, "Error serializing 'messageType' field")
	}

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

	if popErr := writeBuffer.PopContext("FirmataMessage"); popErr != nil {
		return popErr
	}
	return nil
}

func (m *FirmataMessage) String() string {
	if m == nil {
		return "<nil>"
	}
	buffer := utils.NewBoxedWriteBufferWithOptions(true, true)
	m.Serialize(buffer)
	return buffer.GetBox().String()
}