rtctk::componentFramework::ServerAliasCache Class Reference

A utility class used to lookup the Server Alias for a given Data Point Path. More...

#include <rtctk/componentFramework/serverAliasCache.hpp>

Public Member Functions
void	Clear ()
	Clears the Cache.
void	AddServerAlias (const DataPointPath &path, const std::string &alias)
	Adds a new entry into the Cache.
std::string	GetServerAlias (const DataPointPath &path)
	Get Server Alias for a specific datapoint.

Detailed Description

A utility class used to lookup the Server Alias for a given Data Point Path.

Member Function Documentation

AddServerAlias()

void rtctk::componentFramework::ServerAliasCache::AddServerAlias ( const DataPointPath & path, const std::string & alias )

inline

Adds a new entry into the Cache.

Parameters

[in]	path	Path of the DataPoint.
[in]	alias	Server Alias as a string

Clear()

void rtctk::componentFramework::ServerAliasCache::Clear ( )

inline

Clears the Cache.

GetServerAlias()

std::string rtctk::componentFramework::ServerAliasCache::GetServerAlias ( const DataPointPath & path )

inline

Get Server Alias for a specific datapoint.

Parameters

[in]

path

Path of the DataPoint.

Returns

the found server alias as a string, if none is found an empty string is returned

---

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

• componentFramework/services/populateConfig/src/include/rtctk/componentFramework/serverAliasCache.hpp