BPNGClientLib
Library for accessing the Telemotive data logger devices
Public Types | Public Member Functions | List of all members
TSLClusterImpl Class Reference

#include <TSLClusterImpl.hh>

Public Types

enum  ConnectionType {
  DOWNLOAD, CONVERSION, CONFIG, BUGREPORT,
  FW_UPDATE
}
 A enumaration of types of which task the connection will be used for. More...
 

Public Member Functions

 TSLClusterImpl ()
 Constructor.
 
 TSLClusterImpl (OnlineLoggerInfo firstDevice)
 
void addDevice (OnlineLoggerInfo device)
 
void deleteDevice (size_t index)
 
std::string getTSLName ()
 
void print ()
 Stream the TSLCluster to cout.
 
std::vector< OnlineLoggerInfo >::iterator begin ()
 
std::vector< OnlineLoggerInfo >::iterator end ()
 
TSLCluster getTSLCluster ()
 
size_t getTSLSize ()
 get size of TSL chain
 

Detailed Description

A simple class that represents a Telemotive System Link chain.

Member Enumeration Documentation

◆ ConnectionType

A enumaration of types of which task the connection will be used for.

Enumerator
DOWNLOAD 

Download tasks.

CONVERSION 

Conversion tasks.

CONFIG 

Configuration tasks.

BUGREPORT 

Create bug report.

FW_UPDATE 

make Firmware update

Constructor & Destructor Documentation

◆ TSLClusterImpl()

TSLClusterImpl::TSLClusterImpl ( OnlineLoggerInfo  firstDevice)
inline

Constructor

Parameters
firstDevicethe first device of the chain.

Member Function Documentation

◆ addDevice()

void TSLClusterImpl::addDevice ( OnlineLoggerInfo  device)
inline

Add a BPNGDevice to the TSLCluster.

Parameters
devicethe new device

◆ begin()

std::vector<OnlineLoggerInfo>::iterator TSLClusterImpl::begin ( )
inline

Begin iterator for ranged base for loop

Returns
the begin iterator of internal BPNGDevice vector.

◆ deleteDevice()

void TSLClusterImpl::deleteDevice ( size_t  index)
inline

Delete a BPNGDevice from the TSLCluster.

Parameters
indexindex of device to delete

◆ end()

std::vector<OnlineLoggerInfo>::iterator TSLClusterImpl::end ( )
inline

End iterator for ranged base for loop

Returns
the end iterator of internal BPNGDevice vector.

◆ getTSLName()

std::string TSLClusterImpl::getTSLName ( )
inline

Get the name of TSL chain. All devices in the chain have the same TSL name.

Returns
the TSL name.

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