BACnet.Protocol.Services.Error.RemoveListElementError (bacstack v0.1.0-dev.1)

The Remove List Element Error is returned when a Remove List Element service request fails.

It indicates which element in the list of values being removed caused the failure via the first_failed_element_number field. This is especially useful when removing multiple elements in one request.

Summary

Types

t()

Error response for a failed Remove List Element service.

Functions

from_apdu(error)

Converts a received Error APDU into a RemoveListElementError struct.

to_apdu(error, invoke_id \\ 0)

Constructs an Error APDU from a RemoveListElementError struct.

Types

t()

@type t() :: %BACnet.Protocol.Services.Error.RemoveListElementError{
  error_class: BACnet.Protocol.Constants.error_class() | non_neg_integer(),
  error_code: BACnet.Protocol.Constants.error_code() | non_neg_integer(),
  first_failed_element_number: non_neg_integer()
}

Error response for a failed Remove List Element service.

Reports the standard error plus the 1-based index of the first element in the removal list that triggered the error.

If first_failed_element_number is 0, then the request is not invalid due to the "List of Elements" parameters.

Functions

from_apdu(error)

@spec from_apdu(BACnet.Protocol.APDU.Error.t()) :: {:ok, t()} | {:error, term()}

Converts a received Error APDU into a RemoveListElementError struct.

to_apdu(error, invoke_id \\ 0)

@spec to_apdu(t(), 0..255) :: {:ok, BACnet.Protocol.APDU.Error.t()} | {:error, term()}

Constructs an Error APDU from a RemoveListElementError struct.