Table of Contents

Interface IUnit

Namespace
XENBIT.ResQueServe.Abstractions.Interfaces
Assembly
RQS.Abstractions.dll
public interface IUnit : IUnitInfo, IShelf
Inherited Members

Properties

CallsignVerbal

The verbal callsign of the unit.

string? CallsignVerbal { get; set; }

Property Value

string

DispatchGroups

The dispatch groups associated with the unit. DispatchGroups DispatchGroups

string? DispatchGroups { get; set; }

Property Value

string

DispatchOption

The dispatch option of the unit, determining how the unit is automatically suggested by the system.

UnitDispatchOption DispatchOption { get; set; }

Property Value

UnitDispatchOption

DoctorOption

The doctor option of the unit. Only relevant for suggesters, who are looking for a doctor.

UnitDoctorOption DoctorOption { get; set; }

Property Value

UnitDoctorOption

DoctorPickupPoi

The point of interest (POI) where the doctor is picked up then value is set to.

IPoi? DoctorPickupPoi { get; set; }

Property Value

IPoi

DutyOptions

Determines the duty options of the unit, including its availability and reaction to dispatch.

UnitDutyOptions DutyOptions { get; set; }

Property Value

UnitDutyOptions

Remarks

If set to OnlyOnPeriods, unit duty periods in DutyPeriods are required.

DutyPeriods

The list of duty periods associated with the unit.

IEnumerable<IUnitDutyPeriod>? DutyPeriods { get; set; }

Property Value

IEnumerable<IUnitDutyPeriod>

Remarks

Required if DutyOptions is set to OnlyOnPeriods.

Equipments

The list of equipment associated with the unit.

IEnumerable<UnitEquipment>? Equipments { get; set; }

Property Value

IEnumerable<UnitEquipment>

ExternalAvailablePercent

The external availability percentage of the unit when referenced by another dispatch center. This value determines the unit's potential availability.

int ExternalAvailablePercent { get; set; }

Property Value

int

IsEquippedWithGps

Indicates whether the unit is equipped with GPS. This property determines whether the unit's geographical information is displayed on maps. It also affects automatic suggestions:

  • If 
    false
    , suggestions use the IPoi location for calculating the nearest units.
  • If 
    true
    and unit status is OnDutyAlongWay, suggestions use the real GPS location to calculate the distance to the operation location.
bool IsEquippedWithGps { get; set; }

Property Value

bool

IsFirstResponder

Indicates whether the unit is a first responder. This property affects suggestions and the unit's behavior on operation sites.

bool IsFirstResponder { get; set; }

Property Value

bool

IsNotVolunteerUnit

Indicates whether the unit is not a volunteer unit. Dispatch times will affect based on this value.

bool IsNotVolunteerUnit { get; set; }

Property Value

bool

IsStartingWithStatus6

Indicates whether the unit starts in a new session with status NotOnDuty. This property affects the visual representation only and does not affect the actual duty status of the unit. To control the unit's duty status, use the DutyOptions property. The unit will react to dispatches based on its duty status as determined by the DutyOptions.

bool IsStartingWithStatus6 { get; set; }

Property Value

bool

Poi

The point of interest (POI) where the unit is located.

IPoi Poi { get; set; }

Property Value

IPoi

RadioGroup

The radio group associated with the unit. Is null if not set.

IRadioGroup? RadioGroup { get; set; }

Property Value

IRadioGroup

Methods

CreateUnitInfoInstance() 

IUnitInfo CreateUnitInfoInstance()

Returns

IUnitInfo