Visioscan Set SDK Libraries 1.0.14
Visioscan Set SDK Help documentation file for C++ and C++/CLI
 
Loading...
Searching...
No Matches
Bea::AgvSensorWrapper::Sensor::WAgvSensor Class Reference

#include <WAgvSensor.h>

Inheritance diagram for Bea::AgvSensorWrapper::Sensor::WAgvSensor:

Public Member Functions

 WAgvSensor ()
 
 WAgvSensor (WBaseCommunication^ pcomm)
 
 ~WAgvSensor ()
 
WCommunicationStatus Initialize () override
 Initializes the object to connect the sensor.
 
WRawData RetrieveRawData ()
 
void SendMdi ()
 Request the sensor to start sending MDI data to host.
 
void StopMdi ()
 Request the sensor to stop sending MDI data to host.
 
Protocol GetRawDataExchangeMode ()
 Get the raw data exchange mode.
 
WAngleRange GetAngleRange ()
 Gets the angle range.
 
ScanPacketType GetDataPacketType ()
 Gets the data packed type.
 
unsigned int GetImmunityLevel ()
 Gets the immunity level.
 
WContaminationThreshold GetContaminationThreshold ()
 Gets the contamination threshold.
 
WSoftwareVersion GetVersion () override
 Gets the sensor version data.
 
int GetTemperature ()
 Gets the temperature.
 
List< WRawDataError^> GetErrorLog ()
 Gets the error log.
 
WNetworkInformation GetNetworkInformation ()
 Gets whole data information.
 
String GetDeviceName ()
 Gets the sensor's name.
 
WConfigurationResult SetRawDataExchangeMode (Protocol pProtocol)
 Sets the RAW data exchange mode. Can be either TCP or UDP.
 
WConfigurationResult SetDataPacketType (ScanPacketType pPacketType)
 Sets the packet type returned in raw data. Can be either ScanPacketType::Distance or ScanPacketType::DistanceAndIntensity.
 
WConfigurationResult SetAngleRange (WAngleRange^ pAngleRange)
 Sets the Angle range (start and stop)
 
WConfigurationResult SetImmunityLevel (int pImmunityLevel)
 Sets the sensor's immunity level.
 
WConfigurationResult SetContaminationThreshold (WContaminationThreshold^ pContaminationThreshold)
 Sets the contamination level threshold for warning and error.
 
WConfigurationResult SetNetworkInformation (WNetworkInformation^ pNetwork)
 Set the overall network information except IP v4 and Port.
 
WConfigurationResult SetDeviceName (String^ pName)
 Sets the sensor's name.
 
void ResetDevice ()
 Resets the device.
 
void RebootDevice ()
 Reboots the device.
 
List< unsigned int > GetWms ()
 Returns the window monitoring system of each sector (SECTORS_COUNT sectors - 132 -)
 
WFieldName GetFieldName (int fieldSetNumber)
 Gets the sensor lamps status.
 
WObjectSize GetObjectSize ()
 Gets the object size.
 
WFieldData GetField (int fieldNumber, ZoneTypeEnum zone)
 Returns the requested field data.
 
WMultipleSampling GetMultipleSampling ()
 Gets the multiple sampling data.
 
WHoldTime GetHoldTime ()
 Gets Hold Time (ms)
 
WOutputActiveLevel GetOutputActiveLevel ()
 Gets the output active level for 4 outputs.
 
WOutputFunction GetOutputFunction ()
 Gest the output function for 4 outputs.
 
WAgvSensorLeds GetSensorLeds ()
 Gets the navigation sensor leds status.
 
WConfigurationResult SetFieldName (WFieldName^ fieldName)
 Sets the field name data.
 
WConfigurationResult SetObjectSize (WObjectSize^ sizeToSet)
 Sets the object size.
 
WConfigurationResult SetField (WFieldData^ data)
 Set the requested field data.
 
WConfigurationResult SetMultipleSampling (WMultipleSampling^ sampling)
 Sets the multiple sampling.
 
