Class Tour
Contains all information about a simplic disposition tour
Inheritance
Namespace: Simplic.PlugIn.Logistics.Disposition
Assembly: Simplic.PlugIn.Logistics.dll
Syntax
public class Tour : IMultiTenantCompatible
Constructors
| Improve this Doc View SourceTour()
Declaration
public Tour()
Properties
| Improve this Doc View SourceActualEndDate
Gets or sets the actual end date of the tour
Declaration
public DateTime? ActualEndDate { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.DateTime> |
ActualEndTime
Gets or sets the actual end time of the tour
Declaration
public TimeSpan? ActualEndTime { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.TimeSpan> |
ActualStartDate
Gets or sets the actual start date of the tour
Declaration
public DateTime? ActualStartDate { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.DateTime> |
ActualStartTime
Gets or sets the actual start time of the tour
Declaration
public TimeSpan? ActualStartTime { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.TimeSpan> |
CalculatedPrice
Gets or sets the calculated price
Declaration
public PreciseDecimal CalculatedPrice { get; set; }
Property Value
Type | Description |
---|---|
PreciseDecimal |
CarrierAddressContact
Gets or sets the carrier address
Declaration
public SAC.Contact.Contact CarrierAddressContact { get; set; }
Property Value
Type | Description |
---|---|
SAC.Contact.Contact |
CarrierAddressContactId
Gets or sets the carrier end address
Declaration
public Guid? CarrierAddressContactId { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Guid> |
CarrierDispatcherId
Gets or set the carrier dispatcher id
Declaration
public Guid? CarrierDispatcherId { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Guid> |
ConsecutiveTourId
Gets the consecutive unique tour id
Declaration
public long ConsecutiveTourId { get; }
Property Value
Type | Description |
---|---|
System.Int64 |
CreateDateTime
Gets or sets the create date time
Declaration
public DateTime CreateDateTime { get; set; }
Property Value
Type | Description |
---|---|
System.DateTime |
CreateUserId
Gets or sets the user id which has created the tour
Declaration
public int? CreateUserId { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Int32> |
CurrentPricing
Gets the current pricig configuration
Declaration
public PricingConfigurationInformation CurrentPricing { get; }
Property Value
Type | Description |
---|---|
PricingConfigurationInformation |
CustomerContact
Gets or sets the custoemr contact
Declaration
public SAC.Contact.Contact CustomerContact { get; set; }
Property Value
Type | Description |
---|---|
SAC.Contact.Contact |
CustomerContactId
Gets or sets the contact guid
Declaration
public Guid? CustomerContactId { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Guid> |
CustomPrice
Gets or sets the custom price
Declaration
public PreciseDecimal CustomPrice { get; set; }
Property Value
Type | Description |
---|---|
PreciseDecimal |
CustomPricingConfigurationId
Gets or sets the custom pricing configuration id
Declaration
public Guid? CustomPricingConfigurationId { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Guid> |
DriverId
Gets or sets the current driver id
Declaration
public Guid? DriverId { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Guid> |
DriverName
Gets or sets the driver name
Declaration
public string DriverName { get; }
Property Value
Type | Description |
---|---|
System.String |
EndAddressContact
Gets or sets the end address
Declaration
public SAC.Contact.Contact EndAddressContact { get; set; }
Property Value
Type | Description |
---|---|
SAC.Contact.Contact |
EndAddressContactId
Gets or sets the tour end address
Declaration
public Guid? EndAddressContactId { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Guid> |
EndAddressLatitude
Gets or sets the latitude of the end address
Declaration
public double? EndAddressLatitude { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Double> |
EndAddressLongitude
Gets or sets the longitude of the End address
Declaration
public double? EndAddressLongitude { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Double> |
EndDate
Gets or sets the end date (time must be ignored)
Declaration
public DateTime EndDate { get; set; }
Property Value
Type | Description |
---|---|
System.DateTime |
EndTime
Gets or sets the end time (date must be ignored)
Declaration
public TimeSpan EndTime { get; set; }
Property Value
Type | Description |
---|---|
System.TimeSpan |
ERPOrderNr
Gets or sets the ERP order Nr
Declaration
public string ERPOrderNr { get; set; }
Property Value
Type | Description |
---|---|
System.String |
ExternalDriverPhoneNumber
Gets or sets the external driver phone numer
Declaration
public string ExternalDriverPhoneNumber { get; set; }
Property Value
Type | Description |
---|---|
System.String |
ExtTourId
Gets or sets the external tour id
Declaration
public string ExtTourId { get; set; }
Property Value
Type | Description |
---|---|
System.String |
GeneratedTourId
Gets or sets the generated tour id
Declaration
public string GeneratedTourId { get; set; }
Property Value
Type | Description |
---|---|
System.String |
HasBillableShipmentCarrier
Gets or sets wether any shipments are billable
Declaration
public bool HasBillableShipmentCarrier { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
Id
Gets or sets the unique tour id
Declaration
public Guid Id { get; set; }
Property Value
Type | Description |
---|---|
System.Guid |
IsCollectingTour
Gets or sets whether this is a collect tour
Declaration
public bool IsCollectingTour { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsDeleted
Gets or sets whether the tour is deleted or not
Declaration
public bool IsDeleted { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsFinished
Gets or sets whether this tour has finished using telematic information
Declaration
public bool IsFinished { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsFullLoad
Gets or sets whether this is a full load tour
Declaration
public bool IsFullLoad { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsStarted
Gets or sets whether the tour has been started
Declaration
public bool IsStarted { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
SelectedTenant
Gets or sets the selected tenant object
Declaration
public OrganizationTenant SelectedTenant { get; set; }
Property Value
Type | Description |
---|---|
OrganizationTenant |
SetTourStartEndContactAutomatically
Gets or sets whether to set the tour start end contact automatically
Declaration
public bool SetTourStartEndContactAutomatically { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Shipments
Gets or sets all shipments that are connected with this tour
Declaration
public ICollection<Shipment> Shipments { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.ICollection<Shipment> |
StartAddressContact
Gets or sets the start address
Declaration
public SAC.Contact.Contact StartAddressContact { get; set; }
Property Value
Type | Description |
---|---|
SAC.Contact.Contact |
StartAddressContactId
Gets or sets the tour start address
Declaration
public Guid? StartAddressContactId { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Guid> |
StartAddressLatitude
Gets or sets the latitude of the start address
Declaration
public double? StartAddressLatitude { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Double> |
StartAddressLongitude
Gets or sets the longitude of the start address
Declaration
public double? StartAddressLongitude { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Double> |
StartDate
Gets or sets the start date (time must be ignored)
Declaration
public DateTime StartDate { get; set; }
Property Value
Type | Description |
---|---|
System.DateTime |
StartDayOfWeek
Gets or sets the start day of week
Declaration
public int StartDayOfWeek { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
StartTime
Gets or sets the start time (date must be ignored)
Declaration
public TimeSpan StartTime { get; set; }
Property Value
Type | Description |
---|---|
System.TimeSpan |
Status
Gets or sets the tour status
Declaration
public Guid Status { get; set; }
Property Value
Type | Description |
---|---|
System.Guid |
Stops
Gets all tour stops. Is empty untill LoadStops() is called.
Declaration
public IList<TourStop> Stops { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IList<TourStop> |
Subject
Gets or sets the tour description
Declaration
public string Subject { get; set; }
Property Value
Type | Description |
---|---|
System.String |
TenantId
Gets or sets the tenant id
Declaration
public Guid TenantId { get; set; }
Property Value
Type | Description |
---|---|
System.Guid |
Tenants
Gets or sets a list of available tenants
Declaration
public ObservableCollection<OrganizationTenant> Tenants { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.ObjectModel.ObservableCollection<OrganizationTenant> |
TractorUnitId
Gets or sets the Tractor unit id
Declaration
public Guid? TractorUnitId { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Guid> |
TractorUnitRegistrationNumber
Gets or sets the tractor unit registration numner
Declaration
public string TractorUnitRegistrationNumber { get; set; }
Property Value
Type | Description |
---|---|
System.String |
TrailerId
Gets or sets the trailer-id
Declaration
public Guid? TrailerId { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Guid> |
TrailerName
Gets the trailer name, which is the registration identifier For example HI-WM-1222
Declaration
public string TrailerName { get; }
Property Value
Type | Description |
---|---|
System.String |
TrailerRegistrationNumber
Gets or sets the trailer unit registration numner
Declaration
public string TrailerRegistrationNumber { get; set; }
Property Value
Type | Description |
---|---|
System.String |
UpdateDateTime
Gets or sets the update date time
Declaration
public DateTime UpdateDateTime { get; set; }
Property Value
Type | Description |
---|---|
System.DateTime |
Methods
| Improve this Doc View SourceCopy()
Copy current tour
Declaration
public Tour Copy()
Returns
Type | Description |
---|---|
Tour | Copied IAppointment instance |
CopyFrom(Tour)
Copy current tour
Declaration
public void CopyFrom(Tour tour)
Parameters
Type | Name | Description |
---|---|---|
Tour | tour |
ExecutePricingConnfigurationCarrier()
Executes the pricing configuration for the current tour
Declaration
public async Task<IList<TourItemInputObject>> ExecutePricingConnfigurationCarrier()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.Collections.Generic.IList<TourItemInputObject>> |
LoadShipments()
Load all shipments that are connected with this tour
Declaration
public ICollection<Shipment> LoadShipments()
Returns
Type | Description |
---|---|
System.Collections.Generic.ICollection<Shipment> | Collection of shipments |
LoadStops()
Load all tour stops for the tour
Declaration
public IList<TourStop> LoadStops()
Returns
Type | Description |
---|---|
System.Collections.Generic.IList<TourStop> |