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

Class containing information about a DCS-100 device. More...

#include <DCS_Info.h>

Public Member Functions

 DCS_Info ()
 Default constructor. More...
 
 ~DCS_Info ()
 Destructor. More...
 
const std::string & name () const
 Gets the name of the device. More...
 
const std::string & lighthead () const
 Gets the part number of the connected lighthead. More...
 
const std::string & firmware () const
 Gets the firmware version. More...
 
const std::string & host () const
 Gets the host name (IP address) of the device. More...
 
DCS_Type type () const
 Gets the type of DCS. More...
 

Static Public Member Functions

static DCS_Info parse (const std::string &idn, std::string host)
 Parses the given IDN string. More...
 
static std::vector< DCS_InfofindAllInNetwork (bool global=false)
 Searches for all online DCS devices in the network. More...
 

Detailed Description

Class containing information about a DCS-100 device.

Constructor & Destructor Documentation

◆ DCS_Info()

AdvancedIllumination::DCS_Info::DCS_Info ( )

Default constructor.


◆ ~DCS_Info()

AdvancedIllumination::DCS_Info::~DCS_Info ( )

Destructor.


Member Function Documentation

◆ findAllInNetwork()

vector< DCS_Info > AdvancedIllumination::DCS_Info::findAllInNetwork ( bool  global = false)
static

Searches for all online DCS devices in the network.

Parameters
globalWhether to use a global broadcast (255.255.255.255) or subnet (X.X.X.255)
Returns
The found all in network.

◆ firmware()

const std::string & AdvancedIllumination::DCS_Info::firmware ( ) const

Gets the firmware version.

Returns
The device firmware version.

◆ host()

const std::string & AdvancedIllumination::DCS_Info::host ( ) const

Gets the host name (IP address) of the device.

Returns
A reference to a const std::string, the device IP address.

◆ lighthead()

const std::string & AdvancedIllumination::DCS_Info::lighthead ( ) const

Gets the part number of the connected lighthead.


Returns
A reference to a const std::string. Empty if there is no light connected.

◆ name()

const std::string & AdvancedIllumination::DCS_Info::name ( ) const

Gets the name of the device.

Returns
The device name.

◆ parse()

DCS_Info AdvancedIllumination::DCS_Info::parse ( const std::string &  idn,
std::string  host 
)
static

Parses the given IDN string.

Exceptions
invalid_argumentThrown when an invalid string is passed. (Third-party reference)
Parameters
idnThe IDN response string.
hostThe host (IP address).
Returns
A DCS_Info.

◆ type()

DCS_Type AdvancedIllumination::DCS_Info::type ( ) const

Gets the type of DCS.


Returns
A const DCS_Type.

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