DCS_SDK  2.0.0
TCP/IP control library for Ai DCS-100E and DCS-103E
Public Member Functions | Friends | List of all members
AdvancedIllumination::DCS_100::DCS_Channel Class Reference

Encaspsulates the data related to a single DCS channel. More...

#include <DCS100.h>

Public Member Functions

double current () const
 Gets the current. More...
 
void current (const double)
 Sets the current. More...
 
double pulseWidth () const
 Gets the pulse width. More...
 
void pulseWidth (const double)
 Sets the pulse width. More...
 
double pulseDelay () const
 Gets the pulse delay. More...
 
void pulseDelay (const double)
 Sets the pulse delay. More...
 
double maxContinuous () const
 Gets the maximum continuous current (per string of LEDs). More...
 
const double maxStrobe () const
 Gets the maximum strobe current (per string of LEDs). More...
 
Mode mode () const
 Gets the mode the channel is in. More...
 
void mode (const Mode)
 Sets the channels' Mode. More...
 
Trigger triggerMode () const
 Gets the trigger mode (rising or falling edge). More...
 
void triggerMode (const Trigger)
 Sets the trigger mode. More...
 
Channel triggerInput () const
 Gets the configured trigger input channel. More...
 
void triggerInput (const Channel)
 Sets the trigger input (e.g. More...
 
double maxFrequency () const
 The maximum frequency (in Hertz) at which this channel can be triggered. More...
 
void trigger () const
 Triggers this channel (acts as if a single hardware trigger occured). More...
 

Friends

class DCS_100
 

Detailed Description

Encaspsulates the data related to a single DCS channel.

Allows getting and setting the device current, pulse width, etc.

Member Function Documentation

◆ current() [1/2]

double AdvancedIllumination::DCS_100::DCS_Channel::current ( ) const

Gets the current.

Returns
The current (in Amps).

◆ current() [2/2]

void AdvancedIllumination::DCS_100::DCS_Channel::current ( const double  cur)

Sets the current.

Exceptions
DeviceWarningThrown when a device warning error condition occurs.
DeviceErrorRaised when a Device error condition occurs.
runtime_errorRaised when a runtime error condition occurs. (Third-party reference)
Parameters
curThe current (in Amps).

◆ maxContinuous()

double AdvancedIllumination::DCS_100::DCS_Channel::maxContinuous ( ) const

Gets the maximum continuous current (per string of LEDs).

Returns
The maximum continuous current (per string), in Amps.

◆ maxFrequency()

double AdvancedIllumination::DCS_100::DCS_Channel::maxFrequency ( ) const

The maximum frequency (in Hertz) at which this channel can be triggered.

Returns
A const double; the maximum trigger frequency for this channel.

◆ maxStrobe()

const double AdvancedIllumination::DCS_100::DCS_Channel::maxStrobe ( ) const

Gets the maximum strobe current (per string of LEDs).

Returns
The maximum strobe current (per string), in Amps.

◆ mode() [1/2]

Mode AdvancedIllumination::DCS_100::DCS_Channel::mode ( ) const

Gets the mode the channel is in.


Returns
The channel's Mode.

◆ mode() [2/2]

void AdvancedIllumination::DCS_100::DCS_Channel::mode ( const  Mode)

Sets the channels' Mode.


Parameters
mThe Mode to set.

◆ pulseDelay() [1/2]

double AdvancedIllumination::DCS_100::DCS_Channel::pulseDelay ( ) const

Gets the pulse delay.

Returns
The pulse delay (in seconds).

◆ pulseDelay() [2/2]

void AdvancedIllumination::DCS_100::DCS_Channel::pulseDelay ( const double  pd)

Sets the pulse delay.

Exceptions
std::invalid_argumentThrown when pulse delay exceeds 10 milliseconds. (Third-party reference)
Parameters
pdThe pulse delay (in seconds).

◆ pulseWidth() [1/2]

double AdvancedIllumination::DCS_100::DCS_Channel::pulseWidth ( ) const

Gets the pulse width.

Returns
The pulse width (in seconds).

◆ pulseWidth() [2/2]

void AdvancedIllumination::DCS_100::DCS_Channel::pulseWidth ( const double  pw)

Sets the pulse width.

Must be less than or equal to 65535 microseconds (0.065535 seconds)

Exceptions
invalid_argumentThrown when pulse width exceeds 65535 microseconds. (Third-party reference)
runtime_errorRaised when a runtime error condition occurs. (Third-party reference)
Parameters
pwThe pulse width (in seconds).

◆ trigger()

void AdvancedIllumination::DCS_100::DCS_Channel::trigger ( ) const

Triggers this channel (acts as if a single hardware trigger occured).

◆ triggerInput() [1/2]

Channel AdvancedIllumination::DCS_100::DCS_Channel::triggerInput ( ) const

Gets the configured trigger input channel.

Returns
A const Channel.

◆ triggerInput() [2/2]

void AdvancedIllumination::DCS_100::DCS_Channel::triggerInput ( const  Channel)

Sets the trigger input (e.g.

which hardware trigger input this channel is bound to).

Remarks
This function sets which hardware trigger input this channel responds to on trigger events. Any combination of channels can be set to any trigger input, however each channel can only be assigned to one hardware input. That is, all three channels on a DCS-100E can share trigger input 1, but channel one can't be triggered on inputs 1 and 2, only input 1 or 2 (not both).
Parameters
chanThe channel to which this channel's trigger will be assigned.

◆ triggerMode() [1/2]

Trigger AdvancedIllumination::DCS_100::DCS_Channel::triggerMode ( ) const

Gets the trigger mode (rising or falling edge).

Returns
The channel's current trigger mode.

◆ triggerMode() [2/2]

void AdvancedIllumination::DCS_100::DCS_Channel::triggerMode ( const Trigger  t)

Sets the trigger mode.

Exceptions
DeviceWarningThrown when a device warning error condition occurs.
DeviceErrorRaised when a device error condition occurs.
Parameters
tThe trigger mode to set.

Friends And Related Function Documentation

◆ DCS_100

friend class DCS_100
friend

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