blob: 26d3724e2c6d1ffa4e01a36b6619c2e65967e811 [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.
// HVACAuxiliaryLevel is the corresponding interface of HVACAuxiliaryLevel
type HVACAuxiliaryLevel interface {
fmt.Stringer
utils.LengthAware
utils.Serializable
utils.Copyable
// GetFanMode returns FanMode (property field)
GetFanMode() bool
// GetMode returns Mode (property field)
GetMode() uint8
// GetIsFanModeAutomatic returns IsFanModeAutomatic (virtual field)
GetIsFanModeAutomatic() bool
// GetIsFanModeContinuous returns IsFanModeContinuous (virtual field)
GetIsFanModeContinuous() bool
// GetIsFanSpeedAtDefaultSpeed returns IsFanSpeedAtDefaultSpeed (virtual field)
GetIsFanSpeedAtDefaultSpeed() bool
// GetSpeedSettings returns SpeedSettings (virtual field)
GetSpeedSettings() uint8
// IsHVACAuxiliaryLevel is a marker method to prevent unintentional type checks (interfaces of same signature)
IsHVACAuxiliaryLevel()
// CreateBuilder creates a HVACAuxiliaryLevelBuilder
CreateHVACAuxiliaryLevelBuilder() HVACAuxiliaryLevelBuilder
}
// _HVACAuxiliaryLevel is the data-structure of this message
type _HVACAuxiliaryLevel struct {
FanMode bool
Mode uint8
// Reserved Fields
reservedField0 *bool
}
var _ HVACAuxiliaryLevel = (*_HVACAuxiliaryLevel)(nil)
// NewHVACAuxiliaryLevel factory function for _HVACAuxiliaryLevel
func NewHVACAuxiliaryLevel(fanMode bool, mode uint8) *_HVACAuxiliaryLevel {
return &_HVACAuxiliaryLevel{FanMode: fanMode, Mode: mode}
}
///////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////
/////////////////////// Builder
///////////////////////
// HVACAuxiliaryLevelBuilder is a builder for HVACAuxiliaryLevel
type HVACAuxiliaryLevelBuilder interface {
utils.Copyable
// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
WithMandatoryFields(fanMode bool, mode uint8) HVACAuxiliaryLevelBuilder
// WithFanMode adds FanMode (property field)
WithFanMode(bool) HVACAuxiliaryLevelBuilder
// WithMode adds Mode (property field)
WithMode(uint8) HVACAuxiliaryLevelBuilder
// Build builds the HVACAuxiliaryLevel or returns an error if something is wrong
Build() (HVACAuxiliaryLevel, error)
// MustBuild does the same as Build but panics on error
MustBuild() HVACAuxiliaryLevel
}
// NewHVACAuxiliaryLevelBuilder() creates a HVACAuxiliaryLevelBuilder
func NewHVACAuxiliaryLevelBuilder() HVACAuxiliaryLevelBuilder {
return &_HVACAuxiliaryLevelBuilder{_HVACAuxiliaryLevel: new(_HVACAuxiliaryLevel)}
}
type _HVACAuxiliaryLevelBuilder struct {
*_HVACAuxiliaryLevel
err *utils.MultiError
}
var _ (HVACAuxiliaryLevelBuilder) = (*_HVACAuxiliaryLevelBuilder)(nil)
func (b *_HVACAuxiliaryLevelBuilder) WithMandatoryFields(fanMode bool, mode uint8) HVACAuxiliaryLevelBuilder {
return b.WithFanMode(fanMode).WithMode(mode)
}
func (b *_HVACAuxiliaryLevelBuilder) WithFanMode(fanMode bool) HVACAuxiliaryLevelBuilder {
b.FanMode = fanMode
return b
}
func (b *_HVACAuxiliaryLevelBuilder) WithMode(mode uint8) HVACAuxiliaryLevelBuilder {
b.Mode = mode
return b
}
func (b *_HVACAuxiliaryLevelBuilder) Build() (HVACAuxiliaryLevel, error) {
if b.err != nil {
return nil, errors.Wrap(b.err, "error occurred during build")
}
return b._HVACAuxiliaryLevel.deepCopy(), nil
}
func (b *_HVACAuxiliaryLevelBuilder) MustBuild() HVACAuxiliaryLevel {
build, err := b.Build()
if err != nil {
panic(err)
}
return build
}
func (b *_HVACAuxiliaryLevelBuilder) DeepCopy() any {
_copy := b.CreateHVACAuxiliaryLevelBuilder().(*_HVACAuxiliaryLevelBuilder)
if b.err != nil {
_copy.err = b.err.DeepCopy().(*utils.MultiError)
}
return _copy
}
// CreateHVACAuxiliaryLevelBuilder creates a HVACAuxiliaryLevelBuilder
func (b *_HVACAuxiliaryLevel) CreateHVACAuxiliaryLevelBuilder() HVACAuxiliaryLevelBuilder {
if b == nil {
return NewHVACAuxiliaryLevelBuilder()
}
return &_HVACAuxiliaryLevelBuilder{_HVACAuxiliaryLevel: b.deepCopy()}
}
///////////////////////
///////////////////////
///////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////
/////////////////////// Accessors for property fields.
///////////////////////
func (m *_HVACAuxiliaryLevel) GetFanMode() bool {
return m.FanMode
}
func (m *_HVACAuxiliaryLevel) GetMode() uint8 {
return m.Mode
}
///////////////////////
///////////////////////
///////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////
/////////////////////// Accessors for virtual fields.
///////////////////////
func (m *_HVACAuxiliaryLevel) GetIsFanModeAutomatic() bool {
ctx := context.Background()
_ = ctx
return bool(!(m.GetFanMode()))
}
func (m *_HVACAuxiliaryLevel) GetIsFanModeContinuous() bool {
ctx := context.Background()
_ = ctx
return bool(m.GetFanMode())
}
func (m *_HVACAuxiliaryLevel) GetIsFanSpeedAtDefaultSpeed() bool {
ctx := context.Background()
_ = ctx
return bool(bool((m.GetMode()) == (0x00)))
}
func (m *_HVACAuxiliaryLevel) GetSpeedSettings() uint8 {
ctx := context.Background()
_ = ctx
return uint8(m.GetMode())
}
///////////////////////
///////////////////////
///////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////
// Deprecated: use the interface for direct cast
func CastHVACAuxiliaryLevel(structType any) HVACAuxiliaryLevel {
if casted, ok := structType.(HVACAuxiliaryLevel); ok {
return casted
}
if casted, ok := structType.(*HVACAuxiliaryLevel); ok {
return *casted
}
return nil
}
func (m *_HVACAuxiliaryLevel) GetTypeName() string {
return "HVACAuxiliaryLevel"
}
func (m *_HVACAuxiliaryLevel) GetLengthInBits(ctx context.Context) uint16 {
lengthInBits := uint16(0)
// Reserved Field (reserved)
lengthInBits += 1
// Simple field (fanMode)
lengthInBits += 1
// A virtual field doesn't have any in- or output.
// A virtual field doesn't have any in- or output.
// Simple field (mode)
lengthInBits += 6
// A virtual field doesn't have any in- or output.
// A virtual field doesn't have any in- or output.
return lengthInBits
}
func (m *_HVACAuxiliaryLevel) GetLengthInBytes(ctx context.Context) uint16 {
return m.GetLengthInBits(ctx) / 8
}
func HVACAuxiliaryLevelParse(ctx context.Context, theBytes []byte) (HVACAuxiliaryLevel, error) {
return HVACAuxiliaryLevelParseWithBuffer(ctx, utils.NewReadBufferByteBased(theBytes))
}
func HVACAuxiliaryLevelParseWithBufferProducer() func(ctx context.Context, readBuffer utils.ReadBuffer) (HVACAuxiliaryLevel, error) {
return func(ctx context.Context, readBuffer utils.ReadBuffer) (HVACAuxiliaryLevel, error) {
return HVACAuxiliaryLevelParseWithBuffer(ctx, readBuffer)
}
}
func HVACAuxiliaryLevelParseWithBuffer(ctx context.Context, readBuffer utils.ReadBuffer) (HVACAuxiliaryLevel, error) {
v, err := (&_HVACAuxiliaryLevel{}).parse(ctx, readBuffer)
if err != nil {
return nil, err
}
return v, nil
}
func (m *_HVACAuxiliaryLevel) parse(ctx context.Context, readBuffer utils.ReadBuffer) (__hVACAuxiliaryLevel HVACAuxiliaryLevel, err error) {
positionAware := readBuffer
_ = positionAware
if pullErr := readBuffer.PullContext("HVACAuxiliaryLevel"); pullErr != nil {
return nil, errors.Wrap(pullErr, "Error pulling for HVACAuxiliaryLevel")
}
currentPos := positionAware.GetPos()
_ = currentPos
reservedField0, err := ReadReservedField(ctx, "reserved", ReadBoolean(readBuffer), bool(false))
if err != nil {
return nil, errors.Wrap(err, fmt.Sprintf("Error parsing reserved field"))
}
m.reservedField0 = reservedField0
fanMode, err := ReadSimpleField(ctx, "fanMode", ReadBoolean(readBuffer))
if err != nil {
return nil, errors.Wrap(err, fmt.Sprintf("Error parsing 'fanMode' field"))
}
m.FanMode = fanMode
isFanModeAutomatic, err := ReadVirtualField[bool](ctx, "isFanModeAutomatic", (*bool)(nil), !(fanMode))
if err != nil {
return nil, errors.Wrap(err, fmt.Sprintf("Error parsing 'isFanModeAutomatic' field"))
}
_ = isFanModeAutomatic
isFanModeContinuous, err := ReadVirtualField[bool](ctx, "isFanModeContinuous", (*bool)(nil), fanMode)
if err != nil {
return nil, errors.Wrap(err, fmt.Sprintf("Error parsing 'isFanModeContinuous' field"))
}
_ = isFanModeContinuous
mode, err := ReadSimpleField(ctx, "mode", ReadUnsignedByte(readBuffer, uint8(6)))
if err != nil {
return nil, errors.Wrap(err, fmt.Sprintf("Error parsing 'mode' field"))
}
m.Mode = mode
isFanSpeedAtDefaultSpeed, err := ReadVirtualField[bool](ctx, "isFanSpeedAtDefaultSpeed", (*bool)(nil), bool((mode) == (0x00)))
if err != nil {
return nil, errors.Wrap(err, fmt.Sprintf("Error parsing 'isFanSpeedAtDefaultSpeed' field"))
}
_ = isFanSpeedAtDefaultSpeed
speedSettings, err := ReadVirtualField[uint8](ctx, "speedSettings", (*uint8)(nil), mode)
if err != nil {
return nil, errors.Wrap(err, fmt.Sprintf("Error parsing 'speedSettings' field"))
}
_ = speedSettings
if closeErr := readBuffer.CloseContext("HVACAuxiliaryLevel"); closeErr != nil {
return nil, errors.Wrap(closeErr, "Error closing for HVACAuxiliaryLevel")
}
return m, nil
}
func (m *_HVACAuxiliaryLevel) 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 *_HVACAuxiliaryLevel) SerializeWithWriteBuffer(ctx context.Context, writeBuffer utils.WriteBuffer) error {
positionAware := writeBuffer
_ = positionAware
log := zerolog.Ctx(ctx)
_ = log
if pushErr := writeBuffer.PushContext("HVACAuxiliaryLevel"); pushErr != nil {
return errors.Wrap(pushErr, "Error pushing for HVACAuxiliaryLevel")
}
if err := WriteReservedField[bool](ctx, "reserved", bool(false), WriteBoolean(writeBuffer)); err != nil {
return errors.Wrap(err, "Error serializing 'reserved' field number 1")
}
if err := WriteSimpleField[bool](ctx, "fanMode", m.GetFanMode(), WriteBoolean(writeBuffer)); err != nil {
return errors.Wrap(err, "Error serializing 'fanMode' field")
}
// Virtual field
isFanModeAutomatic := m.GetIsFanModeAutomatic()
_ = isFanModeAutomatic
if _isFanModeAutomaticErr := writeBuffer.WriteVirtual(ctx, "isFanModeAutomatic", m.GetIsFanModeAutomatic()); _isFanModeAutomaticErr != nil {
return errors.Wrap(_isFanModeAutomaticErr, "Error serializing 'isFanModeAutomatic' field")
}
// Virtual field
isFanModeContinuous := m.GetIsFanModeContinuous()
_ = isFanModeContinuous
if _isFanModeContinuousErr := writeBuffer.WriteVirtual(ctx, "isFanModeContinuous", m.GetIsFanModeContinuous()); _isFanModeContinuousErr != nil {
return errors.Wrap(_isFanModeContinuousErr, "Error serializing 'isFanModeContinuous' field")
}
if err := WriteSimpleField[uint8](ctx, "mode", m.GetMode(), WriteUnsignedByte(writeBuffer, 6)); err != nil {
return errors.Wrap(err, "Error serializing 'mode' field")
}
// Virtual field
isFanSpeedAtDefaultSpeed := m.GetIsFanSpeedAtDefaultSpeed()
_ = isFanSpeedAtDefaultSpeed
if _isFanSpeedAtDefaultSpeedErr := writeBuffer.WriteVirtual(ctx, "isFanSpeedAtDefaultSpeed", m.GetIsFanSpeedAtDefaultSpeed()); _isFanSpeedAtDefaultSpeedErr != nil {
return errors.Wrap(_isFanSpeedAtDefaultSpeedErr, "Error serializing 'isFanSpeedAtDefaultSpeed' field")
}
// Virtual field
speedSettings := m.GetSpeedSettings()
_ = speedSettings
if _speedSettingsErr := writeBuffer.WriteVirtual(ctx, "speedSettings", m.GetSpeedSettings()); _speedSettingsErr != nil {
return errors.Wrap(_speedSettingsErr, "Error serializing 'speedSettings' field")
}
if popErr := writeBuffer.PopContext("HVACAuxiliaryLevel"); popErr != nil {
return errors.Wrap(popErr, "Error popping for HVACAuxiliaryLevel")
}
return nil
}
func (m *_HVACAuxiliaryLevel) IsHVACAuxiliaryLevel() {}
func (m *_HVACAuxiliaryLevel) DeepCopy() any {
return m.deepCopy()
}
func (m *_HVACAuxiliaryLevel) deepCopy() *_HVACAuxiliaryLevel {
if m == nil {
return nil
}
_HVACAuxiliaryLevelCopy := &_HVACAuxiliaryLevel{
m.FanMode,
m.Mode,
m.reservedField0,
}
return _HVACAuxiliaryLevelCopy
}
func (m *_HVACAuxiliaryLevel) 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()
}