gem::OverlayInfo Class Reference

OverlayInfo object. More...

Inheritance diagram for gem::OverlayInfo:

Collaboration diagram for gem::OverlayInfo:

Public Member Functions
	OverlayInfo (const OverlayInfo &info)=delete
	Disable copy.
OverlayInfo &	operator= (OverlayInfo &info)=delete
	Disable copy assignment /.
	OverlayInfo (OverlayInfo &&info)=default
	Default move constructor noexcept is deduced.
OverlayInfo &	operator= (OverlayInfo &&info)=default
	Default move assignment noexcept is deduced.
int	getUid () const noexcept
	Get the unique ID of the overlay.
const StringRef	getName () const noexcept
	Get the name of the overlay.
const ImageRef	getImage () const noexcept
	Get the image of the overlay.
OverlayCategoryList	getCategories () const noexcept
	Get the overlay categories.
OverlayCategory	getCategory (int categId) const noexcept
	Get the overlay category by id.
bool	hasCategories (int categId) const noexcept
	Check if category has subcategories.

Detailed Description

OverlayInfo object.

Implements share-read / share-write Api object over IOverlayInfo.

Constructor & Destructor Documentation

OverlayInfo() [1/2]

gem::OverlayInfo::OverlayInfo ( const OverlayInfo & info )

delete

Disable copy.

Copy constructor and assignment operator are disabled

Parameters

info	The OverlayInfo object to copy

OverlayInfo() [2/2]

gem::OverlayInfo::OverlayInfo ( OverlayInfo && info )

default

Default move constructor noexcept is deduced.

Parameters

info	The OverlayInfo object to move

Member Function Documentation

getCategories()

OverlayCategoryList gem::OverlayInfo::getCategories ( ) const

inlinenoexcept

Get the overlay categories.

Returns

Empty if no categories are available

getCategory()

OverlayCategory gem::OverlayInfo::getCategory ( int categId ) const

inlinenoexcept

Get the overlay category by id.

Parameters

categId

The category id

Returns

Empty if no category is found

getImage()

const ImageRef gem::OverlayInfo::getImage ( ) const

inlinenoexcept

Get the image of the overlay.

Returns

empty if image is not available

getName()

const StringRef gem::OverlayInfo::getName ( ) const

inlinenoexcept

Get the name of the overlay.

Returns

The overlay name

getUid()

int gem::OverlayInfo::getUid ( ) const

inlinenoexcept

Get the unique ID of the overlay.

Returns

The overlay ID

hasCategories()

bool gem::OverlayInfo::hasCategories ( int categId ) const

inlinenoexcept

Check if category has subcategories.

Returns

True if category has subcategories, false otherwise

Parameters

categId

The category id

operator=() [1/2]

OverlayInfo & gem::OverlayInfo::operator= ( OverlayInfo && info )

default

Default move assignment noexcept is deduced.

Parameters

info	The OverlayInfo object to move

Returns

The moved OverlayInfo object

operator=() [2/2]

OverlayInfo & gem::OverlayInfo::operator= ( OverlayInfo & info )

delete

Disable copy assignment /.

Parameters

info	The OverlayInfo object to copy /

Returns

The copied OverlayInfo object