xtd::enum_object< enum_t > Struct Template Reference

Inheritance diagram for xtd::enum_object< enum_t >:

Definition

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

Provides the base class for enumerations.

template<class 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/as>
#include <xtd/console>
#include <xtd/enum_class>
 
using namespace 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/as>
#include <xtd/console>
#include <xtd/enum_class>
 
using namespace 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

enum.cpp, enum_class.cpp, enum_class_flags.cpp, enum_class_flags_introspection.cpp, enum_class_flags_without_helpers.cpp, enum_class_ut.cpp, enum_class_without_helper.cpp, enum_struct.cpp, enum_struct_ut.cpp, enum_ut.cpp, form_background_image2.cpp, sprintf_enum.cpp, and sprintf_enum_class.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.
bool	has_flag (enum_type flag) const noexcept
	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
int32	compare_to (const enum_object &value) const noexcept override
	Compares the current instance with another object of the same type.
bool	equals (const object &obj) const noexcept override
	Determines whether the specified object is equal to the current object.
bool	equals (const enum_object &value) const noexcept override
	Determines whether the specified object is equal to the current object.
bool	equals (enum_type value) const noexcept
	Indicates whether the current object is equal to another object of the same type.
template<class attribute_t>
bool	equals (attribute_t value) const noexcept
	Indicates whether the current object is equal to another object with defferent type.
xtd::size	get_hash_code () const noexcept override
	Serves as a hash function for a particular type.
xtd::byte	to_byte () const noexcept
	Converts this instance to byte.
int16	to_int16 () const noexcept
	Converts this instance to int16.
int32	to_int32 () const noexcept
	Converts this instance to int32.
int64	to_int64 () const noexcept
	Converts this instance to int64.
sbyte	to_sbyte () const noexcept
	Converts this instance to signed byte.
uint16	to_uint16 () const noexcept
	Converts this instance to unsigned int16.
uint32	to_uint32 () const noexcept
	Converts this instance to unsigned int32.
uint64	to_uint64 () const noexcept
	Converts this instance to unsigned int64.
xtd::string	to_string () const noexcept override
	Returns a xtd::string that represents the current object.
xtd::string	to_string (const xtd::string &format) const
	Converts the value of this instance to its equivalent string representation using the specified format.
xtd::string	to_string (const xtd::string &format, const std::locale &loc) const override
	Converts the value of this instance to its equivalent string representation using the specified format, and locale.

