Namespace SIMDispatcher.Core.Models

Classes

Address: Represents a specific address within a district, providing detailed street-level information. This record extends the AddressDistrict to include street name and potential street number ranges, which can be used to generate random house numbers within simulations.

AddressCity: Represents a city within a commune for addressing purposes. This record captures city-specific details such as city identifiers and names, extending the commune-level details from the AddressCommune.

AddressCommune: Represents a commune-level division within a state or region for addressing purposes. This record extends the AddressState to provide additional details specific to the commune level, such as commune identifiers and names.

AddressDistrict: Represents a district within a city, including detailed geographic and administrative data. This record extends the AddressCity and provides additional details specific to the district level, such as the district's unique identifier, name, postal code, geographic coordinates, and optional phone prefix.

AddressPackage: Represents a package of addresses managed within the platform by a user Owner. Packages can be marked as public or private. Create own address packages to build an own address database.

AddressState: Represents the state or region information within an address package, including its association with a specific country.

Commandcenter: Represents a dispatch center within the simulation platform, managing a variety of emergency and non-emergency responses. The Commandcenter model encapsulates a wide range of operational details, including operational statistics, configurable settings, and equipment options. It also covers administrative aspects, allowing for robust management and customization of emergency service dispatching. This model serves as a central point for configuring and controlling the functionality and responsiveness of the simulated dispatch operations.

CommandcenterArea

CommandcenterCustomEquipment: Enables the creation of custom equipment for units within a command center, which assists in the suggestion process during dispatch operations but does not influence simulation outcomes directly.

Keyword: Represents the keyword associated with an emergency, which acts as a key identifier in categorizing and managing the dispatch of units based on specific emergency conditions and requirements.

KeywordEquipment: Represents a specific type of equipment associated with a keyword, detailing the quantity needed and the type of equipment. This record is used to manage equipment requirements for specific emergency scenarios as specified by keywords.

KeywordTask: Represents a task associated with a keyword, detailing specific actions that may need to be performed during an emergency response. This record is used to manage and track mandatory or optional tasks for different scenarios.

Location: Represents a geographical location, including details such as address, point of interest, coordinates, and location accuracy. This record is used throughout the dispatch system to manage and validate the positions of units and incidents.

Missionload: Represents a data structure for scheduling simulated emergencies based on time and category within a dispatch center's operational plans. This record allows setting specific hours and the corresponding number of emergencies to be generated.

Poi: Represents a point of interest (POI) such as hospitals, fire stations, or other locations.

Radiogroup: Represents a radio group that can be associated with units.

Response

Response<T>

Statuspage: Represents a status page used for displaying unit statuses.

StatuspageUnit: Represents a unit associated with a status page. Will be grouped within other units by the value in Group.

Unit: Represents a unit within the area of a dispatch center.

UnitDutyPeriod: Represents a duty period for a unit. Duty periods are required if the DutyOptions property is set to OnlyOnPeriods.

UserInformation: Represents a shortcut of public available user information's.

Structs

CommandcenterError

Coordinates

Coordinates.UnitOfLength

EnumInformation: Represents detailed information about an enum type used in the system, including its name, numeric value, and localized description. This record is especially useful for displaying enum data dynamically in user interfaces.

Pagination: Represents pagination details and includes information about current page, total pages, page size, and total items.

ResponseProblem: Represents a response problem.

Enums

CommandcenterCategory: Defines categories for dispatch centers, which influence the prefix of the dispatch center's name and cater to user-specific choices. This enumeration is used to categorize different types of dispatch center's based on their operational focus and region, and it assists in the organization and identification of dispatch center's on the platform. The GetDisplayDescription(Enum) returns localized display names.

CommandcenterClassification: Defines a grading system for command centers based on data availability and evaluation, where 'A' represents the highest grade with ample data and 'F' represents new, unrated, or data-deficient centers.

CommandcenterErrorLevel: Defines the severity levels of errors and notifications within the command center.

CommandcenterOption: Defines various configurable options within the command center that affect operational behaviors and dispatch protocols.

Country

LocationAccuracy: Defines levels of accuracy for a location's address data, used to specify how precisely the coordinates are identified from the geocoding processor.

MissionCategory: Enumerates the different categories of missions handled by the simulation platform, each representing a specific type of emergency response or transport service.

PoiCategory: Represents the category of a point of interest (POI).

PoiHospitalDepartment: Represents departments available at hospitals for patient treatment.

ResponseProblemCode: Represents response problem codes.

StatuspageDisplayOption: Represents the display options of a unit for a status page.

UnitCategory: Represents the category of a unit. By setting a value to CategoryOverride, this can be cosmetically overridden.

UnitDispatchOption: Represents the options for unit dispatch, determining how units are selected for dispatch.

UnitDoctorOption: Represents the options for doctors assigned to a unit.

UnitDutyOptions: Represents the duty options for a unit.

UnitEquipment: Represents the equipment types available for units. The equipment is essential for the simulation, as operation locations may require specific equipment for tasks. If a unit has the required equipment, it can proceed with the task. If not, a unit with that equipment is necessary. Enum members starting with Custom* or is Command,Engine Ladder or Tanker are not tied to specific functionalities but serve as tags for suggestions before dispatch.

UnitStatus: Represents the status of a unit, indicating its availability for dispatch by the dispatcher.