server

package
v0.7.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 21, 2024 License: MIT Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type DeviceConfiguration 

type DeviceConfiguration struct {
	*Feature

	*internal.DeviceConfigurationCommon
}

func NewDeviceConfiguration 

func NewDeviceConfiguration(localEntity spineapi.EntityLocalInterface) (*DeviceConfiguration, error)

func (*DeviceConfiguration) AddKeyValueDescription 

func (d *DeviceConfiguration) AddKeyValueDescription(
	description model.DeviceConfigurationKeyValueDescriptionDataType,
) *model.DeviceConfigurationKeyIdType

Add a new description data set and return the keyId

will return nil if the data set could not be added

func (*DeviceConfiguration) UpdateKeyValueDataForFilter 

func (d *DeviceConfiguration) UpdateKeyValueDataForFilter(
	data model.DeviceConfigurationKeyValueDataType,
	deleteElements *model.DeviceConfigurationKeyValueDataElementsType,
	filter model.DeviceConfigurationKeyValueDescriptionDataType,
) (resultErr error)

Set or update data set for a filter Elements provided in deleteElements will be removed from the data set before the update

Will return an error if the data set could not be updated

func (*DeviceConfiguration) UpdateKeyValueDataForKeyId 

func (d *DeviceConfiguration) UpdateKeyValueDataForKeyId(
	data model.DeviceConfigurationKeyValueDataType,
	deleteElements *model.DeviceConfigurationKeyValueDataElementsType,
	keyId model.DeviceConfigurationKeyIdType,
) (resultErr error)

Set or update data set for a keyId Elements provided in deleteElements will be removed from the data set before the update

Will return an error if the data set could not be updated

type DeviceDiagnosis 

type DeviceDiagnosis struct {
	*Feature

	*internal.DeviceDiagnosisCommon
}

func NewDeviceDiagnosis 

func NewDeviceDiagnosis(localEntity spineapi.EntityLocalInterface) (*DeviceDiagnosis, error)

func (*DeviceDiagnosis) SetLocalState 

func (d *DeviceDiagnosis) SetLocalState(operatingState *model.DeviceDiagnosisStateDataType)

set the local diagnosis state of the device

type ElectricalConnection 

type ElectricalConnection struct {
	*Feature

	*internal.ElectricalConnectionCommon
}

func NewElectricalConnection 

func NewElectricalConnection(localEntity spineapi.EntityLocalInterface) (*ElectricalConnection, error)

func (*ElectricalConnection) AddCharacteristic 

func (e *ElectricalConnection) AddCharacteristic(data model.ElectricalConnectionCharacteristicDataType) (*model.ElectricalConnectionCharacteristicIdType, error)

Add a new characteristic data set

Note: ElectricalConnectionId and ParameterId must be set, CharacteristicId will be set automatically

Will return an error if the data set could not be added

func (*ElectricalConnection) AddDescription 

func (e *ElectricalConnection) AddDescription(
	description model.ElectricalConnectionDescriptionDataType,
) error

Add a new description data set

NOTE: the electricalConnectionId has to be provided

will return nil if the data set could not be added

func (*ElectricalConnection) AddParameterDescription 

func (e *ElectricalConnection) AddParameterDescription(
	description model.ElectricalConnectionParameterDescriptionDataType,
) *model.ElectricalConnectionParameterIdType

Add a new parameter description data sett and return the parameterId

NOTE: the electricalConnectionId has to be provided, parameterId may not be provided

will return nil if the data set could not be added

func (*ElectricalConnection) UpdateCharacteristic 

func (e *ElectricalConnection) UpdateCharacteristic(
	data model.ElectricalConnectionCharacteristicDataType,
	deleteElements *model.ElectricalConnectionCharacteristicDataElementsType,
) error

Update data set for a filter Elements provided in deleteElements will be removed from the data set before the update

// ElectricalConnectionId, ParameterId and CharacteristicId must be set

Will return an error if the data set could not be updated

type Feature 

type Feature struct {
	// contains filtered or unexported fields
}

func NewFeature 

func NewFeature(
	featureType model.FeatureTypeType,
	localEntity spineapi.EntityLocalInterface) (*Feature, error)

type LoadControl 

type LoadControl struct {
	*Feature

	*internal.LoadControlCommon
}

func NewLoadControl 

func NewLoadControl(localEntity spineapi.EntityLocalInterface) (*LoadControl, error)

func (*LoadControl) AddLimitDescription 

func (l *LoadControl) AddLimitDescription(
	description model.LoadControlLimitDescriptionDataType,
) *model.LoadControlLimitIdType

Add a new description data set and return the limitId

NOTE: the limitId may not be provided

will return nil if the data set could not be added

func (*LoadControl) UpdateLimitDataForFilter 

func (l *LoadControl) UpdateLimitDataForFilter(
	data model.LoadControlLimitDataType,
	deleteElements *model.LoadControlLimitDataElementsType,
	filter model.LoadControlLimitDescriptionDataType,
) (resultErr error)

Set or update data set for a filter Elements provided in deleteElements will be removed from the data set before the update

Will return an error if the data set could not be updated

func (*LoadControl) UpdateLimitDataForId 

func (l *LoadControl) UpdateLimitDataForId(
	data model.LoadControlLimitDataType,
	deleteElements *model.LoadControlLimitDataElementsType,
	limitId model.LoadControlLimitIdType,
) (resultErr error)

Set or update data set for a limitId Elements provided in deleteElements will be removed from the data set before the update

Will return an error if the data set could not be updated

type Measurement 

type Measurement struct {
	*Feature

	*internal.MeasurementCommon
}

func NewMeasurement 

func NewMeasurement(localEntity spineapi.EntityLocalInterface) (*Measurement, error)

func (*Measurement) AddDescription 

func (m *Measurement) AddDescription(
	description model.MeasurementDescriptionDataType,
) *model.MeasurementIdType

Add a new parameter description data sett and return the measurementId

NOTE: the measurementId may not be provided

will return nil if the data set could not be added

func (*Measurement) UpdateDataForFilter 

func (m *Measurement) UpdateDataForFilter(
	data model.MeasurementDataType,
	deleteElements *model.MeasurementDataElementsType,
	filter model.MeasurementDescriptionDataType,
) (resultErr error)

Set or update data set for a filter Elements provided in deleteElements will be removed from the data set before the update

Will return an error if the data set could not be updated

func (*Measurement) UpdateDataForId 

func (m *Measurement) UpdateDataForId(
	data model.MeasurementDataType,
	deleteElements *model.MeasurementDataElementsType,
	measurementId model.MeasurementIdType,
) (resultErr error)

Set or update data set for a measurementId Elements provided in deleteElements will be removed from the data set before the update

Will return an error if the data set could not be updated

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.