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

Copy Markdown View Source

The Delete Object Error is returned when a Delete Object service request fails.

It carries the standard error class and error code explaining why the object could not be deleted (for example, the object may be referenced by other objects, or the client may lack sufficient privilege).

Summary

Types

t()

Error response for a failed Delete Object service.

Functions

from_apdu(error)

Converts a received Error APDU into a DeleteObjectError struct.

to_apdu(error, invoke_id \\ 0)

Constructs an Error APDU from a DeleteObjectError struct.

Types

t()

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

Error response for a failed Delete Object service.

Functions

from_apdu(error)

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

Converts a received Error APDU into a DeleteObjectError 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 DeleteObjectError struct.