com.luciad.format.arinc.decoder

Aviation StandardsClass TLcdARINCHoldingHandler

java.lang.Object

com.luciad.format.arinc.decoder.TLcdARINCHoldingHandler

All Implemented Interfaces:

ILcdARINCHandler

public class TLcdARINCHoldingHandler
extends Object

This extension of the ALcdARINCHandler interface deals with enroute holding patterns (Enroute Holding Pattern Records, section code E, subsection code P). Decoded models have as model descriptor an instance of TLcdARINCHoldingModelDescriptor.

The objects in decoded models are based on the AIS domain objects available in com.luciad.ais.model, which all implement ILcdDataObject. This interface provides a generic and format-independent way of accessing the type and properties (features) of a domain object.

For this handler, the type of the decoded objects is TLcdARINCDataTypes.Holding, which can also be retrieved through ILcdDataObject.getDataType(). The available properties of the objects are defined in TLcdARINCHoldingDataProperties. The values for these properties can be retrieved through ILcdDataObject.getValue(com.luciad.datamodel.TLcdDataProperty).

Next to ILcdDataObject, the objects in decoded models also implement ILcdFeatured, the former interface to access the properties (features) of a domain object. This is still fully supported, and explained in the following comments.

The setHoldingFeatureNamesToBeDecoded method allows the user to specify which ARINC features are decoded into the featured model objects.

If no feature names to be decoded are specified, all features will be decoded.

The following fields (taken from the ARINC specification 424) are supported by the decoder. The list indicates into which feature the fields are decoded. It also indicates from which ARINC version on they are available.

• Version 15 :
  • ICAO code: ILcdARINCHoldingFeature.ICAO_REGION
  • Duplicate identifier: IlcdARINCHoldingFeature.DUPLICATE_IDENTIFIER
  • Fix identifier: ILcdARINCHoldingFeature.FIX_IDENTIFIER
  • Region code: ILcdARINCHoldingFeature.TYPE
  • Notes/name: ILcdARINCHoldingFeature.NOTES
  • Cycle: ILcdARINCHoldingFeature.CYCLE_DATE
• Version 17 :
  • Required navigation performance: ILcdARINCHoldingFeature.RNP
• Version 18 : no extra fields added.

ARINC handlers rely on a specific set of key features that uniquely define an object. This set of features must always be included in the set of features to be decoded. For aerodromes the key features are:

• ILcdARINCHoldingFeature.FIX_IDENTIFIER
• ILcdARINCHoldingFeature.DUPLICATE_IDENTIFIER

Since:

6.0

See Also:

TLcdARINCHoldingModelDescriptor

Constructor Summary

Constructors

Constructor and Description
TLcdARINCHoldingHandler() Constructs a new TLcdARINCHoldingHandler object.

Method Summary