WConfigurationResult SetHoldTime (WHoldTime^ holdTime)
 Sets the Hold time.
 
WConfigurationResult SetOutputActiveLevel (WOutputActiveLevel^ activeLevel)
 Sets the output active level.
 
WConfigurationResult SetOutputFunction (WOutputFunction^ function)
 Sets the output function.
 
WConfigurationResult SetSensorLeds (WAgvSensorLeds^ leds)
 Sets the sensor's leds.
 
WConfigurationResult StoreInFlash ()
 Store fields in the flash.
 

Protected Member Functions

WConfigurationResult toManagedInstance (ConfigurationResult pResult)
 

Constructor & Destructor Documentation

◆ WAgvSensor() [1/2]

Bea::AgvSensorWrapper::Sensor::WAgvSensor::WAgvSensor ( )
inline

◆ WAgvSensor() [2/2]

Bea::AgvSensorWrapper::Sensor::WAgvSensor::WAgvSensor ( WBaseCommunication^ pcomm)
inline

◆ ~WAgvSensor()

Bea::AgvSensorWrapper::Sensor::WAgvSensor::~WAgvSensor ( )
inline

Member Function Documentation

◆ GetAngleRange()

WAngleRange Bea::AgvSensorWrapper::Sensor::WAgvSensor::GetAngleRange ( )
inline

Gets the angle range.

Returns
An encapsulation of angle range

◆ GetContaminationThreshold()

WContaminationThreshold Bea::AgvSensorWrapper::Sensor::WAgvSensor::GetContaminationThreshold ( )
inline

Gets the contamination threshold.

Returns
An encapsulation of the contamination threshold

◆ GetDataPacketType()

ScanPacketType Bea::AgvSensorWrapper::Sensor::WAgvSensor::GetDataPacketType ( )
inline

Gets the data packed type.

Returns
ScanPacketType::Distance or ScanPacketType::DistanceAndIntensity enum

◆ GetDeviceName()

String Bea::AgvSensorWrapper::Sensor::WAgvSensor::GetDeviceName ( )
inline

Gets the sensor's name.

Returns
A string representing the sensor's name

◆ GetErrorLog()

List< WRawDataError^> Bea::AgvSensorWrapper::Sensor::WAgvSensor::GetErrorLog ( )
inline

Gets the error log.

Returns
An encapsulation representing the error log

◆ GetField()

WFieldData Bea::AgvSensorWrapper::Sensor::WAgvSensor::GetField ( int fieldNumber,
ZoneTypeEnum zone )
inline

Returns the requested field data.

Parameters
fieldNumberThe field number we want to retrieve
zoneThe zone type (Protection, Warning 1, Warning 2)
Returns
An object encapsulating the results

◆ GetFieldName()

WFieldName Bea::AgvSensorWrapper::Sensor::WAgvSensor::GetFieldName ( int fieldSetNumber)
inline

Gets the sensor lamps status.

Returns
An encapsulation of the sensor's internal lamps status

Gets the field name for a given field number

Parameters
fieldSetNumberThe fieldset number to retrieve
Returns
An encapsulation of date

◆ GetHoldTime()

WHoldTime Bea::AgvSensorWrapper::Sensor::WAgvSensor::GetHoldTime ( )
inline

Gets Hold Time (ms)

Returns

◆ GetImmunityLevel()

unsigned int Bea::AgvSensorWrapper::Sensor::WAgvSensor::GetImmunityLevel ( )
inline

Gets the immunity level.

Returns
An integer representing the immunity level

◆ GetMultipleSampling()

WMultipleSampling Bea::AgvSensorWrapper::Sensor::WAgvSensor::GetMultipleSampling ( )
inline

Gets the multiple sampling data.

Returns
An ogject encapsulating warning 1 & 2 and protection

◆ GetNetworkInformation()

WNetworkInformation Bea::AgvSensorWrapper::Sensor::WAgvSensor::GetNetworkInformation ( )
inline

Gets whole data information.

Returns
An encapsulated way to group the network information

◆ GetObjectSize()

WObjectSize Bea::AgvSensorWrapper::Sensor::WAgvSensor::GetObjectSize ( )
inline

Gets the object size.

Returns
An encapsulation of enums

◆ GetOutputActiveLevel()

WOutputActiveLevel Bea::AgvSensorWrapper::Sensor::WAgvSensor::GetOutputActiveLevel ( )
inline

Gets the output active level for 4 outputs.

Returns
An object encapsulating the levels

◆ GetOutputFunction()

WOutputFunction Bea::AgvSensorWrapper::Sensor::WAgvSensor::GetOutputFunction ( )
inline

Gest the output function for 4 outputs.

Returns
An object encapsulating the functions

◆ GetRawDataExchangeMode()

Protocol Bea::AgvSensorWrapper::Sensor::WAgvSensor::GetRawDataExchangeMode ( )
inline

Get the raw data exchange mode.

Returns
Protocol::Udp or Protocol::Tcp enum

◆ GetSensorLeds()

WAgvSensorLeds Bea::AgvSensorWrapper::Sensor::WAgvSensor::GetSensorLeds ( )
inline

Gets the navigation sensor leds status.

◆ GetTemperature()

int Bea::AgvSensorWrapper::Sensor::WAgvSensor::GetTemperature ( )
inline

Gets the temperature.

Returns
An integer representing the sensor's temperature

◆ GetVersion()

WSoftwareVersion Bea::AgvSensorWrapper::Sensor::WAgvSensor::GetVersion ( )
inlineoverride

Gets the sensor version data.

Returns
An encapsulation representing the sensor version

◆ GetWms()

List< unsigned int > Bea::AgvSensorWrapper::Sensor::WAgvSensor::GetWms ( )
inline

Returns the window monitoring system of each sector (SECTORS_COUNT sectors - 132 -)

Returns

◆ Initialize()

WCommunicationStatus Bea::AgvSensorWrapper::Sensor::WAgvSensor::Initialize ( )
inlineoverride

Initializes the object to connect the sensor.

◆ RebootDevice()

void Bea::AgvSensorWrapper::Sensor::WAgvSensor::RebootDevice ( )
inline

Reboots the device.

◆ ResetDevice()

void Bea::AgvSensorWrapper::Sensor::WAgvSensor::ResetDevice ( )
inline

Resets the device.

◆ RetrieveRawData()

WRawData Bea::AgvSensorWrapper::Sensor::WAgvSensor::RetrieveRawData ( )
inline

◆ SendMdi()

void Bea::AgvSensorWrapper::Sensor::WAgvSensor::SendMdi ( )
inline

Request the sensor to start sending MDI data to host.

◆ SetAngleRange()

WConfigurationResult Bea::AgvSensorWrapper::Sensor::WAgvSensor::SetAngleRange ( WAngleRange^ pAngleRange)
inline

Sets the Angle range (start and stop)

Parameters
pAngleRangeThe encapsulation of the angle range to be set
Returns
A configuration result encapsulation

◆ SetContaminationThreshold()

WConfigurationResult Bea::AgvSensorWrapper::Sensor::WAgvSensor::SetContaminationThreshold ( WContaminationThreshold^ pContaminationThreshold)
inline

Sets the contamination level threshold for warning and error.

Parameters
pContaminationThresholdThe encapsulation of contamination leve threshold
Returns
A configuration result encapsulation

◆ SetDataPacketType()

WConfigurationResult Bea::AgvSensorWrapper::Sensor::WAgvSensor::SetDataPacketType ( ScanPacketType pPacketType)
inline

Sets the packet type returned in raw data. Can be either ScanPacketType::Distance or ScanPacketType::DistanceAndIntensity.

Parameters
pPacketTypeThe packet type to be set
Returns
A configuration result encapsulation

◆ SetDeviceName()

WConfigurationResult Bea::AgvSensorWrapper::Sensor::WAgvSensor::SetDeviceName ( String^ pName)
inline

Sets the sensor's name.

Returns
A string representing the sensor's name

◆ SetField()

WConfigurationResult Bea::AgvSensorWrapper::Sensor::WAgvSensor::SetField ( WFieldData^ data)
inline

Set the requested field data.

Returns
A configuration result encapsulation

◆ SetFieldName()

WConfigurationResult Bea::AgvSensorWrapper::Sensor::WAgvSensor::SetFieldName ( WFieldName^ fieldName)
inline

Sets the field name data.

Parameters
fieldName
Returns
A configuration result encapsulation

◆ SetHoldTime()

WConfigurationResult Bea::AgvSensorWrapper::Sensor::WAgvSensor::SetHoldTime ( WHoldTime^ holdTime)
inline

Sets the Hold time.

Returns
A configuration result encapsulation

◆ SetImmunityLevel()

WConfigurationResult Bea::AgvSensorWrapper::Sensor::WAgvSensor::SetImmunityLevel ( int pImmunityLevel)
inline

Sets the sensor's immunity level.

Parameters
pImmunityLevelThe immunity level to be set
Returns
A configuration result encapsulation

◆ SetMultipleSampling()

WConfigurationResult Bea::AgvSensorWrapper::Sensor::WAgvSensor::SetMultipleSampling ( WMultipleSampling^ sampling)
inline

Sets the multiple sampling.

Parameters
sampling
Returns
A configuration result encapsulation

◆ SetNetworkInformation()

WConfigurationResult Bea::AgvSensorWrapper::Sensor::WAgvSensor::SetNetworkInformation ( WNetworkInformation^ pNetwork)
inline

Set the overall network information except IP v4 and Port.

Parameters
pNetworkAn encapsulation of the network data
Returns
A configuration result encapsulation

◆ SetObjectSize()

WConfigurationResult Bea::AgvSensorWrapper::Sensor::WAgvSensor::SetObjectSize ( WObjectSize^ sizeToSet)
inline

Sets the object size.

Parameters
sizeToSet
Returns
A configuration result encapsulation

◆ SetOutputActiveLevel()

WConfigurationResult Bea::AgvSensorWrapper::Sensor::WAgvSensor::SetOutputActiveLevel ( WOutputActiveLevel^ activeLevel)
inline

Sets the output active level.

Parameters
activeLevel
Returns
A configuration result encapsulation

◆ SetOutputFunction()

WConfigurationResult Bea::AgvSensorWrapper::Sensor::WAgvSensor::SetOutputFunction ( WOutputFunction^ function)
inline

Sets the output function.

Parameters
function
Returns
A configuration result encapsulation

◆ SetRawDataExchangeMode()

WConfigurationResult Bea::AgvSensorWrapper::Sensor::WAgvSensor::SetRawDataExchangeMode ( Protocol pProtocol)
inline

Sets the RAW data exchange mode. Can be either TCP or UDP.

Parameters
pProtocolThe exchange mode (TCP or UDP)
Returns
A configuration result encapsulation

◆ SetSensorLeds()

WConfigurationResult Bea::AgvSensorWrapper::Sensor::WAgvSensor::SetSensorLeds ( WAgvSensorLeds^ leds)
inline

Sets the sensor's leds.

Parameters
leds
Returns
A configuration result encapsulation

◆ StopMdi()

void Bea::AgvSensorWrapper::Sensor::WAgvSensor::StopMdi ( )
inline

Request the sensor to stop sending MDI data to host.

◆ StoreInFlash()

WConfigurationResult Bea::AgvSensorWrapper::Sensor::WAgvSensor::StoreInFlash ( )
inline

Store fields in the flash.

Returns
A configuration result encapsulation

◆ toManagedInstance()

WConfigurationResult Bea::AgvSensorWrapper::Sensor::WAgvSensor::toManagedInstance ( ConfigurationResult pResult)
inlineprotected

The documentation for this class was generated from the following file: