Package org.vast.sensorML.helper

Class CommonCharacteristics

java.lang.Object

org.vast.sensorML.helper.SMLPropertiesHelper

org.vast.sensorML.helper.CommonCharacteristics

public class CommonCharacteristics
extends SMLPropertiesHelper

Helper methods to generate common system characteristics

Field Summary

Fields

Modifier and Type	Field	Description
static final Unit	BAT_CAP_AH_UNIT
static final Unit	BAT_CAP_ENERGY_UNIT
static final String	BATT_CAPACITY_DEF
static final String	BATT_CAPACITY_LABEL
static final String	BATT_LIFETIME_DEF
static final String	BATT_LIFETIME_LABEL
static final String	CURRENT_DEF
static final String	CURRENT_LABEL
static final String	DIAMETER_DEF
static final String	DIAMETER_LABEL
static final String	HEIGHT_DEF
static final String	HEIGHT_LABEL
static final String	LENGTH_DEF
static final String	LENGTH_LABEL
static final String	MASS_DEF
static final String	MASS_LABEL
static final String	MATERIAL_DEF
static final String	MATERIAL_LABEL
static final String	OPERATING_RANGE_DEF
static final String	POWER_CONSUMPTION_DEF
static final String	POWER_CONSUMPTION_LABEL
static final String	SURVIVAL_RANGE_DEF
static final String	SYSTEM_LIFETIME_DEF
static final String	SYSTEM_LIFETIME_LABEL
static final String	VOLTAGE_DEF
static final String	VOLTAGE_LABEL
static final String	WIDTH_DEF
static final String	WIDTH_LABEL

Constructor Summary

Constructors

Constructor	Description
CommonCharacteristics(SMLHelper sml)

Method Summary

Modifier and Type	Method	Description
SWEBuilders.QuantityBuilder	batteryCapacity(double val, String uom)
SWEBuilders.QuantityBuilder	batteryCapacity(double val, String uom, boolean useEnergy)
SWEBuilders.QuantityRangeBuilder	batteryCapacityRange(double min, double max, String uom, boolean useEnergy)
SWEBuilders.QuantityBuilder	batteryLifetime(double val, String uom)
SWEBuilders.QuantityBuilder	diameter(double val, String uom)
SWEBuilders.QuantityBuilder	height(double val, String uom)
SWEBuilders.QuantityBuilder	length(double val, String uom)
SWEBuilders.QuantityBuilder	mass(double val, String uom)
SWEBuilders.CategoryBuilder	material(String val)
SWEBuilders.QuantityBuilder	nominalPowerConsumption(double val, String uom)
SMLMetadataBuilders.CharacteristicListBuilder	operatingCharacteristics()	Creates a characteristic list describing the system's operating range
SWEBuilders.QuantityBuilder	operatingCurrent(double val, String uom)
SWEBuilders.QuantityRangeBuilder	operatingCurrentRange(double min, double max, String uom)
SWEBuilders.QuantityBuilder	operatingVoltage(double val, String uom)
SWEBuilders.QuantityRangeBuilder	operatingVoltageRange(double min, double max, String uom)
SMLMetadataBuilders.CharacteristicListBuilder	survivalCharacteristics()	Creates a characteristic list describing the system's survival range
SWEBuilders.QuantityBuilder	systemLifetime(double val, String uom)
SWEBuilders.QuantityBuilder	width(double val, String uom)

Methods inherited from class java.lang.Object

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

Field Details

OPERATING_RANGE_DEF

public static final String OPERATING_RANGE_DEF

See Also:

• Constant Field Values

SURVIVAL_RANGE_DEF

public static final String SURVIVAL_RANGE_DEF

See Also:

• Constant Field Values

MASS_DEF

public static final String MASS_DEF

MASS_LABEL

public static final String MASS_LABEL

See Also:

• Constant Field Values

LENGTH_DEF

public static final String LENGTH_DEF

LENGTH_LABEL

public static final String LENGTH_LABEL

See Also:

• Constant Field Values

WIDTH_DEF

public static final String WIDTH_DEF

WIDTH_LABEL

public static final String WIDTH_LABEL

See Also:

• Constant Field Values

HEIGHT_DEF

public static final String HEIGHT_DEF

HEIGHT_LABEL

public static final String HEIGHT_LABEL

See Also:

• Constant Field Values

DIAMETER_DEF

public static final String DIAMETER_DEF

DIAMETER_LABEL

public static final String DIAMETER_LABEL

See Also:

• Constant Field Values

MATERIAL_DEF

public static final String MATERIAL_DEF

MATERIAL_LABEL

public static final String MATERIAL_LABEL

See Also:

• Constant Field Values

VOLTAGE_DEF

public static final String VOLTAGE_DEF

VOLTAGE_LABEL

public static final String VOLTAGE_LABEL

See Also:

• Constant Field Values

CURRENT_DEF

public static final String CURRENT_DEF

CURRENT_LABEL

public static final String CURRENT_LABEL

See Also:

• Constant Field Values

POWER_CONSUMPTION_DEF

public static final String POWER_CONSUMPTION_DEF

POWER_CONSUMPTION_LABEL

public static final String POWER_CONSUMPTION_LABEL

See Also:

• Constant Field Values

BATT_CAPACITY_DEF

public static final String BATT_CAPACITY_DEF

BATT_CAPACITY_LABEL

public static final String BATT_CAPACITY_LABEL

See Also:

• Constant Field Values

BATT_LIFETIME_DEF

public static final String BATT_LIFETIME_DEF

See Also:

• Constant Field Values

BATT_LIFETIME_LABEL

public static final String BATT_LIFETIME_LABEL

See Also:

• Constant Field Values

SYSTEM_LIFETIME_DEF

public static final String SYSTEM_LIFETIME_DEF

See Also:

• Constant Field Values

SYSTEM_LIFETIME_LABEL

public static final String SYSTEM_LIFETIME_LABEL

See Also:

• Constant Field Values

BAT_CAP_ENERGY_UNIT

public static final Unit BAT_CAP_ENERGY_UNIT

BAT_CAP_AH_UNIT

public static final Unit BAT_CAP_AH_UNIT

Constructor Details

CommonCharacteristics

public CommonCharacteristics(SMLHelper sml)

Method Details

operatingCharacteristics

public SMLMetadataBuilders.CharacteristicListBuilder operatingCharacteristics()

Creates a characteristic list describing the system's operating range

Returns:

The pre-configured builder for chaining

survivalCharacteristics

public SMLMetadataBuilders.CharacteristicListBuilder survivalCharacteristics()

Creates a characteristic list describing the system's survival range

Returns:

The pre-configured builder for chaining

mass

public SWEBuilders.QuantityBuilder mass(double val,
 String uom)

length

public SWEBuilders.QuantityBuilder length(double val,
 String uom)

width

public SWEBuilders.QuantityBuilder width(double val,
 String uom)

height

public SWEBuilders.QuantityBuilder height(double val,
 String uom)

diameter

public SWEBuilders.QuantityBuilder diameter(double val,
 String uom)

material

public SWEBuilders.CategoryBuilder material(String val)

operatingVoltage

public SWEBuilders.QuantityBuilder operatingVoltage(double val,
 String uom)

operatingVoltageRange

public SWEBuilders.QuantityRangeBuilder operatingVoltageRange(double min,
 double max,
 String uom)

operatingCurrent

public SWEBuilders.QuantityBuilder operatingCurrent(double val,
 String uom)

operatingCurrentRange

public SWEBuilders.QuantityRangeBuilder operatingCurrentRange(double min,
 double max,
 String uom)

nominalPowerConsumption

public SWEBuilders.QuantityBuilder nominalPowerConsumption(double val,
 String uom)

batteryCapacity

public SWEBuilders.QuantityBuilder batteryCapacity(double val,
 String uom)

batteryCapacity

public SWEBuilders.QuantityBuilder batteryCapacity(double val,
 String uom,
 boolean useEnergy)

batteryCapacityRange

public SWEBuilders.QuantityRangeBuilder batteryCapacityRange(double min,
 double max,
 String uom,
 boolean useEnergy)

batteryLifetime

public SWEBuilders.QuantityBuilder batteryLifetime(double val,
 String uom)

systemLifetime

public SWEBuilders.QuantityBuilder systemLifetime(double val,
 String uom)