Class MPortType
A data type for a facility capable of receiving vessels and transferring cargo.
Inherited Members
Namespace: NiemTypes
Assembly: EidoLib.dll
Syntax
[DataContract]
public class MPortType : NcFacilityType, IEquatable<NcFacilityType>, IEquatable<MPortType>
  Properties
AnchorageCapability
A description of the anchorage capabilities of a port. NIEM reference is m:PortAnchorageCapabilityText
Declaration
[DataMember(Name = "anchorageCapability")]
public List<NcTextType> AnchorageCapability { get; set; }
  Property Value
| Type | Description | 
|---|---|
| System.Collections.Generic.List<NcTextType> | A description of the anchorage capabilities of a port. NIEM reference is m:PortAnchorageCapabilityText  | 
      
BeNumber
A BE (Basic Encyclopedia) number for a port. NIEM reference is m:PortBENumberText
Declaration
[DataMember(Name = "beNumber")]
public List<NcTextType> BeNumber { get; set; }
  Property Value
| Type | Description | 
|---|---|
| System.Collections.Generic.List<NcTextType> | A BE (Basic Encyclopedia) number for a port. NIEM reference is m:PortBENumberText  | 
      
CargoCapability
A description of the cargo capabilities of a port. NIEM reference is m:PortCargoCapabilityText
Declaration
[DataMember(Name = "cargoCapability")]
public List<NcTextType> CargoCapability { get; set; }
  Property Value
| Type | Description | 
|---|---|
| System.Collections.Generic.List<NcTextType> | A description of the cargo capabilities of a port. NIEM reference is m:PortCargoCapabilityText  | 
      
Code
A code to identify a port. NIEM reference is m:PortCodeText
Declaration
[DataMember(Name = "code")]
public List<NcTextType> Code { get; set; }
  Property Value
| Type | Description | 
|---|---|
| System.Collections.Generic.List<NcTextType> | A code to identify a port. NIEM reference is m:PortCodeText  | 
      
Context
mPortType JSON-LD context
Declaration
[DataMember(Name = "@context")]
public MPortType.ContextEnum? Context { get; set; }
  Property Value
| Type | Description | 
|---|---|
| System.Nullable<MPortType.ContextEnum> | mPortType JSON-LD context  | 
      
CotpZone
A Captain of the Port (COTP) zone to which a port belongs. NIEM reference is m:PortCOTPZone
Declaration
[DataMember(Name = "cotpZone")]
public List<MCaptainOfThePortZoneType> CotpZone { get; set; }
  Property Value
| Type | Description | 
|---|---|
| System.Collections.Generic.List<MCaptainOfThePortZoneType> | A Captain of the Port (COTP) zone to which a port belongs. NIEM reference is m:PortCOTPZone  | 
      
DepthMeasure
A measure of the water depth of a port that limits which vessels can make use of the port. NIEM reference is m:PortDepthMeasure
Declaration
[DataMember(Name = "depthMeasure")]
public List<NcLengthMeasureType> DepthMeasure { get; set; }
  Property Value
| Type | Description | 
|---|---|
| System.Collections.Generic.List<NcLengthMeasureType> | A measure of the water depth of a port that limits which vessels can make use of the port. NIEM reference is m:PortDepthMeasure  | 
      
Description
A description of a port. NIEM reference is m:PortDescriptionText
Declaration
[DataMember(Name = "description")]
public List<NcTextType> Description { get; set; }
  Property Value
| Type | Description | 
|---|---|
| System.Collections.Generic.List<NcTextType> | A description of a port. NIEM reference is m:PortDescriptionText  | 
      
DockQuantity
A number of docks possessed by a port. NIEM reference is m:PortDockQuantity
Declaration
[DataMember(Name = "dockQuantity")]
public List<NcQuantityType> DockQuantity { get; set; }
  Property Value
| Type | Description | 
|---|---|
| System.Collections.Generic.List<NcQuantityType> | A number of docks possessed by a port. NIEM reference is m:PortDockQuantity  | 
      
Government
A government which owns or operates a port, especially in the situation where a port is physically in one country but is owned or operated by another. NIEM reference is m:PortGovernmentText
Declaration
[DataMember(Name = "government")]
public List<NcTextType> Government { get; set; }
  Property Value