Modifier and Type	Method and Description
ILcdBounds	getBoundsToFilterOn() Returns the (geodetic) bounds that will be used as a filter on the model created by this handler.
TLcdAISDataObjectFactory	getDataObjectFactory() Returns the factory to be used to create domain objects.
ALcdAISObjectFactory	getDomainFactory() Deprecated.
String[]	getHoldingFeatureNamesToBeDecoded() Returns the features that will be stored in the domain objects created by this handler.
ILcdBounds	getInitialBounds() Returns the bounds to be used as initial bounds for the model created by this handler.
protected ILcdGeodeticDatum	getLocalHorizontalDatum(String aGeodeticDatumCode) Returns an instance of an implementation of the ILcdGeodeticDatum interface according to the given geodetic datum code.
ILcdFeatureIndexedAnd2DBoundsIndexedModel	getModel() Returns the model build by this handler.
void	handleRecord(char[] aRecord) Deals with one record of ARINC data.
boolean	isStoreOriginalReference() If true, the decoder will store the original geodetic datum of each domain object in a feature.
boolean	isTraceOn() Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.
void	newModel(String aSource, ILcdARINCErrorMessageSupport aErrorMessage) Resets the internal state of this handler so that it is ready to handle a new data source from scratch.
protected String	read(char[] aRecord, int aStart, int aLength) Reads from aRecord from position aStart to aStart + aLength - 1, trims the resulting String object and returns it.
protected char	readSectionCode(char[] aRecord) Reads the section code of an ARINC record.
void	setAirportModel(ILcdModel aAirportModel) Specifies a model of aerodromes.
void	setARINCModelFilter(ILcdARINCModelFilter aFilter) Specifies a filter to be used while creating the model.
void	setBoundsToFilterOn(ILcdBounds aBoundsToFilterOn) Specifies (geodetic) bounds that will be used as a filter on the model created by this handler.
static void	setClassTraceOn(boolean aTraceOn) Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.
void	setDataObjectFactory(TLcdAISDataObjectFactory aFactory) Specifies the factory to be used to create domain objects.
void	setDefaultGeodeticDatum(ILcdGeodeticDatum aDefaultGeodeticDatum) Sets the default geodetic datum code.
void	setDMEModel(ILcdModel aDMEModel) Specifies a model of DMEs
void	setDomainFactory(ALcdAISObjectFactory aDomainFactory) Deprecated.
void	setHoldingFeatureNamesToBeDecoded(String[] aHoldingFeatureNamesToBeDecoded) Specifies which features should be stored in the domain objects created by this handler.
void	setInitialBounds(ILcdBounds aInitialBounds) Specifies a bounds to be used as initial bounds for the model created by this handler.
void	setNDBModel(ILcdModel aNDBModel) Specifies a model of NDBs
void	setRunwayModel(ILcdModel aRunwayModel) Specifies a model of runways
void	setStoreOriginalReference(boolean aStoreRef) If true, the decoder will store the original geodetic datum of each domain object in a feature.
void	setTACANModel(ILcdModel aTACANModel) Specifies a model of TACANs
void	setTraceOn(boolean aTraceOn) Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.
void	setVORModel(ILcdModel aVORModel) Specifies a model of VORs
void	setWaypointModel(ILcdModel aWaypointModel) Specifies a model of waypoints

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TLcdARINCHoldingHandler

public TLcdARINCHoldingHandler()

Constructs a new TLcdARINCHoldingHandler object.

Method Detail

handleRecord

public void handleRecord(char[] aRecord)

Description copied from interface: ILcdARINCHandler

Deals with one record of ARINC data.

Each implementation of the ILcdARINCHandler interface decides by itself whether to use the information found in the given record to create or modify a domain object, or to do nothing at all.

Typically, this method will be called when looping through the records of a data source.

The domain objects created or modified when calling this method will be stored in a model. The user can obtain this model by calling the getModel method.

Parameters:

aRecord - the record to deal with created with data from the given record in

See Also:

ILcdARINCHandler.getModel()

getHoldingFeatureNamesToBeDecoded

public String[] getHoldingFeatureNamesToBeDecoded()

Returns the features that will be stored in the domain objects created by this handler.

Returns:

an array containing the names of the features to be stored in the domain objects created by this handler

See Also:

setHoldingFeatureNamesToBeDecoded(java.lang.String[])

setHoldingFeatureNamesToBeDecoded

public void setHoldingFeatureNamesToBeDecoded(String[] aHoldingFeatureNamesToBeDecoded)

Specifies which features should be stored in the domain objects created by this handler.

Parameters:

aHoldingFeatureNamesToBeDecoded - an array containing the names of the features to be stored in the domain objects created by this handler. Feature names should be taken from the ILcdARINCHoldingFeature interface.

See Also:

getHoldingFeatureNamesToBeDecoded()

setAirportModel

public void setAirportModel(ILcdModel aAirportModel)

Specifies a model of aerodromes.

Parameters:

aAirportModel - the aerodrome model to be used to create the holding patterns

setNDBModel

public void setNDBModel(ILcdModel aNDBModel)

Specifies a model of NDBs

Parameters:

aNDBModel - the NDB model to be used to create the holding patterns

setWaypointModel

public void setWaypointModel(ILcdModel aWaypointModel)

Specifies a model of waypoints

Parameters:

aWaypointModel - the waypoint model to be used to create the holding patterns

setDMEModel

public void setDMEModel(ILcdModel aDMEModel)

Specifies a model of DMEs

Parameters:

aDMEModel - the DME model to be used to create the holding patterns

setTACANModel

public void setTACANModel(ILcdModel aTACANModel)

Specifies a model of TACANs

Parameters:

aTACANModel - the TACAN model to be used to create the holding patterns

setVORModel

public void setVORModel(ILcdModel aVORModel)

Specifies a model of VORs

