gem::SocialReportsOverlayCategory Class Reference

SocialReportsOverlayCategory object. More...

Inheritance diagram for gem::SocialReportsOverlayCategory:

Collaboration diagram for gem::SocialReportsOverlayCategory:

Public Member Functions
	SocialReportsOverlayCategory (const SocialReportsOverlayCategory &social)=default
	Default copy constructor.
	SocialReportsOverlayCategory (SocialReportsOverlayCategory &&social)=default
	Default move constructor noexcept is deduced.
SocialReportsOverlayCategory &	operator= (const SocialReportsOverlayCategory &social)=default
	Default copy assignment.
SocialReportsOverlayCategory &	operator= (SocialReportsOverlayCategory &&social)=default
	Default move assignment noexcept is deduced.
bool	operator== (const SocialReportsOverlayCategory &categ)
	Comparison operator equal.
bool	operator!= (const SocialReportsOverlayCategory &categ)
	Comparison operator not equal.
SearchableParameterList	getParameters () const noexcept
	Get report category parameters.
const StringRef	getCountry () const noexcept
	Get category ISO 3166-1 alpha-3 country code representation.
SocialReportsOverlayCategoryList	getSubcategories () const noexcept
	Get subcategories.
bool	operator== (const OverlayCategory &categ)
	Comparison operator equal.
bool	operator!= (const OverlayCategory &categ)
	Comparison operator not equal.
int	getUid () const noexcept
	Get the unique ID of the category within the overlay.
int	getOverlayUid () const noexcept
	Get the parent overlay uid.
const StringRef	getName () const noexcept
	Get the category name.
const ImageRef	getImage () const noexcept
	Get the category image.
bool	hasSubcategories () const noexcept
	Check if category has subcategories.

Detailed Description

SocialReportsOverlayCategory object.

Implements share-read / copy-on-write Api object over ISocialReportsOverlayCategory.

Constructor & Destructor Documentation

SocialReportsOverlayCategory() [1/2]

gem::SocialReportsOverlayCategory::SocialReportsOverlayCategory ( const SocialReportsOverlayCategory & social )

default

Default copy constructor.

Parameters

[in]

social

The object to copy

SocialReportsOverlayCategory() [2/2]

gem::SocialReportsOverlayCategory::SocialReportsOverlayCategory ( SocialReportsOverlayCategory && social )

default

Default move constructor noexcept is deduced.

Parameters

[in]

social

The object to move

Member Function Documentation

getCountry()

const StringRef gem::SocialReportsOverlayCategory::getCountry ( ) const

inlinenoexcept

Get category ISO 3166-1 alpha-3 country code representation.

Return default empty string for generic country

Returns

The country code

getImage()

const ImageRef gem::OverlayCategory::getImage ( ) const

inlinenoexceptinherited

Get the category image.

Returns

The category image

getName()

const StringRef gem::OverlayCategory::getName ( ) const

inlinenoexceptinherited

Get the category name.

Returns

The category name

getOverlayUid()

int gem::OverlayCategory::getOverlayUid ( ) const

inlinenoexceptinherited

Get the parent overlay uid.

Returns

The parent overlay uid

getParameters()

SearchableParameterList gem::SocialReportsOverlayCategory::getParameters ( ) const

inlinenoexcept

Get report category parameters.

See kReportCateg_ list for details

Returns

The report category parameters

getSubcategories()

SocialReportsOverlayCategoryList gem::SocialReportsOverlayCategory::getSubcategories ( ) const

inlinenoexcept

Get subcategories.

Returns

The subcategories list

getUid()

int gem::OverlayCategory::getUid ( ) const

inlinenoexceptinherited

Get the unique ID of the category within the overlay.

Returns

The category ID

hasSubcategories()

bool gem::OverlayCategory::hasSubcategories ( ) const

inlinenoexceptinherited

Check if category has subcategories.

Returns

True if category has subcategories, false otherwise

operator!=() [1/2]

bool gem::OverlayCategory::operator!= ( const OverlayCategory & categ )

inlineinherited

Comparison operator not equal.

Parameters

categ

The OverlayCategory object to compare

Returns

True if the objects are not equal, false otherwise

operator!=() [2/2]

bool gem::SocialReportsOverlayCategory::operator!= ( const SocialReportsOverlayCategory & categ )

inline

Comparison operator not equal.

Parameters

[in]

categ

The object to compare

Returns

true if the objects are not equal

operator=() [1/2]

SocialReportsOverlayCategory & gem::SocialReportsOverlayCategory::operator= ( const SocialReportsOverlayCategory & social )

default

Default copy assignment.

Parameters

[in]

social

The object to copy

Returns

The copied object

operator=() [2/2]

SocialReportsOverlayCategory & gem::SocialReportsOverlayCategory::operator= ( SocialReportsOverlayCategory && social )

default

Default move assignment noexcept is deduced.

Parameters

[in]

social

The object to move

Returns

The moved object

operator==() [1/2]

bool gem::OverlayCategory::operator== ( const OverlayCategory & categ )

inlineinherited

Comparison operator equal.

Parameters

categ

The OverlayCategory object to compare

Returns

True if the objects are equal, false otherwise

operator==() [2/2]

bool gem::SocialReportsOverlayCategory::operator== ( const SocialReportsOverlayCategory & categ )

inline

Comparison operator equal.

Parameters

[in]

categ

The object to compare

Returns

true if the objects are equal