xtd::enum_object< enum_t > Struct Template Reference

Inheritance diagram for xtd::enum_object< enum_t >:

Definition

template<typename enum_t = std::nullptr_t>
struct xtd::enum_object< enum_t >

Provides the base class for enumerations.

template<typename enum_t = std::nullptr_t>
struct enum_object : xtd::object, xtd::icomparable<enum_object<enum_t>>, xtd::iequatable<enum_object<enum_t>>, xtd::iformatable;

Inheritance

xtd::object → xtd::enum_object<enum_t>

Header

#include <xtd/enum_object>

Namespace

xtd

Library

xtd.core

Remarks

For more information about enumeration, see enum class guide.

For more information about types, see Native types, boxing and unboxing. The following code show how to use xtd::enum_object class for an enum.

#include <xtd/xtd>
 
enum_class_(, enum_test,
  value_one,
  value_two,
  value_three,
  value_four
);
 
auto main() -> int {
  console::write_line("name = {}", enum_test::value_four);
  console::write_line("value = {}", enum_object(enum_test::value_four).to_int32());
  console::write_line("as<int> = {}", as<int>(enum_test::value_four));
  console::write_line("values = {}", enum_object<>::get_values_as_int32<enum_test>());
  console::write_line("names = {}", enum_object<>::get_names<enum_test>());
  console::write_line("entries = {}", enum_object<>::get_entries_as_int32<enum_test>());
}
 
// This code produces the following output :
//
// name = value_four
// value = 3
// as<int> = 3
// values = [0, 1, 2, 3]
// names = [value_one, value_two, value_three, value_four]
// entries = [(0, value_one), (1, value_two), (2, value_three), (3, value_four)]

The following code show how to use xtd::enum_object class for an enum flags.

#include <xtd/xtd>
 
enum_class_(, text_attribute,
  normal = 0b0,
  bold = 0b1,
  italic = 0b10,
  underline = 0b100,
  strikeout = 0b1000
);
 
flags_attribute_(, text_attribute);
 
auto main() -> int {
  console::write_line("name = {}", text_attribute::bold | text_attribute::italic);
  console::write_line("value = {}", enum_object(text_attribute::bold | text_attribute::italic).to_int32());
  console::write_line("as<int> = {}", as<int>(text_attribute::bold | text_attribute::italic));
  console::write_line("values = {}", enum_object<>::get_values_as_int32<text_attribute>());
  console::write_line("names = {}", enum_object<>::get_names<text_attribute>());
  console::write_line("entries = {}", enum_object<>::get_entries_as_int32<text_attribute>());
}
 
// This code produces the following output :
//
// name = bold, italic
// value = 3
// as<int> = 3
// values = [0, 1, 2, 4, 8]
// names = [normal, bold, italic, underline, strikeout]
// entries = [(0, normal), (1, bold), (2, italic), (4, underline), (8, strikeout)]

Examples

culture_info_culture_types.cpp, and sizeof.cpp.

Public Aliases
using	enum_type
	Represents the enumeration type.
using	value_type
	Represents the enumeration type.

Public Properties
enum_type	value
	Gets or sets the value of the enum.
auto	has_flag (enum_type flag) const noexcept -> bool
	Retrieves an array of the values of the constants in a specified enumeration.

Public Constructors
	enum_object () noexcept=default
	Initializes a new instance of the xtd::enum_object class.
	enum_object (enum_type value)
	Initializes a new instance of the xtd::enum_object class with specified value.

Public Methods
auto	compare_to (const enum_object &value) const noexcept -> xtd::int32 override
	Compares the current instance with another object of the same type.
auto	equals (const object &obj) const noexcept -> bool override
	Determines whether the specified object is equal to the current object.
auto	equals (const enum_object &value) const noexcept -> bool override
	Determines whether the specified object is equal to the current object.
auto	equals (enum_type value) const noexcept -> bool
	Indicates whether the current object is equal to another object of the same type.
template<typename attribute_t>
auto	equals (attribute_t value) const noexcept -> bool
	Indicates whether the current object is equal to another object with defferent type.
