NetOceanDirectLighthouse  3.1.1
OceanDirect Lighthouse .NET API
Public Member Functions | Static Public Member Functions | Static Protected Attributes | List of all members
NetLighthouse::NetLighthouseStrobe Class Reference

Inherits ManagedObject.

Public Member Functions

virtual lh_microseconds_t getContinuousStrobePeriod (unsigned int deviceID, int %errorCode)
 
virtual lh_microseconds_t getContinuousStrobePeriodIncrement (unsigned int deviceID, int %errorCode)
 
virtual lh_microseconds_t getContinuousStrobePeriodMaximum (unsigned int deviceID, int %errorCode)
 
virtual lh_microseconds_t getContinuousStrobePeriodMinimum (unsigned int deviceID, int %errorCode)
 
virtual net_lh_enable_state_t getContinuousStrobeState (unsigned int deviceID, int %errorCode)
 
virtual lh_microseconds_t getSingleStrobeDelay (unsigned int deviceID, int %errorCode)
 
virtual lh_microseconds_t getSingleStrobeDelayIncrement (unsigned int deviceID, int %errorCode)
 
virtual lh_microseconds_t getSingleStrobeDelayMaximum (unsigned int deviceID, int %errorCode)
 
virtual lh_microseconds_t getSingleStrobeDelayMinimum (unsigned int deviceID, int %errorCode)
 
virtual net_lh_enable_state_t getSingleStrobeState (unsigned int deviceID, int %errorCode)
 
virtual lh_microseconds_t getSingleStrobeWidth (unsigned int deviceID, int %errorCode)
 
virtual lh_microseconds_t getSingleStrobeWidthIncrement (unsigned int deviceID, int %errorCode)
 
virtual lh_microseconds_t getSingleStrobeWidthMaximum (unsigned int deviceID, int %errorCode)
 
virtual lh_microseconds_t getSingleStrobeWidthMinimum (unsigned int deviceID, int %errorCode)
 
virtual void setContinuousStrobePeriod (unsigned int deviceID, int% errorCode, lh_microseconds_t microseconds)
 
virtual void setContinuousStrobeState (unsigned int deviceID, int %errorCode, net_lh_enable_state_t state)
 
virtual void setSingleStrobeDelay (unsigned int deviceID, int %errorCode, lh_microseconds_t microseconds)
 
virtual void setSingleStrobeState (unsigned int deviceID, int %errorCode, net_lh_enable_state_t state)
 
virtual void setSingleStrobeWidth (unsigned int deviceID, int %errorCode, lh_microseconds_t microseconds)
 

Static Public Member Functions

static NetLighthouseStrobe getInstance ()
 

Static Protected Attributes

static NetLighthouseStrobe strobe
 

Member Function Documentation

◆ getContinuousStrobePeriod()

lh_microseconds_t NetLighthouseStrobe::getContinuousStrobePeriod ( unsigned int  deviceID,
int %  errorCode 
)
virtual

.getContinuousStrobePeriod Return the continuous strobe period in microseconds.

See also
setContinuousStrobePeriod()
Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the continuous strobe period in microseconds or 0 on error.

◆ getContinuousStrobePeriodIncrement()

lh_microseconds_t NetLighthouseStrobe::getContinuousStrobePeriodIncrement ( unsigned int  deviceID,
int %  errorCode 
)
virtual

.getContinuousStrobePeriodIncrement Return the continuous strobe period increment in microseconds. The increment is the minimum value between two adjacent (valid) continuous strobe period values.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the continuous strobe period increment in microseconds or 0 on error.

◆ getContinuousStrobePeriodMaximum()

lh_microseconds_t NetLighthouseStrobe::getContinuousStrobePeriodMaximum ( unsigned int  deviceID,
int %  errorCode 
)
virtual

.getContinuousStrobePeriodMaximum Return the maximum continuous strobe period in microseconds.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the maximum continuous strobe period in microseconds or 0 on error.

◆ getContinuousStrobePeriodMinimum()

lh_microseconds_t NetLighthouseStrobe::getContinuousStrobePeriodMinimum ( unsigned int  deviceID,
int %  errorCode 
)
virtual

.getContinuousStrobePeriodMinimum Return the minimum continuous strobe period in microseconds.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the minimum continuous strobe period in microseconds or 0 on error.

◆ getContinuousStrobeState()

net_lh_enable_state_t NetLighthouseStrobe::getContinuousStrobeState ( unsigned int  deviceID,
int %  errorCode 
)
virtual

.getContinuousStrobeState Determine if continuous strobe is enabled or disabled on the device.

See also
setContinuousStrobeState()
Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
state "on" if continuous strobe is enabled, "off" if continuous strobe is disabled or on error.

◆ getSingleStrobeDelay()

lh_microseconds_t NetLighthouseStrobe::getSingleStrobeDelay ( unsigned int  deviceID,
int %  errorCode 
)
virtual

.getSingleStrobeDelay Get the single strobe delay in microseconds.

See also
setSingleStrobeDelay()
Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the current single strobe delay in microseconds or 0 on error.

◆ getSingleStrobeDelayIncrement()

lh_microseconds_t NetLighthouseStrobe::getSingleStrobeDelayIncrement ( unsigned int  deviceID,
int %  errorCode 
)
virtual

.getSingleStrobeDelayIncrement Return the single strobe delay increment in microseconds. The increment is the minimum value between two adjacent (valid) single strobe delay values.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the single strobe delay increment in microseconds or 0 on error.

◆ getSingleStrobeDelayMaximum()

lh_microseconds_t NetLighthouseStrobe::getSingleStrobeDelayMaximum ( unsigned int  deviceID,
int %  errorCode 
)
virtual

.getSingleStrobeDelayMaximum Get the maximum single strobe delay in microseconds.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the maximum single strobe delay in microseconds or 0 on error.

◆ getSingleStrobeDelayMinimum()

lh_microseconds_t NetLighthouseStrobe::getSingleStrobeDelayMinimum ( unsigned int  deviceID,
int %  errorCode 
)
virtual

.getSingleStrobeDelayMinimum Get the minimum single strobe delay in microseconds.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the minimum single strobe delay in microseconds or 0 on error.

◆ getSingleStrobeState()

net_lh_enable_state_t NetLighthouseStrobe::getSingleStrobeState ( unsigned int  deviceID,
int %  errorCode 
)
virtual

.getSingleStrobeState Determine if single strobe is enabled or disabled on the device.

See also
setSingleStrobeState()
Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
state "on" if single strobe is enabled, "off" if single strobe is disabled or on error.

◆ getSingleStrobeWidth()

lh_microseconds_t NetLighthouseStrobe::getSingleStrobeWidth ( unsigned int  deviceID,
int %  errorCode 
)
virtual

.getSingleStrobeWidth Get the single strobe width in microseconds.

See also
setSingleStrobeWidth()
Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the current single strobe width in microseconds or 0 on error.

◆ getSingleStrobeWidthIncrement()

lh_microseconds_t NetLighthouseStrobe::getSingleStrobeWidthIncrement ( unsigned int  deviceID,
int %  errorCode 
)
virtual

.getSingleStrobeWidthIncrement Return the single strobe width increment in microseconds. The increment is the minimum value between two adjacent (valid) single strobe width values.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the single strobe width increment in microseconds or 0 on error.

◆ getSingleStrobeWidthMaximum()

lh_microseconds_t NetLighthouseStrobe::getSingleStrobeWidthMaximum ( unsigned int  deviceID,
int %  errorCode 
)
virtual

.getSingleStrobeWidthMaximum Get the maximum single strobe width in microseconds.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the maximum single strobe width in microseconds or 0 on error.

◆ getSingleStrobeWidthMinimum()

lh_microseconds_t NetLighthouseStrobe::getSingleStrobeWidthMinimum ( unsigned int  deviceID,
int %  errorCode 
)
virtual

.getSingleStrobeWidthMinimum Get the minimum single strobe width in microseconds.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the minimum single strobe width in microseconds or 0 on error.

◆ setContinuousStrobePeriod()

void NetLighthouseStrobe::setContinuousStrobePeriod ( unsigned int  deviceID,
int%  errorCode,
lh_microseconds_t  microseconds 
)
virtual

.setContinuousStrobePeriod Set the continuous strobe period in microseconds.

See also
getContinuousStrobePeriod
Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
microsecondsthe desired continuous strobe period in microseconds.

◆ setContinuousStrobeState()

void NetLighthouseStrobe::setContinuousStrobeState ( unsigned int  deviceID,
int %  errorCode,
net_lh_enable_state_t  state 
)
virtual

.setContinuousStrobeState Enable or disable continuous strobe on the device.

See also
getContinuousStrobeState()
Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
state"on" to enable continuous strobe, "off" to disable continuous strobe.

◆ setSingleStrobeDelay()

void NetLighthouseStrobe::setSingleStrobeDelay ( unsigned int  deviceID,
int %  errorCode,
lh_microseconds_t  microseconds 
)
virtual

.setSingleStrobeDelay Set the single strobe delay in microseconds.

See also
getSingleStrobeDelay()
Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
microsecondsthe desired single strobe delay in microseconds.

◆ setSingleStrobeState()

void NetLighthouseStrobe::setSingleStrobeState ( unsigned int  deviceID,
int %  errorCode,
net_lh_enable_state_t  state 
)
virtual

.setSingleStrobeState Enable or disable single strobe on the device.

See also
getSingleStrobeState()
Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
state"on" to enable single strobe, "off" to disable single strobe.

◆ setSingleStrobeWidth()

void NetLighthouseStrobe::setSingleStrobeWidth ( unsigned int  deviceID,
int %  errorCode,
lh_microseconds_t  microseconds 
)
virtual

.setSingleStrobeWidth Set the single strobe width in microseconds.

See also
getSingleStrobeWidth()
Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
microsecondsthe desired single strobe width in microseconds.

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