Parameters:

aVORModel - the VOR model to be used to create the holding patterns

setRunwayModel

public void setRunwayModel(ILcdModel aRunwayModel)

Specifies a model of runways

Parameters:

aRunwayModel - the runway model to be used to create the holding patterns

setDomainFactory

@Deprecated
public void setDomainFactory(ALcdAISObjectFactory aDomainFactory)

Deprecated.

Description copied from interface: ILcdARINCHandler

Specifies the domainFactory to be used to create domain objects.

The given domainFactory must not be null.

Specified by:

setDomainFactory in interface ILcdARINCHandler

Parameters:

aDomainFactory - the domainFactory to be used to create domain objects

See Also:

ILcdARINCHandler.getDomainFactory()

getDomainFactory

@Deprecated
public ALcdAISObjectFactory getDomainFactory()

Deprecated.

Description copied from interface: ILcdARINCHandler

Returns the domainFactory to be used to create domain objects.

Specified by:

getDomainFactory in interface ILcdARINCHandler

Returns:

the domainFactory to be used to create domain objects

See Also:

ILcdARINCHandler.setDomainFactory(com.luciad.ais.model.ALcdAISObjectFactory)

setDataObjectFactory

public void setDataObjectFactory(TLcdAISDataObjectFactory aFactory)

Description copied from interface: ILcdARINCHandler

Specifies the factory to be used to create domain objects.

The given factory must not be null.

Specified by:

setDataObjectFactory in interface ILcdARINCHandler

Parameters:

aFactory - the domainFactory to be used to create domain objects

See Also:

ILcdARINCHandler.getDataObjectFactory()

getDataObjectFactory

public TLcdAISDataObjectFactory getDataObjectFactory()

Description copied from interface: ILcdARINCHandler

Returns the factory to be used to create domain objects.

Specified by:

getDataObjectFactory in interface ILcdARINCHandler

Returns:

the factory to be used to create domain objects

See Also:

ILcdARINCHandler.setDataObjectFactory(TLcdAISDataObjectFactory)

setDefaultGeodeticDatum

public void setDefaultGeodeticDatum(ILcdGeodeticDatum aDefaultGeodeticDatum)

Sets the default geodetic datum code. This is used for records which do not mention an explicit geodetic datum.

By default, this is WGS 84. Note that null can also be provided: in that case, records which do not mention a geodetic datum will be ignored.

Parameters:

aDefaultGeodeticDatum - The default geodetic datum.

getModel

public ILcdFeatureIndexedAnd2DBoundsIndexedModel getModel()

Description copied from interface: ILcdARINCHandler

Returns the model build by this handler.

Please remark that this handler is only capable of creating the expected model if the user calls

• the newModel method to reset the internal state before he or she starts the decoding process,
• the handleRecord method each time a new record in the data source is accessed.

Specified by:

getModel in interface ILcdARINCHandler

Returns:

the model build by this handler

setBoundsToFilterOn

public void setBoundsToFilterOn(ILcdBounds aBoundsToFilterOn)

Description copied from interface: ILcdARINCHandler

Specifies (geodetic) bounds that will be used as a filter on the model created by this handler.

If this bounds is null, all objects found in the data source will be inserted into the model. If this bounds is not null, only the objects whose bounds interact with the specified bounds will be inserted into the model.

Specified by:

setBoundsToFilterOn in interface ILcdARINCHandler

Parameters:

aBoundsToFilterOn - the bounds to be used as a filter

getBoundsToFilterOn

public ILcdBounds getBoundsToFilterOn()

Description copied from interface: ILcdARINCHandler

Returns the (geodetic) bounds that will be used as a filter on the model created by this handler.

Specified by:

getBoundsToFilterOn in interface ILcdARINCHandler

Returns:

the bounds that will be used as a filter on the model created by this handler

See Also:

ILcdARINCHandler.setBoundsToFilterOn(com.luciad.shape.ILcdBounds)

setInitialBounds

public void setInitialBounds(ILcdBounds aInitialBounds)

Description copied from interface: ILcdARINCHandler

Specifies a bounds to be used as initial bounds for the model created by this handler.

This bounds should be large enough to enclose (most of) the model objects. This option is used to avoid to many expansions of the model bounds.

This parameter may be null.

Note: This bounds is not a filter! If a model objects bounds does not interact with aInitialBounds, aInitialBounds will be enlarged to enclose the object.

