Ocean::Media::FrameMedium::SortableFrameType Class Reference

Class allowing the sorting of several frame media types according their popularity. More...

#include <FrameMedium.h>

Inheritance diagram for Ocean::Media::FrameMedium::SortableFrameType:

Public Member Functions
	SortableFrameType (const MediaFrameType &frameType)
	Creates a new sortable frame media type.
	SortableFrameType (const unsigned int width, const unsigned int height, const FrameType::PixelFormat pixelFormat, const FrameType::PixelOrigin pixelOrigin, const FrameFrequency frequency)
	Creates a new sortable frame type.
bool	operator< (const SortableFrameType &right) const
	Returns whether the left sortable media type is more preferred than the right one.

Protected Attributes
MediaFrameType	actualFrameType_
	Actual frame type.
MediaFrameType	preferableFrameType_
	Preferable frame type.

Detailed Description

Class allowing the sorting of several frame media types according their popularity.

Constructor & Destructor Documentation

SortableFrameType() [1/2]

Ocean::Media::FrameMedium::SortableFrameType::SortableFrameType

(

const MediaFrameType &

frameType

)

Creates a new sortable frame media type.

Parameters

frameType

Preferable frame type

SortableFrameType() [2/2]

Ocean::Media::FrameMedium::SortableFrameType::SortableFrameType	(	const unsigned int	width,
		const unsigned int	height,
		const FrameType::PixelFormat	pixelFormat,
		const FrameType::PixelOrigin	pixelOrigin,
		const FrameFrequency	frequency
	)

Creates a new sortable frame type.

Parameters

width	Preferable reference width
height	Preferable reference height
pixelFormat	Preferable reference pixel format
pixelOrigin	Preferable reference pixel origin
frequency	Preferable reference frequency

Member Function Documentation

operator<()

bool Ocean::Media::FrameMedium::SortableFrameType::operator<

(

const SortableFrameType &

right

)

const

Returns whether the left sortable media type is more preferred than the right one.

Parameters

right

The right sortable media type

Returns

True, if so

Field Documentation

actualFrameType_

MediaFrameType Ocean::Media::FrameMedium::SortableFrameType::actualFrameType_

protected

Actual frame type.

preferableFrameType_

MediaFrameType Ocean::Media::FrameMedium::SortableFrameType::preferableFrameType_

protected

Preferable frame type.

---

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

• FrameMedium.h