Public Static Methods
Retrieves an array of the xtd::enum_collection<enum_t> of the constants in a specified enumeration. / / / / / Returns A xtd::string array of the values and names of the constants in enumType. template<class enum_t> static const xtd::enum_collection<enum_t>& get_entries() noexcept { return enum_object<enum_t>().entries(); } / Retrieves an array of the xtd::enum_collection<xtd::byte> of the constants in a specified enumeration. / Returns A xtd::string array of the values and names of the constants in enumType. template<class enum_t> static xtd::enum_collection<xtd::byte> get_entries_as_byte() noexcept { xtd::enum_collection<xtd::byte> entries; std::for_each(enum_object<enum_t>().entries().begin(), enum_object<enum_t>().entries().end(), [&](auto entry) {entries.emplace_back(enum_object<enum_t>(entry.first).to_byte(), entry.second);}); return entries; } / Retrieves an array of the xtd::enum_collection<int16> of the constants in a specified enumeration. / Returns A xtd::string array of the values and names of the constants in enumType. template<class enum_t> static xtd::enum_collection<int16> get_entries_as_int16() noexcept { xtd::enum_collection<int16> entries; std::for_each(enum_object<enum_t>().entries().begin(), enum_object<enum_t>().entries().end(), [&](auto entry) {entries.emplace_back(enum_object<enum_t>(entry.first).to_int16(), entry.second);}); return entries; } / Retrieves an array of the xtd::enum_collection<int32> of the constants in a specified enumeration. / Returns A xtd::string array of the values and names of the constants in enumType. template<class enum_t> static xtd::enum_collection<int32> get_entries_as_int32() noexcept { xtd::enum_collection<int32> entries; std::for_each(enum_object<enum_t>().entries().begin(), enum_object<enum_t>().entries().end(), [&](auto entry) {entries.emplace_back(enum_object<enum_t>(entry.first).to_int32(), entry.second);}); return entries; } / Retrieves an array of the xtd::enum_collection<int64> of the constants in a specified enumeration. / Returns A xtd::string array of the values and names of the constants in enumType. template<class enum_t> static xtd::enum_collection<int64> get_entries_as_int64() noexcept { xtd::enum_collection<int64> entries; std::for_each(enum_object<enum_t>().entries().begin(), enum_object<enum_t>().entries().end(), [&](auto entry) {entries.emplace_back(enum_object<enum_t>(entry.first).to_int64(), entry.second);}); return entries; } / Retrieves an array of the xtd::enum_collection<sbyte> of the constants in a specified enumeration. / Returns A xtd::string array of the values and names of the constants in enumType. template<class enum_t> static xtd::enum_collection<sbyte> get_entries_as_sbyte() noexcept { xtd::enum_collection<sbyte> entries; std::for_each(enum_object<enum_t>().entries().begin(), enum_object<enum_t>().entries().end(), [&](auto entry) {entries.emplace_back(enum_object<enum_t>(entry.first).to_sbyte(), entry.second);}); return entries; } / Retrieves an array of the xtd::enum_collection<uint16> of the constants in a specified enumeration. / Returns A xtd::string array of the values and names of the constants in enumType. template<class enum_t> static xtd::enum_collection<uint16> get_entries_as_uint16() noexcept { xtd::enum_collection<uint16> entries; std::for_each(enum_object<enum_t>().entries().begin(), enum_object<enum_t>().entries().end(), [&](auto entry) {entries.emplace_back(enum_object<enum_t>(entry.first).to_uint16(), entry.second);}); return entries; } / Retrieves an array of the xtd::enum_collection<uint32> of the constants in a specified enumeration. / Returns A xtd::string array of the values and names of the constants in enumType. template<class enum_t> static xtd::enum_collection<uint32> get_entries_as_uint32() noexcept { xtd::enum_collection<uint32> entries; std::for_each(enum_object<enum_t>().entries().begin(), enum_object<enum_t>().entries().end(), [&](auto entry) {entries.emplace_back(enum_object<enum_t>(entry.first).to_uint32(), entry.second);}); return entries; } / Retrieves an array of the xtd::enum_collection<uint64> of the constants in a specified enumeration. / Returns A xtd::string array of the values and names of the constants in enumType. template<class enum_t> static xtd::enum_collection<uint64> get_entries_as_uint64() noexcept { xtd::enum_collection<uint64> entries; std::for_each(enum_object<enum_t>().entries().begin(), enum_object<enum_t>().entries().end(), [&](auto entry) {entries.emplace_back(enum_object<enum_t>(entry.first).to_uint64(), entry.second);}); return entries; } / Retrieves the name of the constant in the specified enumeration that has the specified value. / Parameters value The value of a particular enumerated constant in terms of its underlying type. / Returns A xtd::string containing the name of the enumerated constant in enumType whose value is value; or the value int32 to xtd::string if no such constant is found. / Exceptions xtd::argument_exception The value is ! a value of enumType. template<class enum_t> static xtd::string get_name(enum_t value) noexcept {return enum_object<enum_t>(value).to_string();} / Retrieves the name of the constant in the specified enumeration that has the specified value. / Parameters value The value of a particular enumerated constant in terms of its underlying type. / Returns xtd::string A xtd::string containing the name of the enumerated constant in enumType whose value is value; or the value int32 to xtd::string if no such constant is found. / Exceptions xtd::argument_exception The value is ! a value of enumType. template<class enum_t> static xtd::string get_name(enum_object<enum_t> value) noexcept {return enum_object<enum_t>(value).to_string();} / Retrieves the name of the constant in the specified enumeration that has the specified value. / Parameters value The value of a particular enumerated constant in terms of its underlying type. / Returns xtd::string A xtd::string containing the name of the enumerated constant in enumType whose value is value; or the value int32 to xtd::string if no such constant is found. / Exceptions xtd::argument_exception The value is ! a value of enumType. template<class enum_t> static xtd::string get_name(int32 value) noexcept {return enum_object<enum_t>(value).to_string();} / Retrieves the name of the constant in the specified enumeration that has the specified value. / Parameters value The value of a particular enumerated constant in terms of its underlying type. / Returns A xtd::string containing the name of the enumerated constant in enumType whose value is value; or the value int32 to xtd::string if no such constant is found. / Exceptions xtd::argument_exception The value is ! a value of enumType. template<class enum_t> static xtd::string get_name(int64 value) noexcept {return enum_object<enum_t>(value).to_string();} / Retrieves an array of the names of the constants in a specified enumeration. / Returns A xtd::string array of the names of the constants in enumType. / Exceptions xtd::argument_exception The value is ! a value of enumType. template<class enum_t> static xtd::array<xtd::string> get_names() noexcept { auto names = xtd::array<xtd::string> {}; std::for_each(enum_object<enum_t>().entries().begin(), enum_object<enum_t>().entries().end(), [&](auto entry) {names.resize(names.size() + 1, entry.second);}); return names; } / Retrieves an array of the values of the constants in a specified enumeration. / Returns Array<enum_t> An array that contains the values of the constants in enumType. / Exceptions xtd::argument_exception The value is ! a value of enumType. template<class enum_t> static xtd::array<enum_t> get_values() noexcept { auto values = xtd::array<enum_t> {}; std::for_each(enum_object<enum_t>().entries().begin(), enum_object<enum_t>().entries().end(), [&](auto entry) {values.resize(values.size() + 1, entry.first);}); return values; } / Retrieves an array of the values of the constants in a specified enumeration. / Returns Array<xtd::byte> An array that contains the values of the constants in enumType. / Exceptions xtd::argument_exception The value is ! a value of enumType. template<class enum_t> static xtd::array<xtd::byte> get_values_as_byte() noexcept { auto values = xtd::array<xtd::byte> {}; std::for_each(enum_object<enum_t>().entries().begin(), enum_object<enum_t>().entries().end(), [&](auto entry) {values.resize(values.size() + 1, enum_object<enum_t>(entry.first).to_byte());}); return values; } / Retrieves an array of the values of the constants in a specified enumeration. / Returns Array<int16> An array that contains the values of the constants in enumType. / Exceptions xtd::argument_exception The value is ! a value of enumType. template<class enum_t> static xtd::array<int16> get_values_as_int16() noexcept { auto values = xtd::array<xtd::int16> {}; std::for_each(enum_object<enum_t>().entries().begin(), enum_object<enum_t>().entries().end(), [&](auto entry) {values.resize(values.size() + 1, enum_object<enum_t>(entry.first).to_int16());}); return values; } / Retrieves an array of the values of the constants in a specified enumeration. / Returns Array<int32> An array that contains the values of the constants in enumType. / Exceptions xtd::argument_exception The value is ! a value of enumType. template<class enum_t> static xtd::array<int32> get_values_as_int32() noexcept { auto values = xtd::array<xtd::int32> {}; std::for_each(enum_object<enum_t>().entries().begin(), enum_object<enum_t>().entries().end(), [&](auto entry) {values.resize(values.size() + 1, enum_object<enum_t>(entry.first).to_int32());}); return values; } / Retrieves an array of the values of the constants in a specified enumeration. / Returns Array<int64> An array that contains the values of the constants in enumType. / Exceptions xtd::argument_exception The value is ! a value of enumType. template<class enum_t> static xtd::array<int64> get_values_as_int64() noexcept { auto values = xtd::array<xtd::int64> {}; std::for_each(enum_object<enum_t>().entries().begin(), enum_object<enum_t>().entries().end(), [&](auto entry) {values.resize(values.size() + 1, enum_object<enum_t>(entry.first).to_int64());}); return values; } / Retrieves an array of the values of the constants in a specified enumeration. / Returns Array<sbyte> An array that contains the values of the constants in enumType. / Exceptions xtd::argument_exception The value is ! a value of enumType. template<class enum_t> static xtd::array<sbyte> get_values_as_sbyte() noexcept { auto values = xtd::array<xtd::sbyte> {}; std::for_each(enum_object<enum_t>().entries().begin(), enum_object<enum_t>().entries().end(), [&](auto entry) {values.resize(values.size() + 1, enum_object<enum_t>(entry.first).to_sbyte());}); return values; } / Retrieves an array of the values of the constants in a specified enumeration. / Returns Array<uint16> An array that contains the values of the constants in enumType. / Exceptions xtd::argument_exception The value is ! a value of enumType. template<class enum_t> static xtd::array<uint16> get_values_as_uint16() noexcept { auto values = xtd::array<xtd::uint16> {}; std::for_each(enum_object<enum_t>().entries().begin(), enum_object<enum_t>().entries().end(), [&](auto entry) {values.resize(values.size() + 1, enum_object<enum_t>(entry.first).to_uint16());}); return values; } / Retrieves an array of the values of the constants in a specified enumeration. / Returns Array<uint32> An array that contains the values of the constants in enumType. / Exceptions xtd::argument_exception The value is ! a value of enumType. template<class enum_t> static xtd::array<uint32> get_values_as_uint32() noexcept { auto values = xtd::array<xtd::uint32> {}; std::for_each(enum_object<enum_t>().entries().begin(), enum_object<enum_t>().entries().end(), [&](auto entry) {values.resize(values.size() + 1, enum_object<enum_t>(entry.first).to_uint32());}); return values; } / Retrieves an array of the values of the constants in a specified enumeration. / Returns Array<uint64> An array that contains the values of the constants in enumType. / Exceptions xtd::argument_exception The value is ! a value of enumType. template<class enum_t> static xtd::array<uint64> get_values_as_uint64() noexcept { auto values = xtd::array<xtd::uint64> {}; std::for_each(enum_object<enum_t>().entries().begin(), enum_object<enum_t>().entries().end(), [&](auto entry) {values.resize(values.size() + 1, enum_object<enum_t>(entry.first).to_uint64());}); return values; } / Returns an indication whether a constant with a specified value exists in a specified enumeration. / Parameters fromValue An enumeration value. / Returns true if a constant in enumType has a value equal to value; otherwise, false. / Exceptions xtd::argument_exception The value is ! a value of enumType. template<class enum_t> static bool is_defined(enum_t value) noexcept {return std::find_if(enum_object<enum_t>().entries().begin(), enum_object<enum_t>().entries().end(), [&](auto item)->bool {return item.first == value;}) != enum_object<enum_t>().entries().end();} / Returns an indication whether a constant with a specified value exists in a specified enumeration. / Parameters fromValue An enumeration value. / Returns true if a constant in enumType has a value equal to value; otherwise, false. / Exceptions xtd::argument_exception The value is ! a value of enumType. template<class enum_t> static bool is_defined(enum_object<enum_t> value) noexcept {return std::find_if(enum_object<enum_t>().entries().begin(), enum_object<enum_t>().entries().end(), [&](auto item)->bool {return item.first == value;}) != enum_object<enum_t>().entries().end();} / Converts the xtd::string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object. / Parameters value An A xtd::string containing the name or value to convert. / Returns enum_object An enum whose value is represented by value. / Exceptions xtd::argument_exception The value is ! a value of enumType. template<class enum_t> static enum_t parse(const xtd::string& value) {return parse<enum_t>(value, false);} / Converts the xtd::string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object. / Parameters str An A xtd::string containing the name or value to convert. / ignore_case true to Ignore case; false to regard case. / Returns enum_object An enum whose value is represented by value. / Exceptions xtd::argument_exception The value is ! a value of enumType. template<class enum_t> static enum_t parse(const xtd::string& str, bool ignore_case) { return enum_object<enum_t>::parse(str, ignore_case); } / Converts this instance to byte. / Returns A new xtd::byte object converted from this instance. / Parameters value The value to convert. template<class enum_t> static xtd::byte to_byte(enum_t value) noexcept {return enum_object<enum_t>(value).to_byte();} / Converts this instance to int16. / Parameters value The value to convert. / Returns A new to_int16 object converted from this instance. template<class enum_t> static int16 to_int16(enum_t value) noexcept {return enum_object<enum_t>(value).to_int16();} / Converts this instance to int32. / Parameters value The value to convert. / Returns A new to_int32 object converted from this instance. template<class enum_t> static int32 to_int32(enum_t value) noexcept {return enum_object<enum_t>(value).to_int32();} / Converts this instance to int64. / Parameters value The value to convert. / Returns A new to_int64 object converted from this instance. template<class enum_t> static int64 to_int64(enum_t value) noexcept {return enum_object<enum_t>(value).to_int64();} / Converts this instance to signed byte. / Parameters value The value to convert. / Returns A new sbyte object converted from this instance. template<class enum_t> static sbyte to_sbyte(enum_t value) noexcept {return enum_object<enum_t>(value).to_sbyte();} / Converts this instance to string. / Parameters value The value to convert. / Returns A new xtd::string converted from this instance. template<class enum_t> static xtd::string to_string(enum_t value) noexcept {return enum_object<enum_t>(value).to_string();} / Converts this instance to unsigned int16. / Parameters value The value to convert. / Returns A new to_uint16 object converted from this instance. template<class enum_t> static uint16 to_uint16(enum_t value) noexcept {return enum_object<enum_t>(value).to_uint16();} / Converts this instance to unsigned int32. / Parameters value The value to convert. / Returns A new to_uint32 object converted from this instance. template<class enum_t> static uint32 to_uint32(enum_t value) noexcept {return enum_object<enum_t>(value).to_uint32();} / Converts this instance to unsigned int64. / Parameters value The value to convert. / Returns A new to_uint64 object converted from this instance. template<class enum_t> static uint64 to_uint64(enum_t value) noexcept {return enum_object<enum_t>(value).to_uint64();} / Converts the xtd::string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object. The return value indicates whether the conversion succeeded. / Parameters vaue The xtd::string representation of the enumeration name or underlying value to convert. / reslt When this method returns, result contains an object of type TEnum whose value is represented by value if the parse operation succeeds. If the parse operation fails, result contains the default value of the underlying type of TEnum. Note that this value need ! be a member of the TEnum enumeration. This parameter is passed uninitialized. / Returns true if the value parameter was converted successfully; otherwise, false. template<class enum_t> static bool try_parse(const xtd::string& value, enum_t& result) noexcept {return try_parse<enum_t>(value, false, result);} / Converts the xtd::string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object. A parameter specifies whether the operation is case-sensitive. The return value indicates whether the conversion succeeded. / Parameters vaue The xtd::string representation of the enumeration name or underlying value to convert. / ignore_case true to Ignore case; false to regard case. / reslt When this method returns, result contains an object of type TEnum whose value is represented by value if the parse operation succeeds. If the parse operation fails, result contains the default value of the underlying type of TEnum. Note that this value need ! be a member of the TEnum enumeration. This parameter is passed uninitialized. / Returns true if the value parameter was converted successfully; otherwise, false.
static enum_type	parse (const xtd::string &str)
	Converts the string to its enum_type equivalent.
template<class enum_t>
static bool	try_parse (const xtd::string &value, bool ignore_case, enum_t &result) noexcept

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

Member Typedef Documentation

enum_type

template<class enum_t = std::nullptr_t>

using xtd::enum_object< enum_t >::enum_type

Represents the enumeration type.

value_type

template<class 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<class 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<class 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<class enum_t = std::nullptr_t>

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

inlinenoexcept

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

compare_to()

template<class enum_t = std::nullptr_t>

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

inlineoverridenoexcept

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<class enum_t = std::nullptr_t>

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

inlineoverridevirtualnoexcept

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<class enum_t = std::nullptr_t>

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

inlineoverridenoexcept

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<class enum_t = std::nullptr_t>

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

inlinenoexcept

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<class enum_t = std::nullptr_t>

template<class attribute_t>

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

inlinenoexcept

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<class enum_t = std::nullptr_t>

xtd::size xtd::enum_object< enum_t >::get_hash_code ( ) const

inlineoverridevirtualnoexcept

Serves as a hash function for a particular type.

Returns

size_t A hash code for the current object.

Reimplemented from xtd::object.

to_byte()

template<class enum_t = std::nullptr_t>

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

inlinenoexcept

Converts this instance to byte.

Returns

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

to_int16()

template<class enum_t = std::nullptr_t>

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

