WsfSensor

WsfSensor inherits WsfArticulatedPart

Static Methods

static bool IsA_TypeOf(string aDerivedType, string aBaseType)

Returns true if the sensor type specified by aDerivedType inherits from the sensor type specified by aBaseType (compare to WsfObject.IsA_TypeOf(aBaseType), which determines if a specific object inherits from aBaseType).

This method can be used when one only knows the type of the sensor (as a string) and does not have a reference to the actual sensor.

Methods

bool TurnOff()

Turns the sensor off and returns true if successful.

bool TurnOn()

Turns the sensor on and returns true if successful.

int ModeCount()

Returns the number of modes.

int LaserCode()

Returns the value of Laser Code this sensor will track or designate. (This value will remain ignored by many sensor types.)

void SetLaserCode(int aValue)

Sets the value of Laser Code this sensor will track or designate. (This value will remain ignored by many sensor types.)

string ModeName(int aModeIndex)

Returns the name of the mode located at the provided index.

string CurrentMode()

Returns the name of the current mode.

Note

This method is not valid for sensors that support simultaneous operation of multiple modes as defined by the selection_mode command in the sensor.Calling this method on such a sensor will return the string “<multi_select>”.

void SelectMode(string aMode)

Selects the specified mode and makes it the current mode.

void DeselectMode(string aMode)

Deselects the specified mode iff the sensor is a multiple_select sensor with multiple modes currently selected.

Note

This method is and does not operate (i.e. is not valid) for single select mode sensors or on a multi-select sensor with only one mode selected.

int BeamCount()

Returns the number of beams defined for the current sensor mode.

Note

If the sensor does not support beams, this method will return 0.

int BeamCount(int aModeIndex)

Returns the number of beams defined the mode of the given index.

Note

If the sensor does not support beams or the mode index is out-of-bounds, this method will return 0.

int BeamCount(string aMode)

Returns the number of beams defined the mode of the given name.

Note

If the sensor does not support beams or the mode of the given name is not defined, this method will return 0.

double FrameTime()

Return the frame time of the currently selected sensor mode.

WsfFieldOfView FOV()

Return the WsfFieldOfView associated with the sensor’s first defined receiver antenna for the current sensor mode.

Note

If no field of view exists, this method will abort.

WsfFieldOfView FOV(int aIndex)

Return the WsfFieldOfView associated with the receiver’s antenna on the sensor for the specified receiver index on the currently selected sensor mode.

Note

If no field of view exists for the specified receiver, this method will abort.

WsfFieldOfView FOV(int aModeIndex, int aIndex)

Return the WsfFieldOfView associated with the receiver’s antenna on the sensor for the specified receiver index and sensor mode.

Note

If no field of view exists for the specified mode and receiver, this method will abort.

double FOV_MinimumAzimuth()

double FOV_MaximumAzimuth()

double FOV_MinimumElevation()

double FOV_MaximumElevation()

Returns the requested value from the definition of ‘field of view’ for the current mode as defined by azimuth_field_of_view and elevation_field_of_view.

Note

For multi-beam radars, this value will represent the largest extent from all beams.

Note

These methods are only valid when using the default rectangular field of view; otherwise, utilize WsfSensor.FOV.

double FOV_MinimumRange()

double FOV_MaximumRange()

Returns the requested value from the definition of minimum_range and maximum_range.

Note

For multi-beam radars, this value will represent the largest extent from all beams.

void SetFOV(WsfFieldOfView aFOV)

Sets the field of view on all the sensor’s active receivers.

void SetFOV(WsfFieldOfView aFOV, int aReceiverNumber)

Sets the field of view on the specified receiver.

Note

The receiver upon which the field of view is set is accessed by the one parameter WsfSensor.Rcvr method.

void SetFOV(WsfFieldOfView aFOV, int aModeNumber, int aReceiverNumber)

Sets the field of view on the specified receiver with the given mode number.

Note

The receiver upon which the field of view is set is accessed by the two parameter WsfSensor.Rcvr method.

void SetFOV_Azimuth(double aMinimumAzimuth, double aMaximumAzimuth)

void SetFOV_Elevation(double aMinimumElevation, double aMaximumElevation)

Sets the azimuth or elevation field of view for the sensor’s active receivers. If a sensor has more than one active receiver, these methods will modify each one.

Note

These methods are only valid when the active receivers use the default rectangular field of view; otherwise, utilize WsfSensor.SetFOV.

void SetFOV_Range(double aMinimumRange, double aMaximumRange)

Sets range limits associated with the field of view such that targets are not detected outside those limits. If a sensor has more than one active receiver, this method will modify each one.

Note

Calling this method has the same effect as providing the antenna minimum_range and maximum_range commands.

bool CanScanInAzimuth()

bool CanScanInElevation()

Returns true if the current mode can scan in the requested direction, as defined by the scan_mode command.

Note

For multi-beam radars, the return value will be true if any beam can scan in the requested direction.

double ScanMinimumAzimuth()

double ScanMaximumAzimuth()

double ScanMinimumElevation()

double ScanMaximumElevation()

