CompanyRoute (Arinc-424A-xml 0.12 API)

java.lang.Object
- com.ars.aerodata.A424A_records.A424Base
- - com.ars.aerodata.A424A_records.A424Record
  - - com.ars.aerodata.A424A_records.CompanyRoute

public class CompanyRoute
extends A424Record

This data type represents the company route. It contains children starting with the letters via. The company route is made up of references to other data. e.g., the company route is to proceed via a SID then via an enroute ...etc.

Java class for CompanyRoute complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="CompanyRoute">
   <complexContent>
     <extension base="{}A424Record">
       <sequence>
         <element name="alternateDistanace" type="{http://www.arinc424.com/xml/datatypes}AlternateDistance" minOccurs="0"/>
         <element name="costIndex" type="{http://www.arinc424.com/xml/datatypes}CostIndex" minOccurs="0"/>
         <element name="cruiseAltitude" type="{http://www.arinc424.com/xml/datatypes}CruiseAltitude" minOccurs="0"/>
         <element name="enrouteEmergencyPortRef" type="{http://www.arinc424.com/xml/datatypes}PointReference" minOccurs="0"/>
         <element name="fromPortFix" type="{http://www.arinc424.com/xml/datatypes}PointReference" minOccurs="0"/>
         <element name="identifier" type="{http://www.arinc424.com/xml/datatypes}CoreIdentifier"/>
         <element name="terminalAlternateAirport" type="{http://www.arinc424.com/xml/datatypes}TerminlaAlternateAirport" minOccurs="0"/>
         <element name="toPortFix" type="{http://www.arinc424.com/xml/datatypes}PointReference" minOccurs="0"/>
         <element name="viaSID" type="{}ViaSID" minOccurs="0"/>
         <element name="viaEnroutes" type="{}ViaEnroutes" minOccurs="0"/>
         <element name="viaSTAR" type="{}ViaSTAR" minOccurs="0"/>
         <element name="viaApproach" type="{}ViaApproach" minOccurs="0"/>
         <element name="alternateRef" type="{http://www.arinc424.com/xml/datatypes}PointReference"/>
       </sequence>
       <attribute name="referenceID" use="required" type="{http://www.w3.org/2001/XMLSchema}ID" />
     </extension>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected Long`	`alternateDistanace` This field is used to supply the distance in nautical miles from the “To Airport/Heliport/Fix” to the Alternate Airport/Heliport.
`protected PointReference`	`alternateRef`
`protected Long`	`costIndex` The Cost Index field is used to define the relative value of fuel-related costs and time-related costs for a particular route.
`protected String`	`cruiseAltitude`
`protected PointReference`	`enrouteEmergencyPortRef`
`protected PointReference`	`fromPortFix` When used on Company Routes and Helicopter Operations Company Routes, the “From Airport/Heliport/Fix” is the fix from which the company route originates.
`protected String`	`identifier`
`protected String`	`referenceID`
`protected String`	`terminalAlternateAirport` This field has two uses depending on the “VIA” field and File Code for “To Fix.” For “VIA” field content of “ALT” this field will contain the Alternate Airport Ident or Heliport Ident for this Company Route.
`protected PointReference`	`toPortFix` When used on Company Routes and Helicopter Operations Company Routes, the “From Airport/Heliport/Fix” is the fix from which the company route originates.
`protected ViaApproach`	`viaApproach`
`protected ViaEnroutes`	`viaEnroutes`
`protected ViaSID`	`viaSID`
`protected ViaSTAR`	`viaSTAR`

Fields inherited from class com.ars.aerodata.A424A_records.A424Record
custAreaCode, cycleDate, notes, recordType

Fields inherited from class com.ars.aerodata.A424A_records.A424Base
supplementalData

Constructor Summary

Constructors
Constructor and Description

CompanyRoute()

Constructors
Constructor and Description
`CompanyRoute()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Long`	`getAlternateDistanace()` Gets the value of the alternateDistanace property.
`PointReference`	`getAlternateRef()` Gets the value of the alternateRef property.
`Long`	`getCostIndex()` Gets the value of the costIndex property.
`String`	`getCruiseAltitude()` Gets the value of the cruiseAltitude property.
`PointReference`	`getEnrouteEmergencyPortRef()` Gets the value of the enrouteEmergencyPortRef property.
`PointReference`	`getFromPortFix()` Gets the value of the fromPortFix property.
`String`	`getIdentifier()` Gets the value of the identifier property.
`String`	`getReferenceID()` Gets the value of the referenceID property.
`String`	`getTerminalAlternateAirport()` Gets the value of the terminalAlternateAirport property.
`PointReference`	`getToPortFix()` Gets the value of the toPortFix property.
`ViaApproach`	`getViaApproach()` Gets the value of the viaApproach property.
`ViaEnroutes`	`getViaEnroutes()` Gets the value of the viaEnroutes property.
`ViaSID`	`getViaSID()` Gets the value of the viaSID property.
`ViaSTAR`	`getViaSTAR()` Gets the value of the viaSTAR property.
`void`	`setAlternateDistanace(Long value)` Sets the value of the alternateDistanace property.
`void`	`setAlternateRef(PointReference value)` Sets the value of the alternateRef property.
`void`	`setCostIndex(Long value)` Sets the value of the costIndex property.
`void`	`setCruiseAltitude(String value)` Sets the value of the cruiseAltitude property.
`void`	`setEnrouteEmergencyPortRef(PointReference value)` Sets the value of the enrouteEmergencyPortRef property.
`void`	`setFromPortFix(PointReference value)` Sets the value of the fromPortFix property.
`void`	`setIdentifier(String value)` Sets the value of the identifier property.
`void`	`setReferenceID(String value)` Sets the value of the referenceID property.
`void`	`setTerminalAlternateAirport(String value)` Sets the value of the terminalAlternateAirport property.
`void`	`setToPortFix(PointReference value)` Sets the value of the toPortFix property.
`void`	`setViaApproach(ViaApproach value)` Sets the value of the viaApproach property.
`void`	`setViaEnroutes(ViaEnroutes value)` Sets the value of the viaEnroutes property.
`void`	`setViaSID(ViaSID value)` Sets the value of the viaSID property.
`void`	`setViaSTAR(ViaSTAR value)` Sets the value of the viaSTAR property.

Methods inherited from class com.ars.aerodata.A424A_records.A424Record
getCustAreaCode, getCycleDate, getNotes, getRecordType, setCustAreaCode, setCycleDate, setRecordType

Methods inherited from class com.ars.aerodata.A424A_records.A424Base
getSupplementalData, setSupplementalData

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - alternateDistanace
```
protected Long alternateDistanace
```
    This field is used to supply the distance in nautical miles from the “To Airport/Heliport/Fix” to the Alternate Airport/Heliport.
  - costIndex
```
protected Long costIndex
```
    The Cost Index field is used to define the relative value of fuel-related costs and time-related costs for a particular route.
  - cruiseAltitude
```
protected String cruiseAltitude
```
  - enrouteEmergencyPortRef
```
protected PointReference enrouteEmergencyPortRef
```
  - fromPortFix
```
protected PointReference fromPortFix
```
    When used on Company Routes and Helicopter Operations Company Routes, the “From Airport/Heliport/Fix” is the fix from which the company route originates. The “To Airport/Heliport/Fix” is the fix at which the company route terminates. When used on Alternate Records, it is the Departure, Destination or Enroute Airport/Fix for which the alternate information is being provided.
  - identifier
```
protected String identifier
```
  - terminalAlternateAirport
```
protected String terminalAlternateAirport
```
    This field has two uses depending on the “VIA” field and File Code for “To Fix.” For “VIA” field content of “ALT” this field will contain the Alternate Airport Ident or Heliport Ident for this Company Route. If the file code for “To Fix” contains “P,” this field will contain the Airport Ident for REGN CODE (Section 5.41) of Terminal Waypoints (PC records) and Runway (PG records). If the file code for “To Fix” contains “H”, this field will contain the Heliport Ident for REGN CODE (Section 5.41) of Helicopter Terminal Waypoints (HC records).
  - toPortFix
```
protected PointReference toPortFix
```
    When used on Company Routes and Helicopter Operations Company Routes, the “From Airport/Heliport/Fix” is the fix from which the company route originates. The “To Airport/Heliport/Fix” is the fix at which the company route terminates. When used on Alternate Records, it is the Departure, Destination or Enroute Airport/Fix for which the alternate information is being provided.
  - viaSID
```
protected ViaSID viaSID
```
  - viaEnroutes
```
protected ViaEnroutes viaEnroutes
```
  - viaSTAR
```
protected ViaSTAR viaSTAR
```
  - viaApproach
```
protected ViaApproach viaApproach
```
  - alternateRef
```
protected PointReference alternateRef
```
  - referenceID
```
protected String referenceID
```
- Constructor Detail
  - CompanyRoute
```
public CompanyRoute()
```
- Method Detail
  - getAlternateDistanace
```
public Long getAlternateDistanace()
```
    Gets the value of the alternateDistanace property.
    This field is used to supply the distance in nautical miles from the “To Airport/Heliport/Fix” to the Alternate Airport/Heliport.
    
    Returns:
    
    possible object is Long
  - setAlternateDistanace
```
public void setAlternateDistanace(Long value)
```
    Sets the value of the alternateDistanace property.
    
    Parameters:
    
    value - allowed object is Long
    
    See Also:
    
    getAlternateDistanace()
  - getCostIndex
```
public Long getCostIndex()
```
    Gets the value of the costIndex property.
    The Cost Index field is used to define the relative value of fuel-related costs and time-related costs for a particular route.
    
    Returns:
    
    possible object is Long
  - setCostIndex
```
public void setCostIndex(Long value)
```
    Sets the value of the costIndex property.
    
    Parameters:
    
    value - allowed object is Long
    
    See Also:
    
    getCostIndex()
  - getCruiseAltitude
```
public String getCruiseAltitude()
```
    Gets the value of the cruiseAltitude property.
    
    Returns:
    
    possible object is String
  - setCruiseAltitude
```
public void setCruiseAltitude(String value)
```
    Sets the value of the cruiseAltitude property.
    
    Parameters:
    
    value - allowed object is String
  - getEnrouteEmergencyPortRef
```
public PointReference getEnrouteEmergencyPortRef()
```
    Gets the value of the enrouteEmergencyPortRef property.
    
    Returns:
    
    possible object is PointReference
  - setEnrouteEmergencyPortRef
```
public void setEnrouteEmergencyPortRef(PointReference value)
```
    Sets the value of the enrouteEmergencyPortRef property.
    
    Parameters:
    
    value - allowed object is PointReference
  - getFromPortFix
```
public PointReference getFromPortFix()
```
    Gets the value of the fromPortFix property.
    When used on Company Routes and Helicopter Operations Company Routes, the “From Airport/Heliport/Fix” is the fix from which the company route originates. The “To Airport/Heliport/Fix” is the fix at which the company route terminates. When used on Alternate Records, it is the Departure, Destination or Enroute Airport/Fix for which the alternate information is being provided.
    
    Returns:
    
    possible object is PointReference
  - setFromPortFix
```
public void setFromPortFix(PointReference value)
```
    Sets the value of the fromPortFix property.
    
    Parameters:
    
    value - allowed object is PointReference
    
    See Also:
    
    getFromPortFix()
  - getIdentifier
```
public String getIdentifier()
```
    Gets the value of the identifier property.
    
    Returns:
    
    possible object is String
  - setIdentifier
```
public void setIdentifier(String value)
```
    Sets the value of the identifier property.
    
    Parameters:
    
    value - allowed object is String
  - getTerminalAlternateAirport
```
public String getTerminalAlternateAirport()
```
    Gets the value of the terminalAlternateAirport property.
    This field has two uses depending on the “VIA” field and File Code for “To Fix.” For “VIA” field content of “ALT” this field will contain the Alternate Airport Ident or Heliport Ident for this Company Route. If the file code for “To Fix” contains “P,” this field will contain the Airport Ident for REGN CODE (Section 5.41) of Terminal Waypoints (PC records) and Runway (PG records). If the file code for “To Fix” contains “H”, this field will contain the Heliport Ident for REGN CODE (Section 5.41) of Helicopter Terminal Waypoints (HC records).
    
    Returns:
    
    possible object is String
  - setTerminalAlternateAirport
```
public void setTerminalAlternateAirport(String value)
```
    Sets the value of the terminalAlternateAirport property.
    
    Parameters:
    
    value - allowed object is String
    
    See Also:
    
    getTerminalAlternateAirport()
  - getToPortFix
```
public PointReference getToPortFix()
```
    Gets the value of the toPortFix property.
    When used on Company Routes and Helicopter Operations Company Routes, the “From Airport/Heliport/Fix” is the fix from which the company route originates. The “To Airport/Heliport/Fix” is the fix at which the company route terminates. When used on Alternate Records, it is the Departure, Destination or Enroute Airport/Fix for which the alternate information is being provided.
    
    Returns:
    
    possible object is PointReference
  - setToPortFix
```
public void setToPortFix(PointReference value)
```
    Sets the value of the toPortFix property.
    
    Parameters:
    
    value - allowed object is PointReference
    
    See Also:
    
    getToPortFix()
  - getViaSID
```
public ViaSID getViaSID()
```
    Gets the value of the viaSID property.
    
    Returns:
    
    possible object is ViaSID
  - setViaSID
```
public void setViaSID(ViaSID value)
```
    Sets the value of the viaSID property.
    
    Parameters:
    
    value - allowed object is ViaSID
  - getViaEnroutes
```
public ViaEnroutes getViaEnroutes()
```
    Gets the value of the viaEnroutes property.
    
    Returns:
    
    possible object is ViaEnroutes
  - setViaEnroutes
```
public void setViaEnroutes(ViaEnroutes value)
```
    Sets the value of the viaEnroutes property.
    
    Parameters:
    
    value - allowed object is ViaEnroutes
  - getViaSTAR
```
public ViaSTAR getViaSTAR()
```
    Gets the value of the viaSTAR property.
    
    Returns:
    
    possible object is ViaSTAR
  - setViaSTAR
```
public void setViaSTAR(ViaSTAR value)
```
    Sets the value of the viaSTAR property.
    
    Parameters:
    
    value - allowed object is ViaSTAR
  - getViaApproach
```
public ViaApproach getViaApproach()
```
    Gets the value of the viaApproach property.
    
    Returns:
    
    possible object is ViaApproach
  - setViaApproach
```
public void setViaApproach(ViaApproach value)
```
    Sets the value of the viaApproach property.
    
    Parameters:
    
    value - allowed object is ViaApproach
  - getAlternateRef
```
public PointReference getAlternateRef()
```
    Gets the value of the alternateRef property.
    
    Returns:
    
    possible object is PointReference
  - setAlternateRef
```
public void setAlternateRef(PointReference value)
```
    Sets the value of the alternateRef property.
    
    Parameters:
    
    value - allowed object is PointReference
  - getReferenceID
```
public String getReferenceID()
```
    Gets the value of the referenceID property.
    
    Returns:
    
    possible object is String
  - setReferenceID
```
public void setReferenceID(String value)
```
    Sets the value of the referenceID property.
    
    Parameters:
    
    value - allowed object is String

Class CompanyRoute

Field Summary

Fields inherited from class com.ars.aerodata.A424A_records.A424Record

Fields inherited from class com.ars.aerodata.A424A_records.A424Base

Constructor Summary

Method Summary

Methods inherited from class com.ars.aerodata.A424A_records.A424Record

Methods inherited from class com.ars.aerodata.A424A_records.A424Base

Methods inherited from class java.lang.Object

Field Detail

alternateDistanace

costIndex

cruiseAltitude

enrouteEmergencyPortRef

fromPortFix

identifier

terminalAlternateAirport

toPortFix

viaSID

viaEnroutes

viaSTAR

viaApproach

alternateRef

referenceID

Constructor Detail

CompanyRoute

Method Detail

getAlternateDistanace

setAlternateDistanace

getCostIndex

setCostIndex

getCruiseAltitude

setCruiseAltitude

getEnrouteEmergencyPortRef

setEnrouteEmergencyPortRef

getFromPortFix

setFromPortFix

getIdentifier

setIdentifier

getTerminalAlternateAirport

setTerminalAlternateAirport

getToPortFix

setToPortFix

getViaSID

setViaSID

getViaEnroutes

setViaEnroutes

getViaSTAR

setViaSTAR

getViaApproach

setViaApproach

getAlternateRef

setAlternateRef

getReferenceID

setReferenceID