inlinenoexcept

Converts this instance to int16.

Returns

A new to_int16 object converted from this instance.

to_int32()

template<class enum_t = std::nullptr_t>

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

inlinenoexcept

Converts this instance to int32.

Returns

A new to_int32 object converted from this instance.

to_int64()

template<class enum_t = std::nullptr_t>

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

inlinenoexcept

Converts this instance to int64.

Returns

A new to_int64 object converted from this instance.

to_sbyte()

template<class enum_t = std::nullptr_t>

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

inlinenoexcept

Converts this instance to signed byte.

Returns

A new sbyte object converted from this instance.

to_uint16()

template<class enum_t = std::nullptr_t>

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

inlinenoexcept

Converts this instance to unsigned int16.

Returns

A new to_uint16 object converted from this instance.

to_uint32()

template<class enum_t = std::nullptr_t>

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

inlinenoexcept

Converts this instance to unsigned int32.

Returns

A new to_uint32 object converted from this instance.

to_uint64()

template<class enum_t = std::nullptr_t>

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

inlinenoexcept

Converts this instance to unsigned int64.

Returns

A new to_uint64 object converted from this instance.

to_string() [1/3]

template<class enum_t = std::nullptr_t>

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

inlineoverridevirtualnoexcept

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

Returns

A string that represents the current object.

Reimplemented from xtd::object.

Examples

sprintf_enum.cpp, and sprintf_enum_class.cpp.

to_string() [2/3]

template<class enum_t = std::nullptr_t>

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

inline

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<class enum_t = std::nullptr_t>

xtd::string xtd::enum_object< enum_t >::to_string ( const xtd::string & format, const std::locale & loc ) const

overridevirtual

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

Parameters

format	A format string.
loc	An std::locale object that contains locale information (see std::locale).

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<class enum_t = std::nullptr_t>

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

inlinestatic

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<class 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