Package com.luciad.format.arinc.decoder

Interface ILcdARINCDecoder

All Superinterfaces:
ILcdModelDecoder
All Known Implementing Classes:
TLcdARINCDecoder
public interface ILcdARINCDecoder extends ILcdModelDecoder
This ILcdModelDecoder extension specifies the interface for ARINC data source decoders.

This interface allows configuration of the types of AIS objects to be decoded. For each type of object, a specific ILcdARINCHandler implementation must be added to the decoder by invoking addHandlerForTypeToBeDecoded(ILcdARINCHandler).

Decoding an ARINC data file using this decoder will result in

  • either a single model, if there's only one handler specified,
  • or a TLcdModelList, that will contain a submodel for each handler added to the decoder. If necessary, this model list can be decomposed back into a set of individual models.
If no handlers are registered at all, an empty model will be returned by the decoder.
See Also:

  • Method Details

    • addHandlerForTypeToBeDecoded

      void addHandlerForTypeToBeDecoded(ILcdARINCHandler aHandler)
      Adds an ILcdARINCHandler to the decoder.

      Each handler will generate an ILcdModel containing one specific kind of domain object. At the end of the decode process, the models created by the available handlers will be brought together in a TLcdModelList.

      Parameters:
      aHandler - an ILcdARINCHandler implementation
      See Also:

    • getHandlerForTypeToBeDecoded

      ILcdARINCHandler getHandlerForTypeToBeDecoded(int aIndex)
      Returns the handler with the given index.
      Parameters:
      aIndex - the index in the list of handlers
      Returns:
      the handler at the given index
      See Also:

    • getHandlerForTypeToBeDecodedCount

      int getHandlerForTypeToBeDecodedCount()
      Returns the number of handlers set on this decoder.
      Returns:
      the number of handlers
      See Also:

    • removeAllHandlersForTypeToBeDecoded

      void removeAllHandlersForTypeToBeDecoded()
      Removes all handlers from this decoder.
      See Also:

    • getErrorMessage

      String getErrorMessage()
      Returns the error message of the last decode call (when an error occurred).

      Note: the error message can only be retrieved once after a decode call.

      Returns:
      a string containing the errors occurred during the last decode process

    • setInitialBounds

      void setInitialBounds(ILcdBounds aInitialBounds)
      Specifies the bounds to be used as initial bounds for each model created in the decode method.

      This bounds should be large enough to enclose (most of) the model objects. This option can improve performance by avoiding too 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.

      Parameters:
      aInitialBounds - the initial bounds for each model created in the decode method

    • setBoundsToFilterOn

      void setBoundsToFilterOn(ILcdBounds aBoundsToFilterOn)
      Specifies the (geodetic) bounds that will be used as a filter on each model created in the decode method.

      If this bounds is null, all objects found in the input file 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.

      Parameters:
      aBoundsToFilterOn - the bounds to be used as a filter

    • getInitialBounds

      ILcdBounds getInitialBounds()
      Returns the initial bounds for each model created in the decode method.
      Returns:
      the initial bounds for each model created in the decode method
      See Also:

    • getBoundsToFilterOn

      ILcdBounds getBoundsToFilterOn()
      Returns the (geodetic) bounds to filter on.
      Returns:
      the bounds to be filtered on
      See Also: