winIDEA SDK
Loading...
Searching...
No Matches
isys::CHILChannel Class Reference

This immutable class contains information about HIL channel parameter. More...

#include <CHILController.h>

Public Member Functions

 CHILChannel ()
 CHILChannel (const std::string &name, DWORD dwType, DWORD dwIndex, DWORD dwFlags)
 Instantiates object.
double getAMax ()
 Returns the minimum value an analog channel can assume.
double getAMin ()
 Returns the minimum value an analog channel can assume.
DWORD getIndex ()
 Returns the index of the channel within its type group.
std::string getName ()
 Returns channel name.
std::string getQualifiedName ()
 Returns channel qualified name.
DWORD getType ()
 Returns the type of the channel.
std::string getUnit ()
 Returns the units measured by an analog channel.
bool isAvailable ()
 Returns true if the channel is avaialble - on the hardware module and not explicitly disabled.

Detailed Description

This immutable class contains information about HIL channel parameter.

Constructor & Destructor Documentation

◆ CHILChannel() [1/2]

isys::CHILChannel::CHILChannel ( )
Since
9.12.288

◆ CHILChannel() [2/2]

isys::CHILChannel::CHILChannel ( const std::string & name,
DWORD dwType,
DWORD dwIndex,
DWORD dwFlags )

Instantiates object.

Constructor is not intended to be used by clients.

Since
9.12.288

Member Function Documentation

◆ getAMax()

double isys::CHILChannel::getAMax ( )
inline

Returns the minimum value an analog channel can assume.

Since
9.12.288

◆ getAMin()

double isys::CHILChannel::getAMin ( )
inline

Returns the minimum value an analog channel can assume.

Since
9.12.288

◆ getIndex()

DWORD isys::CHILChannel::getIndex ( )
inline

Returns the index of the channel within its type group.

Since
9.12.288

◆ getName()

std::string isys::CHILChannel::getName ( )
inline

Returns channel name.

Since
9.12.288

◆ getQualifiedName()

std::string isys::CHILChannel::getQualifiedName ( )
inline

Returns channel qualified name.

Since
9.12.288

◆ getType()

DWORD isys::CHILChannel::getType ( )
inline

Returns the type of the channel.

IHILChannel::mc_cit encoding is used

Since
9.12.288

◆ getUnit()

std::string isys::CHILChannel::getUnit ( )
inline

Returns the units measured by an analog channel.

Since
9.12.288

◆ isAvailable()

bool isys::CHILChannel::isAvailable ( )
inline

Returns true if the channel is avaialble - on the hardware module and not explicitly disabled.

Since
9.12.288