auto	get_hash_code () const noexcept -> xtd::usize override
	Serves as a hash function for a particular type.
auto	to_byte () const noexcept -> xtd::byte
	Converts this instance to byte.
auto	to_int16 () const noexcept -> xtd::int16
	Converts this instance to int16.
auto	to_int32 () const noexcept -> xtd::int32
	Converts this instance to int32.
auto	to_int64 () const noexcept -> xtd::int64
	Converts this instance to int64.
auto	to_sbyte () const noexcept -> xtd::sbyte
	Converts this instance to signed byte.
auto	to_uint16 () const noexcept -> xtd::uint16
	Converts this instance to unsigned int16.
auto	to_uint32 () const noexcept -> xtd::uint32
	Converts this instance to unsigned int32.
auto	to_uint64 () const noexcept -> xtd::uint64
	Converts this instance to unsigned int64.
auto	to_string () const noexcept -> xtd::string override
	Returns a xtd::string that represents the current object.
auto	to_string (const xtd::string &format) const -> xtd::string
	Converts the value of this instance to its equivalent string representation using the specified format.
auto	to_string (const xtd::string &format, const globalization::culture_info &culture) const -> xtd::string override
	Converts the value of this instance to its equivalent string representation using the specified format, and locale.

Public Static Methods
static auto	parse (const xtd::string &str) -> enum_type
	Converts the string to its enum_type equivalent.

Additional Inherited Members
	object ()=default
	Create a new instance of the ultimate base class object.
virtual auto	get_type () const noexcept -> type_object
	Gets the type of the current instance.
template<typename object_t>
auto	memberwise_clone () const -> xtd::unique_ptr_object< object_t >
	Creates a shallow copy of the current object.
virtual auto	compare_to (const enum_object< std::nullptr_t > &obj) const noexcept -> xtd::int32=0
	Compares the current instance with another object of the same type.
virtual auto	equals (const enum_object< std::nullptr_t > &) const noexcept -> bool=0
	Indicates whether the current object is equal to another object of the same type.
template<typename object_a_t, typename object_b_t>
static auto	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept -> bool
	Determines whether the specified object instances are considered equal.
template<typename object_a_t, typename object_b_t>
static auto	reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept -> bool
	Determines whether the specified object instances are the same instance.

Member Typedef Documentation

enum_type

template<typename enum_t = std::nullptr_t>

using xtd::enum_object< enum_t >::enum_type

Represents the enumeration type.

value_type

template<typename enum_t = std::nullptr_t>

using xtd::enum_object< enum_t >::value_type

Represents the enumeration type.

Constructor & Destructor Documentation

enum_object() [1/2]

template<typename enum_t = std::nullptr_t>

xtd::enum_object< enum_t >::enum_object ( )

defaultnoexcept

Initializes a new instance of the xtd::enum_object class.

enum_object() [2/2]

template<typename enum_t = std::nullptr_t>

xtd::enum_object< enum_t >::enum_object ( enum_type value )

inlineexplicit

Initializes a new instance of the xtd::enum_object class with specified value.

Parameters

value

Value to set to this instance.

Member Function Documentation

has_flag()

template<typename enum_t = std::nullptr_t>

auto xtd::enum_object< enum_t >::has_flag ( enum_type flag ) const -> bool

inlinenodiscardnoexcept

Retrieves an array of the values of the constants in a specified enumeration.

Parameters

flag	An enumeration value.

Returns

true if the bit field or bit fields that are set in flag are also set in the current instance; otherwise, false.

Remarks

The has_flag method returns the result of the following bool expression : this_instance And flag = flag

Examples

culture_info_culture_types.cpp.

compare_to()

template<typename enum_t = std::nullptr_t>

auto xtd::enum_object< enum_t >::compare_to ( const enum_object< enum_t > & value ) const -> xtd::int32

inlinenodiscardoverridenoexcept

Compares the current instance with another object of the same type.

Parameters

value

An object to compare with this instance.

