org.jmisb.api.klv.st0805

Class ConversionConfiguration

java.lang.Object

org.jmisb.api.klv.st0805.ConversionConfiguration

public class ConversionConfiguration
extends Object

Configuration options for KLV to CoT conversion.

This is intended to be set up, and be enduring over multiple CoT conversions.

Constructor Summary

Constructors

Constructor and Description
ConversionConfiguration()

Method Summary

Modifier and Type	Method and Description
String	getPlatformType() Get the CoT platform type.
String	getPlatformUidFallback() Get a fallback value for the Platform uid string.
String	getPlatformUidOverride() Get an override value for the Platform uid string.
String	getSensorSuffixFallback() Get the fallback value for sensor UID suffix.
String	getSensorUidOverride() Get an override value for the Sensor uid string.
long	getStalePeriod() Get the stale time.
void	setPlatformType(String platformType) Set the CoT platform type.
void	setPlatformUidFallback(String uid) Set the fallback value for the Platform uid.
void	setPlatformUidOverride(String uid) Set the override value for the Platform uid.
void	setSensorSuffixFallback(String suffix) Set the fallback value for sensor UID suffix.
void	setSensorUidOverride(String uid) Set the override value for the Sensor uid.
void	setStalePeriod(long stalePeriod) Set the stale time.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConversionConfiguration

public ConversionConfiguration()

Method Detail

getPlatformType

public String getPlatformType()

Get the CoT platform type.

Returns:

the platform type as a valid CoT platform type.

setPlatformType

public void setPlatformType(String platformType)

Set the CoT platform type.

Examples are "a-f-A-M-F" for atom-friendly-Air AOB-Military-Fixed Wing, or "a-f-A-M-F-Q" for a UAV variant of that. Substitute "H" for "F" to represent rotary wing. See the CoT "event.xml" list for options, of which there are many.

Parameters:

platformType - the platform type as String.

getStalePeriod

public long getStalePeriod()

Get the stale time.

This is the time after the valid time at which the message is no longer valid.

Returns:

stale time in microseconds

setStalePeriod

public void setStalePeriod(long stalePeriod)

Set the stale time.

This is the time after the valid time at which the message is no longer valid.

Parameters:

stalePeriod - the stale period in microseconds.

getPlatformUidOverride

public String getPlatformUidOverride()

Get an override value for the Platform uid string.

Returns:

the uid string, or null if the uid should not be overridden.

setPlatformUidOverride

public void setPlatformUidOverride(String uid)

Set the override value for the Platform uid.

Parameters:

uid - the platform uid.

getSensorUidOverride

public String getSensorUidOverride()

Get an override value for the Sensor uid string.

Returns:

the uid string, or null if the uid should not be overridden.

setSensorUidOverride

public void setSensorUidOverride(String uid)

Set the override value for the Sensor uid.

Parameters:

uid - the platform uid.

getPlatformUidFallback

public String getPlatformUidFallback()

Get a fallback value for the Platform uid string.

Returns:

the uid string.

setPlatformUidFallback

public void setPlatformUidFallback(String uid)

Set the fallback value for the Platform uid.

Parameters:

uid - the platform uid, not null.

getSensorSuffixFallback

public String getSensorSuffixFallback()

Get the fallback value for sensor UID suffix.

This provides a fallback suffix for the sensor UID construction. It does not provide the whole UID, but instead will be added to the platform UID fallback if the image source sensor value is not available.

Returns:

the fallback suffix as a string

setSensorSuffixFallback

public void setSensorSuffixFallback(String suffix)

Set the fallback value for sensor UID suffix.

This provides a fallback suffix for the sensor UID construction. It does not provide the whole UID, but instead will be added to the platform UID fallback if the image source sensor value is not available.

Parameters:

suffix - the fallback sensor identifier