CFI::Value Struct Reference

Describes single value of single character of CFI code as defined in the ISO 10962 standard. More...

#include <CFI.hpp>

Inheritance diagram for CFI::Value:

Public Types
using	Ptr = std::shared_ptr<Value>
	The alias to a type of shared pointer to the Value object.
using	Unique = std::unique_ptr<Value>
	The alias to a type of unique pointer to the Value object.
Public Types inherited from SharedEntity
using	Ptr = std::shared_ptr<SharedEntity>
	The alias to a type of shared pointer to the SharedEntity object.

Public Member Functions
Attribute::Ptr	getAttribute () const
	Returns an attribute that contains this value.
std::int16_t	getCode () const
	Returns single UTF16 character code of this value.
char	getCodeChar () const
	Returns single ASCII character code of this value.
std::string	getName () const
	Returns a short name of this value.
std::string	getDescription () const
	Returns description of this value.
bool	operator== (const Value &other) const
	Returns true if this object is equal to other object.
bool	operator== (const Value::Ptr &other) const
	Returns true if this object is equal to other object.
std::size_t	hashCode () const noexcept
std::string	toString () const override
	Returns a string representation of the current object.
Public Member Functions inherited from SharedEntity
template<typename T>
bool	is () const noexcept
	Checks that the pointer to the current type could be converted to type T* In other words: whether type T belongs to the type hierarchy in which the current type resides.
template<typename T>
std::shared_ptr< T >	sharedAs () noexcept
	Returns a pointer to the current object wrapped in a smart pointer to type T.
template<typename T>
std::shared_ptr< T >	sharedAs () const noexcept
	Returns a pointer to the current object wrapped in a smart pointer to type T.
Public Member Functions inherited from Entity
virtual	~Entity () noexcept=default
	The default virtual d-tor.

Additional Inherited Members
Static Public Member Functions inherited from RequireMakeShared< Value >
static auto	createShared (Args &&...args)
	Creates a smart pointer to an object.

Detailed Description

Describes single value of single character of CFI code as defined in the ISO 10962 standard.

Member Function Documentation

getAttribute()

CFI::Attribute::Ptr CFI::Value::getAttribute

(

)

const

Returns an attribute that contains this value.

Returns

The attribute.

getCode()

std::int16_t CFI::Value::getCode

(

)

const

Returns single UTF16 character code of this value.

Returns

UTF16 character code.

Referenced by getCodeChar().

getCodeChar()

char CFI::Value::getCodeChar

(

)

const

Returns single ASCII character code of this value.

Returns

ASCII character code.

References getCode().

getDescription()

std::string CFI::Value::getDescription

(

)

const

Returns description of this value.

Returns

The description.

getName()

std::string CFI::Value::getName

(

)

const

Returns a short name of this value.

Returns

The short name.

hashCode()

std::size_t CFI::Value::hashCode ( ) const

noexcept

Returns

A hash code value for this object.

operator==() [1/2]

bool CFI::Value::operator==

(

const Value &

other

)

const

Returns true if this object is equal to other object.

Parameters

other

Another object

Returns

true if this object is equal to other object

operator==() [2/2]

bool CFI::Value::operator== ( const Value::Ptr & other ) const

inline

Returns true if this object is equal to other object.

Parameters

other

Another object

Returns

true if this object is equal to other object

toString()

std::string CFI::Value::toString ( ) const

overridevirtual

Returns a string representation of the current object.

Returns

A string representation

Reimplemented from SharedEntity.