Class EquipmentManager

Contains the simplic logistics equipment manager to work with simplic vehicle

Inheritance

System.Object

EquipmentManager

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Simplic.PlugIn.Logistics

Assembly: Simplic.PlugIn.Logistics.dll

Syntax

public class EquipmentManager

Properties

| Improve this Doc View Source

EquipmentTypes

Gets the list of registered equipment types

Declaration

public IReadOnlyDictionary<Guid, Type> EquipmentTypes { get; }

Property Value

Type	Description
System.Collections.Generic.IReadOnlyDictionary<System.Guid, System.Type>

| Improve this Doc View Source

Singleton

Gets the singleton access to the vehicle manager

Declaration

public static EquipmentManager Singleton { get; }

Property Value

Type	Description
EquipmentManager

Methods

| Improve this Doc View Source

DeallocateVehicleEquipmentItem(VehicleEquipmentItem, SAConnection)

Removes the connection between an equipment item and a vehicle and saves the changes

Declaration

public void DeallocateVehicleEquipmentItem(VehicleEquipmentItem vehicleEquipmentItem, SAConnection connection)

Parameters

Type	Name	Description
VehicleEquipmentItem	vehicleEquipmentItem	Equipment to remove
SAConnection	connection	connection to use for communication with the database

| Improve this Doc View Source

GetAll(Guid, Boolean)

See GetAllVehicleEquipmentItems(Guid, SAConnection, Boolean)

Declaration

public IList<VehicleEquipmentItem> GetAll(Guid vehicleGuid, bool attachedOnly = true)

Parameters

Type	Name	Description
System.Guid	vehicleGuid
System.Boolean	attachedOnly

Returns

Type	Description
System.Collections.Generic.IList<VehicleEquipmentItem>

| Improve this Doc View Source

GetAllVehicleEquipmentItems(Guid, SAConnection, Boolean)

Gets all equipment of a given vehicle

Declaration

public IList<VehicleEquipmentItem> GetAllVehicleEquipmentItems(Guid vehicleGuid, SAConnection connection, bool attachedOnly = true)

Parameters

Type	Name	Description
System.Guid	vehicleGuid	unique identifier of the vehicle
SAConnection	connection	connection to use for communication with the database
System.Boolean	attachedOnly	if true, only vehicle equipment items with no set deallocation date (equipment items currently attached to a vehicle) can be found

Returns

Type	Description
System.Collections.Generic.IList<VehicleEquipmentItem>	A list of VehicleEquipmentItem of the vehicle with the given id

| Improve this Doc View Source

GetEquipmentItem(Guid)

See GetEquipmentItem(Guid, SAConnection)

Declaration

public EquipmentItem GetEquipmentItem(Guid equipmentId)

Parameters

Type	Name	Description
System.Guid	equipmentId

Returns

Type	Description
EquipmentItem

| Improve this Doc View Source

GetEquipmentItem(Guid, SAConnection)

Get an equipment item from the database

Declaration

public EquipmentItem GetEquipmentItem(Guid equipmentId, SAConnection connection)

Parameters

Type	Name	Description
System.Guid	equipmentId	Unique id of an equipment item
SAConnection	connection	connection to use for communication with the database

Returns

Type	Description
EquipmentItem	If the equipment item was found, an instance of EquipmentItem will be returned, else null

| Improve this Doc View Source

GetEquipmentType(Guid)

Get the information about a EquipmentType from the database. The data is cached, so only the first call for a specific type will need to query the database.

Declaration

public EquipmentType GetEquipmentType(Guid typeId)

Parameters

Type	Name	Description
System.Guid	typeId	Unique identifier of the EquipmentType

Returns

Type	Description
EquipmentType	The EquipmentType instance with the given id

| Improve this Doc View Source

GetNewEquipmentItem(Guid)

Get a new EquipmentItem of a specific type

Declaration

public EquipmentItem GetNewEquipmentItem(Guid typeId)

Parameters

Type	Name	Description
System.Guid	typeId	Unique identifier of the equipment type

Returns

Type	Description
EquipmentItem	A new EquipmentItem instance of the specified equipment type

| Improve this Doc View Source

GetNewVehicleEquipmentItem(Guid, Guid)

Get a new VehicleEquipmentItem containing a new EquipmentItem of a specific type

Declaration

public VehicleEquipmentItem GetNewVehicleEquipmentItem(Guid typeId, Guid vehicleId)

Parameters

Type	Name	Description
System.Guid	typeId	Unique identifier of the equipment type
System.Guid	vehicleId	Unique identifier of the vehicle the new EquipmentItem should be connected with

Returns

Type	Description
VehicleEquipmentItem	A new VehicleEquipmentItem instance containing an EquipmentItem instance of the specified equipment type

| Improve this Doc View Source

GetVehicleEquipmentItem(Guid)

See GetVehicleEquipmentItem(Guid, SAConnection)

Declaration

public VehicleEquipmentItem GetVehicleEquipmentItem(Guid equipmentId)

Parameters

Type	Name	Description
System.Guid	equipmentId

Returns

Type	Description
VehicleEquipmentItem

| Improve this Doc View Source

GetVehicleEquipmentItem(Guid, SAConnection)

Get an VehicleEquipmentItem with the connection data from the database, or a new one if the EquipmentItem with the given id is currently not attached to any vehicle

Declaration

public VehicleEquipmentItem GetVehicleEquipmentItem(Guid equipmentId, SAConnection connection)

Parameters

Type	Name	Description
System.Guid	equipmentId	Unique id of the EquipmentItem
SAConnection	connection	connection to use for communication with the database

Returns

Type	Description
VehicleEquipmentItem	An instance of VehicleEquipmentItem will be returned, filled with either the data of the current connection or the default data for a new connection with the EquipmentItem with the given id

| Improve this Doc View Source

GetVehicleEquipmentItem(Guid, Guid)

See

Declaration

public VehicleEquipmentItem GetVehicleEquipmentItem(Guid equipmentId, Guid vehicleId)

Parameters

Type	Name	Description
System.Guid	equipmentId
System.Guid	vehicleId

Returns

Type	Description
VehicleEquipmentItem

| Improve this Doc View Source

GetVehicleEquipmentItem(Guid, Guid, SAConnection)

Get an VehicleEquipmentItem with the connection data from the database, or a new one if the EquipmentItem with the given id is currently not attached to the Vehicle with the given id

Declaration

public VehicleEquipmentItem GetVehicleEquipmentItem(Guid equipmentId, Guid vehicleId, SAConnection connection)

Parameters

Type	Name	Description
System.Guid	equipmentId	Unique id of the EquipmentItem
System.Guid	vehicleId	Unique id of the Vehicle
SAConnection	connection	connection to use for communication with the database

Returns

Type	Description
VehicleEquipmentItem	An instance of VehicleEquipmentItem will be returned, filled with either the data of the current connection or the default data for a new connection with the EquipmentItem with the given id

| Improve this Doc View Source

RegisterEquipmentType<T>(Guid)

Declaration

public void RegisterEquipmentType<T>(Guid typeId)
    where T : EquipmentItem

Parameters

Type	Name	Description
System.Guid	typeId	Unique type id to register for that type

Type Parameters

Name	Description
T	Equipment type

| Improve this Doc View Source

Save(EquipmentItem)

See Save(EquipmentItem, SAConnection)

Declaration

public void Save(EquipmentItem equipmentItem)

Parameters

Type	Name	Description
EquipmentItem	equipmentItem

| Improve this Doc View Source

Save(EquipmentItem, SAConnection)

Create or save an EquipmentItem

Declaration

public void Save(EquipmentItem equipmentItem, SAConnection connection)

Parameters

Type	Name	Description
EquipmentItem	equipmentItem	EquipmentItem instance
SAConnection	connection	connection to use for communication with the database

| Improve this Doc View Source

Save(VehicleEquipmentItem)

See Save(VehicleEquipmentItem, SAConnection)

Declaration

public void Save(VehicleEquipmentItem vehicleEquipmentItem)

Parameters

Type	Name	Description
VehicleEquipmentItem	vehicleEquipmentItem

| Improve this Doc View Source

Save(VehicleEquipmentItem, SAConnection)

Create or save a VehicleEquipmentItem

Declaration

public void Save(VehicleEquipmentItem vehicleEquipmentItem, SAConnection connection)

Parameters

Type	Name	Description
VehicleEquipmentItem	vehicleEquipmentItem
SAConnection	connection	connection to use for communication with the database