xtd::environment::xtd_library Class Reference

Inheritance diagram for xtd::environment::xtd_library:

Definition

Represents a xtd library that contains name, version and paths.

Public Properties
auto	include_path () const noexcept -> const xtd::string &
	Gets The inlcude path of the library.
auto	library_path () const noexcept -> const xtd::string &
	Gets The library path of the library.
auto	name () const noexcept -> const xtd::string &
	Gets The name of the library.
auto	resources_path () const noexcept -> const xtd::string &
	Gets The resource path of the library.
auto	version () const noexcept -> const xtd::version &
	Gets The version of the library.

Public Methods
auto	equals (const object &other) const noexcept -> bool override
	Determines whether the specified object is equal to the current object.
auto	equals (const xtd_library &other) const noexcept -> bool override
auto	to_string () const noexcept -> xtd::string override
	Returns a xtd::string that represents the current object.

Additional Inherited Members
	object ()=default
	Create a new instance of the ultimate base class object.
virtual xtd::usize	get_hash_code () const noexcept
	Serves as a hash function for a particular type.
virtual type_object	get_type () const noexcept
	Gets the type of the current instance.
template<typename object_t>
xtd::unique_ptr_object< object_t >	memberwise_clone () const
	Creates a shallow copy of the current object.
virtual bool	equals (const xtd_library &) const noexcept=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 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<typename object_a_t, typename 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 Function Documentation

include_path()

auto xtd::environment::xtd_library::include_path ( ) const -> const xtd::string &

nodiscardnoexcept

Gets The inlcude path of the library.

Returns

A string that represents the include path of the library.

library_path()

auto xtd::environment::xtd_library::library_path ( ) const -> const xtd::string &

nodiscardnoexcept

Gets The library path of the library.

Returns

A string that represents the library path of the library.

name()

auto xtd::environment::xtd_library::name ( ) const -> const xtd::string &

nodiscardnoexcept

Gets The name of the library.

Returns

A string that represents the name of the library.

resources_path()

auto xtd::environment::xtd_library::resources_path ( ) const -> const xtd::string &

nodiscardnoexcept

Gets The resource path of the library.

Returns

A string that represents the resource path of the library.

version()

auto xtd::environment::xtd_library::version ( ) const -> const xtd::version &

nodiscardnoexcept

Gets The version of the library.

Returns

An xtd::version object that represents the version of the library.

equals()

auto xtd::environment::xtd_library::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.

Examples

The following code example compares the current instance with another object.

#include <xtd/xtd>
 
auto main() -> int {
  auto object1 = new_ptr<object>();
  auto object2 = new_ptr<object>();
  
  auto object3 = object2;
  console::write_line(object1->equals(*object3));
  console::write_line(*object1 == *object3);
  object3 = object1;
  console::write_line(object1->equals(*object3));
  console::write_line(*object1 == *object3);
}
 
// This code produces the following output :
//
// false
// false
// true
// true

Reimplemented from xtd::object.

to_string()

auto xtd::environment::xtd_library::to_string ( ) const -> xtd::string

nodiscardoverridevirtualnoexcept

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

Returns

A string that represents the current object.

Examples

The following code example demonstrates what to_string returns.

#include <xtd/xtd>
 
namespace examples {
  namespace object_test {
    class object1 : public object {
    };
  }
}
 
auto main() -> int {
  ptr<object> obj1 = new_ptr<examples::object_test::object1>();
  console::write_line(obj1->to_string());
 
  ptr<object> obj2 = new_ptr<date_time>(1971, 1, 5, 23, 5, 0);
  console::write_line(obj2->to_string());
 
  ptr<object> obj3 = new_ptr<boolean_object>();
  console::write_line(obj3->to_string());
}
 
// This code produces the following output :
//
// examples::object_test::object1
// Tue Jan  5 23:05:00 1971
// false

Reimplemented from xtd::object.

---

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

• xtd.core/include/xtd/environment.hpp