Struct MissionDownloadResult

Namespace

MavNet.PX4.Missions

Assembly

MavNet.PX4.dll

Terminal state of one mission download transaction.

public readonly record struct MissionDownloadResult : IEquatable<MissionDownloadResult>

Implements

IEquatable<MissionDownloadResult>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

MissionDownloadResult(MissionTransactionStatus, IReadOnlyList<MissionItem>, uint?, TimeSpan)

Terminal state of one mission download transaction.

public MissionDownloadResult(MissionTransactionStatus Status, IReadOnlyList<MissionItem> Items, uint? OpaqueId, TimeSpan Elapsed)

Parameters

Status MissionTransactionStatus

High-level outcome category — see MissionTransactionStatus.

Items IReadOnlyList<MissionItem>

The downloaded items, in sequence order. Populated only on Accepted; empty for every other outcome.

OpaqueId uint?

On-vehicle plan id from the MISSION_COUNT sent by the vehicle. Populated only on Accepted. Use this to detect whether the on-vehicle mission has changed since a prior download/upload.

Elapsed TimeSpan

Wall-clock duration from download start to terminal outcome.

Properties

Elapsed

Wall-clock duration from download start to terminal outcome.

public TimeSpan Elapsed { get; init; }

Property Value

TimeSpan

IsAccepted

True iff Status is Accepted.

public bool IsAccepted { get; }

Property Value

bool

Items

The downloaded items, in sequence order. Populated only on Accepted; empty for every other outcome.

public IReadOnlyList<MissionItem> Items { get; init; }

Property Value

IReadOnlyList<MissionItem>

OpaqueId

On-vehicle plan id from the MISSION_COUNT sent by the vehicle. Populated only on Accepted. Use this to detect whether the on-vehicle mission has changed since a prior download/upload.

public uint? OpaqueId { get; init; }

Property Value

uint?

Status

High-level outcome category — see MissionTransactionStatus.

public MissionTransactionStatus Status { get; init; }

Property Value

MissionTransactionStatus