Image Component Library (ICL)
Public Member Functions | Public Attributes | List of all members
icl::io::DCDevice::Mode Struct Reference

Internally used Mode struct (combination of videomode and framerate) More...

#include <DCDevice.h>

Public Member Functions

 Mode (dc1394video_mode_t vm, dc1394framerate_t fr)
 creates a new Mode with given videomode and framerate More...
 
 Mode (const std::string &stringRepr)
 creates a new Mode by a given string representation More...
 
 Mode (dc1394camera_t *cam)
 create a new Mode by given cam More...
 
std::string toString () const
 returns a string representation of the mode More...
 
bool supportedBy (dc1394camera_t *cam) const
 returns whether the given camera supports this mode or not More...
 
bool operator== (const Mode &m) const
 compares to modes More...
 
bool operator!= (const Mode &m) const
 compares to modes [!= complies !(==)] More...
 

Public Attributes

dc1394video_mode_t videomode
 corresponding videomode More...
 
dc1394framerate_t framerate
 corresponding framerate; More...
 

Detailed Description

Internally used Mode struct (combination of videomode and framerate)

Constructor & Destructor Documentation

◆ Mode() [1/3]

icl::io::DCDevice::Mode::Mode ( dc1394video_mode_t  vm,
dc1394framerate_t  fr 
)
inline

creates a new Mode with given videomode and framerate

◆ Mode() [2/3]

icl::io::DCDevice::Mode::Mode ( const std::string &  stringRepr)

creates a new Mode by a given string representation

syntax: videomode@framerate

◆ Mode() [3/3]

icl::io::DCDevice::Mode::Mode ( dc1394camera_t *  cam)

create a new Mode by given cam

Member Function Documentation

◆ operator!=()

bool icl::io::DCDevice::Mode::operator!= ( const Mode m) const
inline

compares to modes [!= complies !(==)]

◆ operator==()

bool icl::io::DCDevice::Mode::operator== ( const Mode m) const
inline

compares to modes

◆ supportedBy()

bool icl::io::DCDevice::Mode::supportedBy ( dc1394camera_t *  cam) const

returns whether the given camera supports this mode or not

◆ toString()

std::string icl::io::DCDevice::Mode::toString ( ) const

returns a string representation of the mode

syntax: videomode@framerate

Member Data Documentation

◆ framerate

dc1394framerate_t icl::io::DCDevice::Mode::framerate

corresponding framerate;

◆ videomode

dc1394video_mode_t icl::io::DCDevice::Mode::videomode

corresponding videomode


The documentation for this struct was generated from the following file: