C++ API Reference
|
Input device channel. More...
#include <MDeviceChannel.h>
Public Member Functions | |
MDeviceChannel (const MString &, MDeviceChannel *=NULL, int=-1) | |
Constructor. More... | |
~MDeviceChannel () | |
Class destructor. | |
MString | name () const |
Return the short name of the channel. More... | |
MString | longName () const |
Return the long name of the channel. More... | |
int | axisIndex () const |
Returns the device state index corresponding to this device channel. More... | |
bool | hasChildren () const |
Determine whether this channel has children. More... | |
MDeviceChannel | parent () const |
Return the parent of this channel. More... | |
MDeviceChannel | childByIndex (int) |
Return the specified child of this channel. More... | |
int | numChildren () const |
Return the number of children of this channel. More... | |
MDeviceChannel | ( | const MString & | name, |
MDeviceChannel * | parent = NULL , |
||
int | index = -1 |
||
) |
Constructor.
Creates a new device channel with the given name, index and parent (optional).
[in] | name | the name of the channel |
[in] | parent | the parent of the channel (default is NULL) |
[in] | index | The device state index for the channel |
MString name | ( | ) | const |
Return the short name of the channel.
MString longName | ( | ) | const |
Return the long name of the channel.
int axisIndex | ( | ) | const |
Returns the device state index corresponding to this device channel.
bool hasChildren | ( | ) | const |
Determine whether this channel has children.
MDeviceChannel parent | ( | ) | const |
Return the parent of this channel.
MDeviceChannel childByIndex | ( | int | index | ) |
Return the specified child of this channel.
int numChildren | ( | ) | const |
Return the number of children of this channel.