| Type | Description | 
|---|---|
| System.Collections.Generic.List<NcTextType> | A government which owns or operates a port, especially in the situation where a port is physically in one country but is owned or operated by another. NIEM reference is m:PortGovernmentText  | 
      
GovernmentIso3166Alpha2Code
A government which owns or operates a port, especially in the situation where a port is physically in one country but is owned or operated by another. NIEM reference is m:PortGovernmentISO3166Alpha2Code
Declaration
[DataMember(Name = "governmentIso3166Alpha2Code")]
public List<Iso3166CountryAlpha2CodeType> GovernmentIso3166Alpha2Code { get; set; }
  Property Value
| Type | Description | 
|---|---|
| System.Collections.Generic.List<Iso3166CountryAlpha2CodeType> | A government which owns or operates a port, especially in the situation where a port is physically in one country but is owned or operated by another. NIEM reference is m:PortGovernmentISO3166Alpha2Code  | 
      
Image
An image of a port. NIEM reference is m:PortImage
Declaration
[DataMember(Name = "image")]
public List<NcImageType> Image { get; set; }
  Property Value
| Type | Description | 
|---|---|
| System.Collections.Generic.List<NcImageType> | An image of a port. NIEM reference is m:PortImage  | 
      
IsIspsCompliant
True if a port is compliant with International Ship and Port Facility Security (ISPS) requirements; false otherwise. NIEM reference is m:PortISPSCompliantIndicator
Declaration
[DataMember(Name = "isIspsCompliant")]
public List<NiemXsboolean> IsIspsCompliant { get; set; }
  Property Value
| Type | Description | 
|---|---|
| System.Collections.Generic.List<NiemXsboolean> | True if a port is compliant with International Ship and Port Facility Security (ISPS) requirements; false otherwise. NIEM reference is m:PortISPSCompliantIndicator  | 
      
IsStrategicPortOfEmbarkation
True if troops, munitions, etc. can be loaded/unloaded at this port; false otherwise. NIEM reference is m:PortStrategicPortOfEmbarkationIndicator
Declaration
[DataMember(Name = "isStrategicPortOfEmbarkation")]
public List<NiemXsboolean> IsStrategicPortOfEmbarkation { get; set; }
  Property Value
| Type | Description | 
|---|---|
| System.Collections.Generic.List<NiemXsboolean> | True if troops, munitions, etc. can be loaded/unloaded at this port; false otherwise. NIEM reference is m:PortStrategicPortOfEmbarkationIndicator  | 
      
LocationCityName
A name of a city or town. NIEM reference is nc:LocationCityName
Declaration
[DataMember(Name = "locationCityName")]
public List<NcProperNameTextType> LocationCityName { get; set; }
  Property Value
| Type | Description | 
|---|---|
| System.Collections.Generic.List<NcProperNameTextType> | A name of a city or town. NIEM reference is nc:LocationCityName  | 
      
LocationCountry
A country, territory, dependency, or other such geopolitical subdivision of a location. NIEM reference is nc:LocationCountry
Declaration
[DataMember(Name = "locationCountry")]
public List<NcCountryType> LocationCountry { get; set; }
  Property Value
| Type | Description | 
|---|---|
| System.Collections.Generic.List<NcCountryType> | A country, territory, dependency, or other such geopolitical subdivision of a location. NIEM reference is nc:LocationCountry  | 
      
LocationState
A state, commonwealth, province, or other such geopolitical subdivision of a country. NIEM reference is nc:LocationState
Declaration
[DataMember(Name = "locationState")]
public List<NcStateType> LocationState { get; set; }
  Property Value
| Type | Description | 
|---|---|
| System.Collections.Generic.List<NcStateType> | A state, commonwealth, province, or other such geopolitical subdivision of a country. NIEM reference is nc:LocationState  | 
      
MaximumVesselQuantity
A maximum number of vessels the port is capable of handling. NIEM reference is m:PortMaximumVesselQuantity
Declaration
[DataMember(Name = "maximumVesselQuantity")]
public List<NcQuantityType> MaximumVesselQuantity { get; set; }
  Property Value
| Type | Description | 
|---|---|
| System.Collections.Generic.List<NcQuantityType> | A maximum number of vessels the port is capable of handling. NIEM reference is m:PortMaximumVesselQuantity  | 
      
Name
A name of a port. NIEM reference is m:PortName
Declaration
[DataMember(Name = "name")]
public List<NcProperNameTextType> Name { get; set; }
  Property Value
| Type | Description | 
|---|---|
| System.Collections.Generic.List<NcProperNameTextType> | A name of a port. NIEM reference is m:PortName  | 
      
OperationalStatus
An operational status of a port. NIEM reference is m:PortOperationalStatus
Declaration
[DataMember(Name = "operationalStatus")]
public List<NcStatusType> OperationalStatus { get; set; }
  Property Value
| Type | Description | 
|---|---|
| System.Collections.Generic.List<NcStatusType> | An operational status of a port. NIEM reference is m:PortOperationalStatus  | 
      
PilotBoatQuantity
A number of pilot boats available at a port. NIEM reference is m:PortPilotBoatQuantity
Declaration
[DataMember(Name = "pilotBoatQuantity")]
public List<NcQuantityType> PilotBoatQuantity { get; set; }
  Property Value
| Type | Description | 
|---|---|
| System.Collections.Generic.List<NcQuantityType> | A number of pilot boats available at a port. NIEM reference is m:PortPilotBoatQuantity  | 
      
ThreatLevel
A threat level at a port. NIEM reference is m:PortThreatLevelText
Declaration
[DataMember(Name = "threatLevel")]
public List<NcTextType> ThreatLevel { get; set; }
  Property Value
| Type | Description | 
|---|---|
| System.Collections.Generic.List<NcTextType> | A threat level at a port. NIEM reference is m:PortThreatLevelText  | 
      
Unlocode
A United Nations Location Code of a maritime port, also known as a UN/LOCODE (United Nations Code for Trade and Transport Locations). NIEM reference is m:PortUNLOCODEText
Declaration
[DataMember(Name = "unlocode")]
public List<NcTextType> Unlocode { get; set; }
  Property Value
| Type | Description | 
|---|---|
| System.Collections.Generic.List<NcTextType> | A United Nations Location Code of a maritime port, also known as a UN/LOCODE (United Nations Code for Trade and Transport Locations). NIEM reference is m:PortUNLOCODEText  | 
      
Methods
Equals(MPortType)
Returns true if MPortType instances are equal
Declaration
public bool Equals(MPortType other)
  Parameters
| Type | Name | Description | 
|---|---|---|
| MPortType | other | Instance of MPortType to be compared  | 
      
Returns
| Type | Description | 
|---|---|
| System.Boolean | Boolean  | 
      
Equals(Object)
Returns true if objects are equal
Declaration
public override bool Equals(object obj)
  Parameters
| Type | Name | Description | 
|---|---|---|
| System.Object | obj | Object to be compared  | 
      
Returns
| Type | Description | 
|---|---|
| System.Boolean | Boolean  | 
      
Overrides
GetHashCode()
Gets the hash code
Declaration
public override int GetHashCode()
  Returns
| Type | Description | 
|---|---|
| System.Int32 | Hash code  | 
      
Overrides
ToJson()
Returns the JSON string presentation of the object
Declaration
public string ToJson()
  Returns
| Type | Description | 
|---|---|
| System.String | JSON string presentation of the object  | 
      
ToString()
Returns the string presentation of the object
Declaration
public override string ToString()
  Returns
| Type | Description | 
|---|---|
| System.String | String presentation of the object  | 
      
Overrides
Operators
Equality(MPortType, MPortType)
Declaration
public static bool operator ==(MPortType left, MPortType right)
  Parameters
| Type | Name | Description | 
|---|---|---|
| MPortType | left | |
| MPortType | right | 
Returns
| Type | Description | 
|---|---|
| System.Boolean | 
Inequality(MPortType, MPortType)
Declaration
public static bool operator !=(MPortType left, MPortType right)
  Parameters
| Type | Name | Description | 
|---|---|---|
| MPortType | left | |
| MPortType | right | 
Returns
| Type | Description | 
|---|---|
| System.Boolean |