Coral::FrameRateScalabilityInterface Class Reference

Frame Rate Scalability Interface. More...

#include <frameratescalabilityinterface.h>

Inheritance diagram for Coral::FrameRateScalabilityInterface:

List of all members.

Public Member Functions
virtual const char *	getFrameRateScalabilityClass () const =0
virtual bool	isFrameRateScalable () const =0
virtual double	getMinFrameRate () const =0
virtual double	getMaxFrameRate () const =0
virtual bool	isValidFrameRate (const double frameRate) const =0
virtual double	getNearestValidFrameRate (const double frameRate) const =0
virtual double	getNextFrameRateForRate (const double frameRate) const =0
virtual double	getPrevFrameRateForRate (const double frameRate) const =0
virtual double	getFrameRateScaleFactorForRate (const double frameRate) const =0
virtual double	getFrameRateUtilizationForRate (const double frameRate) const =0
virtual double	getFrameRateUtilizationWeight (const double frameRate) const =0

---

Detailed Description

Frame Rate Scalability Interface.

This class is an interface for frame rate scalability.

Author:

Thomas Dreibholz

Version:

1.0

---

Member Function Documentation

virtual const char* Coral::FrameRateScalabilityInterface::getFrameRateScalabilityClass

(

)

const [pure virtual]

Get name of the frame rate scalability class.

Returns:

Frame rate scalability class name.

Implemented in Coral::TraceQoSDescription, and Coral::TraceFrameRateScalability.

virtual double Coral::FrameRateScalabilityInterface::getFrameRateScaleFactorForRate

(

const double

frameRate

)

const [pure virtual]

Get scale factor for given frame rate: (rate - MinFrameRate) / (MaxFrameRate - MinFrameRate)

Parameters:

frameRate

Frame rate.

Returns:

Scale factor (out of [0,1])..

Implemented in Coral::TraceFrameRateScalability.

virtual double Coral::FrameRateScalabilityInterface::getFrameRateUtilizationForRate

(

const double

frameRate

)

const [pure virtual]

Get utilization for given frame rate.

Parameters:

frameRate

Frame rate.

Returns:

Utilization (out of [0,1]).

Implemented in Coral::TraceFrameRateScalability.

virtual double Coral::FrameRateScalabilityInterface::getFrameRateUtilizationWeight

(

const double

frameRate

)

const [pure virtual]

Get frame rate utilization weight.

Parameters:

frameRate

Frame rate.

Returns:

Utilization weight.

Implemented in Coral::TraceFrameRateScalability.

virtual double Coral::FrameRateScalabilityInterface::getMaxFrameRate

(

)

const [pure virtual]

Get maximum frame rate.

Returns:

Maximum frame rate.

Implemented in Coral::TraceFrameRateScalability.

virtual double Coral::FrameRateScalabilityInterface::getMinFrameRate

(

)

const [pure virtual]

Get minimum frame rate.

Returns:

Minimum frame rate.

Implemented in Coral::TraceFrameRateScalability.

virtual double Coral::FrameRateScalabilityInterface::getNearestValidFrameRate

(

const double

frameRate

)

const [pure virtual]

Get nearest lower valid frame rate for given frame rate.

Parameters:

rate	Frame rate.

Returns:

Valid frame rate nearest to given rate.

Implemented in Coral::TraceFrameRateScalability.

virtual double Coral::FrameRateScalabilityInterface::getNextFrameRateForRate

(

const double

frameRate

)

const [pure virtual]

Get next higher valid frame rate for given frame rate.

Parameters:

frameRate

Frame rate.

Returns:

Next higher valid frame rate.

Implemented in Coral::TraceFrameRateScalability.

virtual double Coral::FrameRateScalabilityInterface::getPrevFrameRateForRate

(

const double

frameRate

)

const [pure virtual]

Get next lower valid frame rate for given frame rate.

Parameters:

frameRate

Frame rate.

Returns:

Next lower valid frame rate.

Implemented in Coral::TraceFrameRateScalability.

virtual bool Coral::FrameRateScalabilityInterface::isFrameRateScalable

(

)

const [pure virtual]

Check, if frame rate is scalable.

Returns:

true, if frame rate is scalable; false otherwise.

Implemented in Coral::TraceFrameRateScalability.

virtual bool Coral::FrameRateScalabilityInterface::isValidFrameRate

(

const double

frameRate

)

const [pure virtual]

Check, if given frame rate is a valid value.

Parameters:

frameRate

Frame rate to be checked.

Returns:

true, if given rate is valid; false otherwise.

Implemented in Coral::TraceFrameRateScalability.

---

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

• frameratescalabilityinterface.h