Returns the requested value from the definition of the ‘scan volume’ for the current mode as defined by azimuth_scan_limits and elevation_scan_limits.

Note

The return value will be zero if the scan_mode do not indicate that scanning is allowed in the requested direction.

Note

For multibeam radars, this value will represent the largest extent from all beams.

bool WithinFieldOfView(WsfGeoPoint aPoint)

Returns true if the specified point is within the range and field of view limits of the current mode of the sensor. If the sensor is cued, the range and field of view are with respect to the cue.

int ActiveTrackCount()

Returns the current number of objects the sensor is tracking.

int MaximumTrackCount()

Returns the maximum number of objects the sensor can track.

double TrackQuality()

double TrackQuality(string aMode)

double TrackQuality(int aModeIndex)

Returns the track quality associated with a sensor mode. The first form returns the quality for the current sensor mode, while the remaining two return the quality for the mode corresponding to the specified name or index.

Note

These methods return -1.0 when the mode does not exist, and 0.5 if the mode exists but the track quality was not otherwise defined.

int MaximumRequestCount(string aMode)

int MaximumRequestCount()

Returns the maximum number of track requests. The first form returns the count for the specified mode while the second form returns the sum of the counts for all modes.

int ActiveRequestCount(string aMode)

int ActiveRequestCount()

Returns the current number of active track requests. The first form returns the count for the specified mode while the second form returns the sum of the counts for all modes.

bool HaveRequestFor(WsfTrackId aTrackId)

Returns ‘true’ if a StartTracking request is active for the specified track ID.

bool StartTracking(WsfTrack aTrack, string aMode)

Starts (or continues) tracking the given track using the specified sensor mode. Returns true if successful.

bool StopTracking(WsfTrackId aTrackId)

Stops tracking the track with the given track id. Returns true if successful.

WsfEM_Xmtr Xmtr(int aIndex)

WsfEM_Xmtr Xmtr(int aModeIndex, int aIndex)

Returns the transmitter object on the sensor at the specified index or mode index and index if supplied.

Note

Check the returned transmitter for validity before using.

int XmtrCount()

int XmtrCount(int aModeIndex)

Returns the transmitter count on the sensor for all modes or at the mode index if supplied.

WsfEM_Rcvr Rcvr(int aIndex)

WsfEM_Rcvr Rcvr(int aModeIndex, int aIndex)

Returns the receiver object on the sensor at the specified index or mode index and index if supplied.

Note

Check the returned receiver for validity before using.

int RcvrCount()

int RcvrCount(int aModeIndex)

Returns the receiver count on the sensor for all modes or at the mode index if supplied.

Military Specific

Electronic Warfare Methods

Note

WSF_TASK_PROCESSOR (WsfTaskManager) also has a StartTracking method. When using a task manager, you should use its StartTracking and StopTracking methods to control sensor operations as it provides additional capabilities.

Note

WSF_TASK_PROCESSOR (WsfTaskManager) also has a StopTracking method. When using a task manager,you should use its StartTracking and StopTracking methods to control sensor operations as it is provides additional capabilities.

bool JammingPerceived(string aMode)

bool JammingPerceived()

Returns true if the sensor (operator) perceives jamming as defined by the jamming_perception_threshold and jamming_perception_timeout.

Note

This method is only valid for sensors deriving from type WSF_RADAR_SENSOR.

bool ContinuousJammingPerceived(string aMode)

bool ContinuousJammingPerceived()

Returns true if the sensor (operator) perceives continuous (i.e., noise) type jamming as defined by the jamming_perception_threshold and jamming_perception_timeout.

Note

This method is only valid for sensors deriving from type WSF_RADAR_SENSOR.

bool PulseJammingPerceived(string aMode)

bool PulseJammingPerceived()

Returns true if the sensor (operator) perceives pulse type jamming as defined by the jamming_perception_threshold and jamming_perception_timeout.

Note

This method is only valid for sensors deriving from type WSF_RADAR_SENSOR.

bool IsEP_TechniqueActive(string aTechniqueName, string aMode)

bool IsEP_TechniqueActive(string aTechniqueName)

Is the technique with supplied name currently in use (i.e., turned on) for the specified mode if included? Returns true if it is in use and false otherwise.

Note

If no mode is specified current mode is assumed.

Note

The EP technique active check will be for all beams on the specified/current mode. If any of the beams are active true will be returned.

bool SelectEP_Technique(string aTechniqueName, string aMode)

bool SelectEP_Technique(string aTechniqueName)

Selects the technique with supplied name to use (i.e., turns on) on the specified mode, if included. Returns true if successful and false otherwise.

Note

If no mode is specified current mode is assumed.

Note

The EP technique will be selected for all beams on the specified/current mode.

bool DeselectEP_Technique(string aTechniqueName, string aMode)

bool DeselectEP_Technique(string aTechniqueName)

Deselects the technique with supplied name to use (i.e., turns on) on the specified mode, if included. Returns true if successful.

Note

If no mode is specified current mode is assumed.

Note

The EP technique will be deselected for all beams on the specified/current mode.