TimeBaseConfigurations Class Reference

#include <timebase_configs.h>

Static Public Member Functions
static const TimeBaseConfigurations &	getInstance ()
static const TimeBaseRecord &	getRecord (size_t timeBaseIndex)
static bool	isTimeBaseIndexPresent (size_t timeBaseIndex)
static bool	BaseNameToBaseIndex (const std::string &timeBaseName, size_t &timeBaseIndex)
static size_t	size ()
static iterator	begin ()
static iterator	end ()

Detailed Description

Class holding time base configurations

Member Function Documentation

BaseNameToBaseIndex()

static bool TimeBaseConfigurations::BaseNameToBaseIndex ( const std::string &  timeBaseName, size_t &  timeBaseIndex  )

static

find index of the time base using its name.

Parameters

[in]	timeBaseName	The time base name.
[out]	timeBaseIndex	The time base index.

Returns

true if found

begin()

static iterator TimeBaseConfigurations::begin ( )

static

Fetch iterator to the first record

Returns

iterator

Note

iterators are supported using C++ only

end()

static iterator TimeBaseConfigurations::end ( )

static

Fetch iterator that mark the end of the records list

Returns

iterator

Note

iterators are supported using C++ only

getInstance()

static const TimeBaseConfigurations & TimeBaseConfigurations::getInstance ( )

static

Get the single instance of the TimeBaseConfigurations.

Returns

Reference to the single instance.

getRecord()

static const TimeBaseRecord & TimeBaseConfigurations::getRecord ( size_t  timeBaseIndex )

static

Get record a given timeBaseIndex

Parameters

[in]

timeBaseIndex

The time base index to fetch.

Returns

empty record if not found.

isTimeBaseIndexPresent()

static bool TimeBaseConfigurations::isTimeBaseIndexPresent ( size_t  timeBaseIndex )

static

Check if a given timeBaseIndex exist

Parameters

[in]

timeBaseIndex

The time base index to check.

Returns

true if found, false otherwise.

size()

static size_t TimeBaseConfigurations::size ( )

static

Return number of time base configurations

Returns

size

---

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

• clkmgr/pub/clkmgr/timebase_configs.h