gem::SignpostItem Class Reference

SignpostItem object. More...

Inheritance diagram for gem::SignpostItem:

Collaboration diagram for gem::SignpostItem:

Public Member Functions
	SignpostItem (const SignpostItem &)=default
	Default copy constructor.
	SignpostItem (SignpostItem &&)=default
	Default move constructor noexcept is deduced.
SignpostItem &	operator= (const SignpostItem &item)=default
	Default copy assignment.
SignpostItem &	operator= (SignpostItem &&item)=default
	Default move assignment noexcept is deduced.
ESignpostItemType	getType () const noexcept
	Get the type.
const StringRef	getText () const noexcept
	Get the text.
const StringRef	getPhoneme () const noexcept
	Get the phoneme.
int	getRow () const noexcept
	Get the one based row.
int	getColumn () const noexcept
	Get the one based column.
bool	hasAmbiguity () const noexcept
	Get the ambiguity.
bool	hasSameShieldLevel () const noexcept
	Get the shield level.
ESignpostConnectionInfo	getConnectionInfo () const noexcept
	Get the connection.
ESignpostPictogramType	getPictogramType () const noexcept
	Gets the pictogram type for the item.
ERoadShieldType	getShieldType () const noexcept
	Get the shield type for the item.

Detailed Description

SignpostItem object.

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

Member Function Documentation

getColumn()

int gem::SignpostItem::getColumn ( ) const

inlinenoexcept

Get the one based column.

Not all items may have a column assigned.

Returns

Column of the item. Zero indicates N/A

getConnectionInfo()

ESignpostConnectionInfo gem::SignpostItem::getConnectionInfo ( ) const

inlinenoexcept

Get the connection.

Returns

Connection type of the item.

getPhoneme()

const StringRef gem::SignpostItem::getPhoneme ( ) const

inlinenoexcept

Get the phoneme.

Not all items may have phoneme assigned.

Returns

phoneme of the item.

getPictogramType()

ESignpostPictogramType gem::SignpostItem::getPictogramType ( ) const

inlinenoexcept

Gets the pictogram type for the item.

Only items with type ESignpostItemType::SI_Pictogram will return a valid value.

Returns

The pictogram type for the signpost.

getRow()

int gem::SignpostItem::getRow ( ) const

inlinenoexcept

Get the one based row.

Not all items may have a row assigned.

Returns

Row of the item. Zero indicates N/A

getShieldType()

ERoadShieldType gem::SignpostItem::getShieldType ( ) const

inlinenoexcept

Get the shield type for the item.

Only items with type ESignpostItemType::SI_RouteNumber will return a valid value.

Returns

The shield type for the signpost.

getText()

const StringRef gem::SignpostItem::getText ( ) const

inlinenoexcept

Get the text.

Not all items may have text assigned.

Returns

text of the item.

getType()

ESignpostItemType gem::SignpostItem::getType ( ) const

inlinenoexcept

Get the type.

Returns

type of the item.

hasAmbiguity()

bool gem::SignpostItem::hasAmbiguity ( ) const

inlinenoexcept

Get the ambiguity.

Returns

True for items with ambiguity. Don't use such items for TTS.

hasSameShieldLevel()

bool gem::SignpostItem::hasSameShieldLevel ( ) const

inlinenoexcept

Get the shield level.

Returns

True for road code items with same shield level as the road the signpost is attached to.

operator=() [1/2]

SignpostItem & gem::SignpostItem::operator= ( const SignpostItem & item )

default

Default copy assignment.

Parameters

item	The SignpostItem object to assign

Returns

The assigned SignpostItem object

operator=() [2/2]

SignpostItem & gem::SignpostItem::operator= ( SignpostItem && item )

default

Default move assignment noexcept is deduced.

Parameters

item	The SignpostItem object to assign

Returns

The assigned SignpostItem object