Returns

A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings:

Value	Condition
Less than zero	This instance is less than obj.
Zero	This instance is equal to obj.
Greater than zero	This instance is greater than obj.

equals() [1/4]

template<typename enum_t = std::nullptr_t>

auto xtd::enum_object< enum_t >::equals ( const object & obj ) const -> bool

inlinenodiscardoverridevirtualnoexcept

Determines whether the specified object is equal to the current object.

Parameters

obj	The object to compare with the current object.

Returns

true if the specified object is equal to the current object. otherwise, false.

Reimplemented from xtd::object.

equals() [2/4]

template<typename enum_t = std::nullptr_t>

auto xtd::enum_object< enum_t >::equals ( const enum_object< enum_t > & value ) const -> bool

inlinenodiscardoverridenoexcept

Determines whether the specified object is equal to the current object.

Parameters

obj	The object to compare with the current object.

Returns

true if the specified object is equal to the current object. otherwise, false.

equals() [3/4]

template<typename enum_t = std::nullptr_t>

auto xtd::enum_object< enum_t >::equals ( enum_type value ) const -> bool

inlinenodiscardnoexcept

Indicates whether the current object is equal to another object of the same type.

Parameters

obj	An object to compare with this object.

Returns

true if the current object is equal to the other parameter; otherwise, false.

equals() [4/4]

template<typename enum_t = std::nullptr_t>

template<typename attribute_t>

auto xtd::enum_object< enum_t >::equals ( attribute_t value ) const -> bool

inlinenodiscardnoexcept

Indicates whether the current object is equal to another object with defferent type.

Parameters

obj	An object to compare with this object.

Returns

Always return false.

get_hash_code()

template<typename enum_t = std::nullptr_t>

auto xtd::enum_object< enum_t >::get_hash_code ( ) const -> xtd::usize

inlinenodiscardoverridevirtualnoexcept

Serves as a hash function for a particular type.

Returns

A hash code for the current object.

Reimplemented from xtd::object.

to_byte()

template<typename enum_t = std::nullptr_t>

auto xtd::enum_object< enum_t >::to_byte ( ) const -> xtd::byte

inlinenodiscardnoexcept

Converts this instance to byte.

Returns

A new xtd::byte object converted from this instance.

to_int16()

template<typename enum_t = std::nullptr_t>

auto xtd::enum_object< enum_t >::to_int16 ( ) const -> xtd::int16

inlinenodiscardnoexcept

Converts this instance to int16.

Returns

A new to_int16 object converted from this instance.

to_int32()

template<typename enum_t = std::nullptr_t>

auto xtd::enum_object< enum_t >::to_int32 ( ) const -> xtd::int32

inlinenodiscardnoexcept

Converts this instance to int32.

Returns

A new to_int32 object converted from this instance.

to_int64()

template<typename enum_t = std::nullptr_t>

auto xtd::enum_object< enum_t >::to_int64 ( ) const -> xtd::int64

inlinenodiscardnoexcept

Converts this instance to int64.

Returns

A new to_int64 object converted from this instance.

to_sbyte()

template<typename enum_t = std::nullptr_t>

auto xtd::enum_object< enum_t >::to_sbyte ( ) const -> xtd::sbyte

inlinenodiscardnoexcept

Converts this instance to signed byte.

Returns

A new xtd::sbyte object converted from this instance.

to_uint16()

template<typename enum_t = std::nullptr_t>

auto xtd::enum_object< enum_t >::to_uint16 ( ) const -> xtd::uint16

inlinenodiscardnoexcept

Converts this instance to unsigned int16.

Returns

A new to_uint16 object converted from this instance.

to_uint32()

template<typename enum_t = std::nullptr_t>

auto xtd::enum_object< enum_t >::to_uint32 ( ) const -> xtd::uint32

inlinenodiscardnoexcept

Converts this instance to unsigned int32.

Returns

A new to_uint32 object converted from this instance.

to_uint64()

template<typename enum_t = std::nullptr_t>

auto xtd::enum_object< enum_t >::to_uint64 ( ) const -> xtd::uint64

inlinenodiscardnoexcept

Converts this instance to unsigned int64.

Returns

A new to_uint64 object converted from this instance.

to_string() [1/3]

template<typename enum_t = std::nullptr_t>

auto xtd::enum_object< enum_t >::to_string ( ) const -> xtd::string

inlinenodiscardoverridevirtualnoexcept

Returns a xtd::string that represents the current object.

Returns

A string that represents the current object.

Reimplemented from xtd::object.

to_string() [2/3]

template<typename enum_t = std::nullptr_t>

auto xtd::enum_object< enum_t >::to_string ( const xtd::string & format ) const -> xtd::string

inlinenodiscard

Converts the value of this instance to its equivalent string representation using the specified format.

Parameters

format

A format string.

Returns

The string representation of the value of this instance as specified by format.

Exceptions

xtd::format_exception

format contains an invalid specification.

Remarks

The format parameter can be one of the following format strings: "G" or "g", "D" or "d", "X" or "x", and "F" or "f" (the format string is not case-sensitive). If format is null or an empty string (""), the general format specifier ("G") is used. For more information about the enumeration format strings and formatting enumeration values, see Enumeration Format Strings. For more information about formatting in general, see Formatting Types.

Notes to caller

If multiple enumeration members have the same underlying value and you attempt to retrieve the string representation of an enumeration member's name based on its underlying value, your code should not make any assumptions about which name the method will return. For example, the following enumeration defines two members, shade::gray and shade::grey, that have the same underlying value.

enum shade {
  white = 0, gray = 1, grey = 1, black = 2
};

The following method call attempts to retrieve the name of a member of the shade enumeration whose underlying value is 1. The method can return either "gray" or "grey", and your code should not make any assumptions about which string will be returned.

string shade_name = enum_object<shade>(as<shade>(1)).to_string("F");

to_string() [3/3]

template<typename enum_t = std::nullptr_t>

auto xtd::enum_object< enum_t >::to_string ( const xtd::string & format, const globalization::culture_info & culture ) const -> xtd::string

nodiscardoverridevirtual

Converts the value of this instance to its equivalent string representation using the specified format, and locale.

Parameters

format	A format string.
culture	An xtd::globalization::culture_info object that contains culture information.

Returns

The string representation of the value of this instance as specified by format.

Exceptions

xtd::format_exception

format contains an invalid specification.

Remarks

The format parameter can be one of the following format strings: "G" or "g", "D" or "d", "X" or "x", and "F" or "f" (the format string is not case-sensitive). If format is null or an empty string (""), the general format specifier ("G") is used. For more information about the enumeration format strings and formatting enumeration values, see Enumeration Format Strings. For more information about formatting in general, see Formatting Types.

Notes to caller

If multiple enumeration members have the same underlying value and you attempt to retrieve the string representation of an enumeration member's name based on its underlying value, your code should not make any assumptions about which name the method will return. For example, the following enumeration defines two members, shade::gray and shade::grey, that have the same underlying value.

enum shade {
  white = 0, gray = 1, grey = 1, black = 2
};

The following method call attempts to retrieve the name of a member of the shade enumeration whose underlying value is 1. The method can return either "gray" or "grey", and your code should not make any assumptions about which string will be returned.

string shade_name = enum_object<shade>(as<shade>(1)).to_string("F");

Implements xtd::iformatable.

parse()

template<typename enum_t = std::nullptr_t>

auto xtd::enum_object< enum_t >::parse ( const xtd::string & str ) -> enum_type

inlinestaticnodiscard

Converts the string to its enum_type equivalent.

Parameters

value

A string containing a enum_type to convert.

Returns

A enum_type equivalent to the native value contained in value.

Member Data Documentation

value

template<typename enum_t = std::nullptr_t>

enum_type xtd::enum_object< enum_t >::value

Gets or sets the value of the enum.

Parameters

value

The value of the enum.

---

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

• xtd.core/include/xtd/enum_object.hpp