Specified by:

setInitialBounds in interface ILcdARINCHandler

Parameters:

aInitialBounds - the initial bounds for the model created by this handler

getInitialBounds

public ILcdBounds getInitialBounds()

Description copied from interface: ILcdARINCHandler

Returns the bounds to be used as initial bounds for the model created by this handler.

Specified by:

getInitialBounds in interface ILcdARINCHandler

Returns:

bounds to be used as initial bounds for the model created by this handler

See Also:

ILcdARINCHandler.setInitialBounds(com.luciad.shape.ILcdBounds)

newModel

public void newModel(String aSource,
                     ILcdARINCErrorMessageSupport aErrorMessage)

Description copied from interface: ILcdARINCHandler

Resets the internal state of this handler so that it is ready to handle a new data source from scratch.

The user should call this method before using this handler in a decoding process.

Specified by:

newModel in interface ILcdARINCHandler

Parameters:

aSource - the name of the source that will be handled

aErrorMessage - for each irregular situation during the decoding, a report should be added to this object

setARINCModelFilter

public void setARINCModelFilter(ILcdARINCModelFilter aFilter)

Description copied from interface: ILcdARINCHandler

Specifies a filter to be used while creating the model. Only model objects that pass through the filter will be in the resulting model.

Specified by:

setARINCModelFilter in interface ILcdARINCHandler

Parameters:

aFilter - an ILcdARINCModelFilter to filter the model objects

isTraceOn

public boolean isTraceOn()

Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.

Returns true if tracing is enabled for this class.

Returns:

true if tracing is enabled for this class, false otherwise.

setClassTraceOn

public static void setClassTraceOn(boolean aTraceOn)

Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.

Enables tracing for all instances of this class. If the argument is true then all log messages are recorded, otherwise only the informative, warning and error messages are recorded.

Parameters:

aTraceOn - if true then all log messages are recorded, otherwise only the informative, warning and error messages are recorded.

setTraceOn

public void setTraceOn(boolean aTraceOn)

Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.

Enables tracing for this class instance. Calling this method with either true or false as argument automatically turns off tracing for all other class instances for which setTraceOn has not been called. If the argument is false then only the informative, warning and error log messages are recorded.

Parameters:

aTraceOn - if true then all log messages are recorded for this instance. If false, then only the informative, warning and error log messages are recorded.

readSectionCode

protected char readSectionCode(char[] aRecord)

Reads the section code of an ARINC record.

Parameters:

aRecord - the record to read of

Returns:

the section code of the record

read

protected String read(char[] aRecord,
                      int aStart,
                      int aLength)

Reads from aRecord from position aStart to aStart + aLength - 1, trims the resulting String object and returns it.

Parameters:

aRecord - the record to be read of

aStart - the start position for reading

aLength - the length of the String to be read

Returns:

a trimmed String object

getLocalHorizontalDatum

protected ILcdGeodeticDatum getLocalHorizontalDatum(String aGeodeticDatumCode)

Returns an instance of an implementation of the ILcdGeodeticDatum interface according to the given geodetic datum code. The datum code is expected to be specified by their three character representation, as it is used in the ARINC specification.

The full list of supported geodetic datum codes can be found in the ARINC Developer's Guide.

If the supplied code is null or empty, the default geodetic datum is returned. This is WGS 84 by default, but it can be configured through setDefaultGeodeticDatum. If no geodetic datum can be found, null is returned.

Parameters:

aGeodeticDatumCode - the code for the geodetic datum to be returned

Returns:

the geodetic datum according to the given code

setStoreOriginalReference

public void setStoreOriginalReference(boolean aStoreRef)

Description copied from interface: ILcdARINCHandler

If true, the decoder will store the original geodetic datum of each domain object in a feature.

Specified by:

setStoreOriginalReference in interface ILcdARINCHandler

Parameters:

aStoreRef - specifies if the decoder must store the original geodetic datum of each domain object in a feature.

isStoreOriginalReference

public boolean isStoreOriginalReference()

Description copied from interface: ILcdARINCHandler

If true, the decoder will store the original geodetic datum of each domain object in a feature.

Specified by:

isStoreOriginalReference in interface ILcdARINCHandler

Returns:

whether the decoder will store the original geodetic datum of each domain object in a feature.