PointInfo Class Reference
PointInfo is a group of ChannelInfo objects.
More...
#include <PointData.h>
List of all members.
Detailed Description
PointInfo is a group of ChannelInfo objects for specifying channels.
- See also:
- See examples/src/UserTutorial.cpp for examples on setting up and using PointInfo.
Definition at line 181 of file PointData.h.
Constructor & Destructor Documentation
PointInfo::~PointInfo |
( |
void |
|
) |
|
PointInfo::PointInfo |
( |
void |
|
) |
|
Member Function Documentation
ChannelInfo* PointInfo::getChannel |
( |
const char * |
name |
) |
|
This method returns the ChannelInfo for a given name.
- Parameters:
-
| name | the name of the wanted channel |
- Returns:
- the channel data for the given channel
const ChannelInfo* PointInfo::getChannel |
( |
const char * |
name |
) |
const |
This method returns the ChannelInfo for a given name.
- Parameters:
-
| name | the name of the wanted channel |
- Returns:
- the channel data for the given channel
This method returns the ChannelInfo for a given index.
- Parameters:
-
| idx | the index of the wanted channel |
- Returns:
- the channel info for the given channel
const ChannelInfo& PointInfo::getChannel |
( |
size_t |
idx |
) |
const |
This method returns the ChannelInfo for a given index.
- Parameters:
-
| idx | the index of the wanted channel |
- Returns:
- the channel info for the given channel
size_t PointInfo::getChannelIndex |
( |
const char * |
name |
) |
const |
This method returns index of the given channel name.
- Parameters:
-
| name | the name of the wanted channel |
- Returns:
- the index for the given channel
size_t PointInfo::getNumChannels |
( |
void |
|
) |
const |
This method returns the number of channels.
bool PointInfo::hasChannel |
( |
const char * |
name |
) |
const |
The method determines if this object has a channel with the given name.
- Parameters:
-
- Returns:
- true if the channel was found
bool PointInfo::hasValidXYZ |
( |
void |
|
) |
const |
This function checks the PointInfo object for X, Y, and Z channels and that their data type is DATATYPE_FLOAT64
void PointInfo::init |
( |
const PointData & |
pointData |
) |
|
void PointInfo::init |
( |
const PointInfo & |
pointInfo |
) |
|
void PointInfo::init |
( |
size_t |
numChannels |
) |
|
bool PointInfo::operator!= |
( |
const PointInfo & |
rhs |
) |
const [inline] |
bool PointInfo::operator== |
( |
const PointInfo & |
rhs |
) |
const |
Member Data Documentation
The documentation for this class was generated from the following file: