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

Contains information and methods for working with DCS devices. More...

#include <DCS100.h>

Classes

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

Public Member Functions

DCS_ChannelChannel (size_t)
 Gets a channel by its number. More...
 
DCS_Channeloperator[] (size_t)
 Array indexer operator. More...
 
const std::string & name () const
 Gets the name. More...
 
void name (const std::string &name)
 Sets the name of the device. More...
 
const std::string & firmwareVersion () const
 Gets the firmware version. More...
 
const std::string & ipAddress () const
 Get the IP address. More...
 
void ipAddress (const std::string &ip)
 Sets the device (static) IP address. More...
 
size_t ChannelCount () const
 Gets the channel count of the device. More...
 
const std::string & profileName () const
 Gets the active profile name. More...
 
int profileNumber () const noexcept
 Gets the active profile number. More...
 
void profileName (const std::string &)
 Sets the name of the active profile. More...
 
void profileNumber (int)
 Sets the active profile number. More...
 
void webConfigEnabled (const bool)
 Enable or disable the Web configuration interface. More...
 
bool webConfigEnabled () const
 Determine if the Web configuration interface is enabled. More...
 
void saveProfile ()
 Saves the profile. More...
 
 DCS_100 ()
 Default constructor. More...
 
 DCS_100 (const char *ip)
 Creates an instance and connects to the given device. More...
 
void connect (const std::string &ip)
 Connects to a DCS at the given IP address. More...
 
void disconnect ()
 Disconnects this object from the physical DCS. More...
 
void refreshConfig ()
 Refresh configuration from device. More...
 
const std::vector< std::string > & profileNames () const
 Gets the names of the saved profiles. More...
 
 ~DCS_100 ()
 Destructor. More...
 
void refreshProfiles ()
 Refresh profile names from device. More...
 

Friends

class DCS_Channel
 

Detailed Description

Contains information and methods for working with DCS devices.


Constructor & Destructor Documentation

◆ DCS_100() [1/2]

AdvancedIllumination::DCS_100::DCS_100 ( )

Default constructor.

◆ DCS_100() [2/2]

AdvancedIllumination::DCS_100::DCS_100 ( const char *  device)

Creates an instance and connects to the given device.

Parameters
deviceThe device.

◆ ~DCS_100()

AdvancedIllumination::DCS_100::~DCS_100 ( )

Destructor.

Member Function Documentation

◆ Channel()

DCS_100::DCS_Channel & AdvancedIllumination::DCS_100::Channel ( size_t  i)

Gets a channel by its number.

This is the one-based (1-3) complement of the array index operator, which is zero-based.

Exceptions
invalid_argumentThrown when i == 0 or i > 3 (if built with bounds checking) (Third-party reference)
Parameters
iOne-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
ipThe 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
invalid_argumentThrown when the IP address string is invalid. (Third-party reference)
DeviceWarningThrown when the device response contains a warning.
Parameters
ipThe 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
invalid_argumentThrown when the name string is invalid. (Third-party reference)
DeviceWarningThrown when the device issues a warning.
Parameters
nameThe name to set. Cannot contain commas.

◆ operator[]()

DCS_100::DCS_Channel & AdvancedIllumination::DCS_100::operator[] ( size_t  i)

Array indexer operator.

Provides access to the channels of the DCS.

Exceptions
invalid_argumentThrown when index > 2 (if built with bounds checking). (Third-party reference)
Parameters
iZero-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
DeviceWarningThrown when a device warning error condition occurs.
DeviceErrorRaised when a device error condition occurs.
Parameters
nameThe name.

◆ 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
numThe 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 ( )

Saves the profile.

◆ 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.
Remarks
If the web configuration interface is enabled, a web browser may be directed to the IP address of the device.

◆ webConfigEnabled() [2/2]

void AdvancedIllumination::DCS_100::webConfigEnabled ( const bool  b)

Enable or disable the Web configuration interface.

Parameters
btrue for enabled, false for disabled.

Friends And Related Function Documentation

◆ DCS_Channel

friend class DCS_Channel
friend

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