public interface ILcdARINCDecoder extends ILcdModelDecoder
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
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.ILcdARINCHandler
Modifier and Type | Method and Description |
---|---|
void |
addHandlerForTypeToBeDecoded(ILcdARINCHandler aHandler)
Adds an
ILcdARINCHandler to the decoder. |
ILcdBounds |
getBoundsToFilterOn()
Returns the (geodetic) bounds to filter on.
|
String |
getErrorMessage()
Returns the error message of the last decode call (when an error occurred).
|
ILcdARINCHandler |
getHandlerForTypeToBeDecoded(int aIndex)
Returns the handler with the given index.
|
int |
getHandlerForTypeToBeDecodedCount()
Returns the number of handlers set on this decoder.
|
ILcdBounds |
getInitialBounds()
Returns the initial bounds for each model created
in the
decode method. |
void |
removeAllHandlersForTypeToBeDecoded()
Removes all handlers from this decoder.
|
void |
setBoundsToFilterOn(ILcdBounds aBoundsToFilterOn)
Specifies the (geodetic) bounds that will be used as a filter on each model
created in the
decode method. |
void |
setInitialBounds(ILcdBounds aInitialBounds)
Specifies the bounds to be used as initial bounds for each model created
in the
decode method. |
canDecodeSource, canDecodeSource, decode, decodeModelMetadata, decodeModelMetadata, decodeSource, discoverDataSources, getDisplayName
void addHandlerForTypeToBeDecoded(ILcdARINCHandler aHandler)
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
.
aHandler
- an ILcdARINCHandler
implementationgetHandlerForTypeToBeDecoded(int)
,
getHandlerForTypeToBeDecodedCount()
ILcdARINCHandler getHandlerForTypeToBeDecoded(int aIndex)
aIndex
- the index in the list of handlersaddHandlerForTypeToBeDecoded(com.luciad.format.arinc.decoder.ILcdARINCHandler)
,
getHandlerForTypeToBeDecodedCount()
int getHandlerForTypeToBeDecodedCount()
addHandlerForTypeToBeDecoded(com.luciad.format.arinc.decoder.ILcdARINCHandler)
,
getHandlerForTypeToBeDecoded(int)
void removeAllHandlersForTypeToBeDecoded()
String getErrorMessage()
Note: the error message can only be retrieved once after a decode call.
void setInitialBounds(ILcdBounds aInitialBounds)
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.
aInitialBounds
- the initial bounds for each model created in the decode
methodvoid setBoundsToFilterOn(ILcdBounds aBoundsToFilterOn)
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.
aBoundsToFilterOn
- the bounds to be used as a filterILcdBounds getInitialBounds()
decode
method.decode
methodsetInitialBounds(com.luciad.shape.ILcdBounds)
ILcdBounds getBoundsToFilterOn()
setBoundsToFilterOn(com.luciad.shape.ILcdBounds)