Contains information and methods for working with DCS devices.
More...
#include <DCS100.h>
Contains information and methods for working with DCS devices.
◆ DCS_100() [1/2]
AdvancedIllumination::DCS_100::DCS_100 |
( |
| ) |
|
◆ DCS_100() [2/2]
AdvancedIllumination::DCS_100::DCS_100 |
( |
const char * |
device | ) |
|
Creates an instance and connects to the given device.
- Parameters
-
◆ ~DCS_100()
AdvancedIllumination::DCS_100::~DCS_100 |
( |
| ) |
|
◆ Channel()
Gets a channel by its number.
This is the one-based (1-3) complement of the array index operator, which is zero-based.
- Exceptions
-
- Parameters
-
i | One-based index of the channel. |
- Returns
- A reference to a DCS_100::DCS_Channel: the channel.
◆ ChannelCount()
size_t AdvancedIllumination::DCS_100::ChannelCount |
( |
| ) |
const |
Gets the channel count of the device.
- Returns
- The number of active channels in the device.
◆ connect()
void AdvancedIllumination::DCS_100::connect |
( |
const std::string & |
ip | ) |
|
Connects to a DCS at the given IP address.
- Parameters
-
ip | The IP address of the device to connect to |
◆ disconnect()
void AdvancedIllumination::DCS_100::disconnect |
( |
| ) |
|
Disconnects this object from the physical DCS.
Allows the DCS to communicate with other SDK or software instances.
◆ firmwareVersion()
const string & AdvancedIllumination::DCS_100::firmwareVersion |
( |
| ) |
const |
Gets the firmware version.
- Returns
- A reference to a const string.
◆ ipAddress() [1/2]
const string & AdvancedIllumination::DCS_100::ipAddress |
( |
| ) |
const |
Get the IP address.
- Returns
- The device IP address
◆ ipAddress() [2/2]
void AdvancedIllumination::DCS_100::ipAddress |
( |
const std::string & |
ip | ) |
|
Sets the device (static) IP address.
- Exceptions
-
- Parameters
-
ip | The IP address to set (as a string). |
◆ name() [1/2]
const string & AdvancedIllumination::DCS_100::name |
( |
| ) |
const |
Gets the name.
- Returns
- The device name.
◆ name() [2/2]
void AdvancedIllumination::DCS_100::name |
( |
const std::string & |
name | ) |
|
Sets the name of the device.
- Exceptions
-
- Parameters
-
name | The name to set. Cannot contain commas. |
◆ operator[]()
Array indexer operator.
Provides access to the channels of the DCS.
- Exceptions
-
- Parameters
-
i | Zero-based index of the channel to access. |
- Returns
- The indexed channel.
◆ profileName() [1/2]
const string & AdvancedIllumination::DCS_100::profileName |
( |
| ) |
const |
Gets the active profile name.
- Returns
- A reference to a const string.
◆ profileName() [2/2]
void AdvancedIllumination::DCS_100::profileName |
( |
const std::string & |
name | ) |
|
Sets the name of the active profile.
- Exceptions
-
DeviceWarning | Thrown when a device warning error condition occurs. |
DeviceError | Raised when a device error condition occurs. |
- Parameters
-
◆ profileNames()
const std::vector< std::string > & AdvancedIllumination::DCS_100::profileNames |
( |
| ) |
const |
Gets the names of the saved profiles.
- Returns
- A reference to a const std::vector of strings containing the profile names.
◆ profileNumber() [1/2]
int AdvancedIllumination::DCS_100::profileNumber |
( |
| ) |
const |
|
noexcept |
Gets the active profile number.
- Returns
- A const int.
◆ profileNumber() [2/2]
void AdvancedIllumination::DCS_100::profileNumber |
( |
int |
num | ) |
|
Sets the active profile number.
- Parameters
-
num | The profile number (0-24) to set. |
◆ refreshConfig()
void AdvancedIllumination::DCS_100::refreshConfig |
( |
| ) |
|
Refresh configuration from device.
◆ refreshProfiles()
void AdvancedIllumination::DCS_100::refreshProfiles |
( |
| ) |
|
Refresh profile names from device.
◆ saveProfile()
void AdvancedIllumination::DCS_100::saveProfile |
( |
| ) |
|
◆ webConfigEnabled() [1/2]
bool AdvancedIllumination::DCS_100::webConfigEnabled |
( |
| ) |
const |
Determine if the Web configuration interface is enabled.
- Returns
- A const bool,
true
for enabled and false
for disabled.
◆ webConfigEnabled() [2/2]
void AdvancedIllumination::DCS_100::webConfigEnabled |
( |
const bool |
b | ) |
|
Enable or disable the Web configuration interface.
- Parameters
-
b | true for enabled, false for disabled. |
◆ DCS_Channel
The documentation for this class was generated from the following files: