xtd::diagnostics::trace_switch Class Reference

#include <trace_switch.h>

Definition

Provides a multilevel switch to control tracing and debug output without recompiling your code.

Namespace

xtd::diagnostics

Library

xtd.core

Remarks

You can use a trace switch to filter out messages based on their importance. The trace_switch class provides the trace_error, trace_warning, trace_info, and trace_verbose properties to test the level of the switch. The level property gets or sets the switch's trace_level.

You can set the level of a trace_switch through the application configuration file and then use the configured trace_switch level in your application. Alternately, you can create a trace_switch in your code and set the level directly to instrument a specific section of code.

Inherits xtd::diagnostics::switch_base.

Public Member Functions
	trace_switch (const xtd::ustring &display_name, const xtd::ustring &description)
	Initializes a new instance of the xtd::diagnostics::trace_switch class, using the specified display name and description.
	trace_switch (const xtd::ustring &display_name, const xtd::ustring &description, const xtd::ustring &default_switch_value)
	Initializes a new instance of the xtd::diagnostics::trace_switch class, using the specified display name, description, and default value for the switch.
xtd::diagnostics::trace_level	level () const
	Gets the trace level that determines the messages the switch allows.
void	level (xtd::diagnostics::trace_level level)
	Sets the trace level that determines the messages the switch allows.
bool	trace_error () const
	Gets a value indicating whether the switch allows error-handling messages.
bool	trace_info () const
	Gets a value indicating whether the switch allows informational messages.
bool	trace_verbose () const
	Gets a value indicating whether the switch allows all messages.
bool	trace_warning () const
	Gets a value indicating whether the switch allows warning messages.
Public Member Functions inherited from xtd::diagnostics::switch_base
std::map< xtd::ustring, xtd::ustring > &	attributes ()
	Gets the custom switch attributes.
const std::map< xtd::ustring, xtd::ustring > &	attributes () const
	Gets the custom switch attributes @rettur nA StringDictionary containing the case-insensitive custom attributes for the trace switch.
void	attributes (const std::map< xtd::ustring, xtd::ustring > &attributes)
	Sets the custom switch attributes.
const xtd::ustring &	description () const
	Gets a description of the switch.
const xtd::ustring &	display_name () const
	Gets a name used to identify the switch.
Public Member Functions inherited from xtd::object
	object ()=default
	Create a new instance of the ultimate base class object.
virtual bool	equals (const object &obj) const noexcept
	Determines whether the specified object is equal to the current object.
virtual size_t	get_hash_code () const noexcept
	Serves as a hash function for a particular type.
template<typename object_t >
std::unique_ptr< object_t >	memberwise_clone () const
	Gets the type of the current instance.
virtual xtd::ustring	to_string () const noexcept
	Returns a std::string that represents the current object.

Protected Member Functions
void	on_switch_setting_changed () override
	Invoked when the switch_setting property is changed.
void	on_value_changed () override
	Invoked when the value property is changed.
Protected Member Functions inherited from xtd::diagnostics::switch_base
	switch_base (const xtd::ustring &display_name, const xtd::ustring &description)
	Initializes a new instance of the switch_base class.
	switch_base (const xtd::ustring &display_name, const xtd::ustring &description, const xtd::ustring &default_switch_value)
	Initializes a new instance of the switch_base class.
virtual std::vector< xtd::ustring >	get_supported_attributes () const
	Gets the custom attributes supported by the switch.
virtual void	on_switch_setting_changed ()
	Invoked when the switch_setting property is changed.
virtual void	on_value_changed ()
	Invoked when the value property is changed.
int32_t	switch_setting () const
	Gets the current setting for this switch.
void	switch_setting (int32_t switch_setting)
	Sets the current setting for this switch.
const xtd::ustring &	value () const
	Gets the value of the switch.
void	value (const xtd::ustring &value)
	Sets the value of the switch.

Additional Inherited Members
Static Public Member Functions inherited from xtd::object
static bool	equals (const object &object_a, const object &object_b) noexcept
	Determines whether the specified object instances are considered equal.
static bool	reference_equals (const object &object_a, const object &object_b) noexcept
	Determines whether the specified object instances are the same instance.

Constructor & Destructor Documentation

trace_switch() [1/2]

xtd::diagnostics::trace_switch::trace_switch	(	const xtd::ustring &	display_name,
		const xtd::ustring &	description
	)

Initializes a new instance of the xtd::diagnostics::trace_switch class, using the specified display name and description.

Parameters

display_name	The name to display on a user interface.
description	The description of the switch.

Remarks

he xtd::diagnostics::trace_switch class provides the xtd::diagnostics::trace_switch::trace_error, xtd::diagnostics::trace_switch::trace_warning, xtd::diagnostics::trace_switch::trace_info, and xtd::diagnostics::trace_switch::trace_verbose properties to test the Level of the switch. The xtd::diagnostics::trace_switch::level property gets or sets the switch's xtd::diagnostics::trace_level.

Note

To improve performance, you can make xtd::diagnostics::trace_switch members static in your class.

trace_switch() [2/2]

xtd::diagnostics::trace_switch::trace_switch	(	const xtd::ustring &	display_name,
		const xtd::ustring &	description,
		const xtd::ustring &	default_switch_value
	)

Initializes a new instance of the xtd::diagnostics::trace_switch class, using the specified display name, description, and default value for the switch.

Parameters

display_name	The name to display on a user interface.
description	The description of the switch.
default_switch_value	The default value of the switch.

Remarks

The display_name parameter is used to set the value of the xtd::diagnostics::trace_switch::display_name property, the description parameter is use to set the value of the xtd::diagnostics::trace_switch::description property, and the default_switch_value parameter is saved as a field and used to initialize the xtd::diagnostics::trace_switch::value property on first reference.

Member Function Documentation

level() [1/2]

xtd::diagnostics::trace_level xtd::diagnostics::trace_switch::level

(

)

const

Gets the trace level that determines the messages the switch allows.

Returns

One of the xtd::diagnostics::trace_level values that specifies the level of messages that are allowed by the switch.

Remarks

Setting this property updates the xtd::diagnostics::trace_switch::trace_error, xtd::diagnostics::trace_switch::trace_warning, xtd::diagnostics::trace_switch::trace_info, and xtd::diagnostics::trace_switch::trace_verbose properties to reflect the new value.

level() [2/2]

void xtd::diagnostics::trace_switch::level

(

xtd::diagnostics::trace_level

level

)

Sets the trace level that determines the messages the switch allows.

Parameters

level

One of the xtd::diagnostics::trace_level values that specifies the level of messages that are allowed by the switch.

Remarks

Setting this property updates the xtd::diagnostics::trace_switch::trace_error, xtd::diagnostics::trace_switch::trace_warning, xtd::diagnostics::trace_switch::trace_info, and xtd::diagnostics::trace_switch::trace_verbose properties to reflect the new value.

on_switch_setting_changed()

void xtd::diagnostics::trace_switch::on_switch_setting_changed ( )

overrideprotectedvirtual

Invoked when the switch_setting property is changed.

Reimplemented from xtd::diagnostics::switch_base.

on_value_changed()

void xtd::diagnostics::trace_switch::on_value_changed ( )

overrideprotectedvirtual

Invoked when the value property is changed.

Remarks

The default implementation parses the new value of the value property to an integer value which it uses to set the switch_setting property.

Not to Inheritors

You should override this method and use a conversion that sets the appropriate switch_setting value for your switch.

Reimplemented from xtd::diagnostics::switch_base.

trace_error()

bool xtd::diagnostics::trace_switch::trace_error

(

)

const

Gets a value indicating whether the switch allows error-handling messages.

Returns

true if the xtd::diagnostics::trace_switch::level property is set to xtd::diagnostics::trace_level::error, xtd::diagnostics::trace_level::warning, xtd::diagnostics::trace_level::info, or xtd::diagnostics::trace_level::verbose; otherwise, false.

trace_info()

bool xtd::diagnostics::trace_switch::trace_info

(

)

const

Gets a value indicating whether the switch allows informational messages.

Returns

true if the xtd::diagnostics::trace_switch::level property is set to xtd::diagnostics::trace_level::info, or xtd::diagnostics::trace_level::verbose; otherwise, false.

trace_verbose()

bool xtd::diagnostics::trace_switch::trace_verbose

(

)

const

Gets a value indicating whether the switch allows all messages.

Returns

true if the xtd::diagnostics::trace_switch::level property is set to xtd::diagnostics::trace_level::verbose; otherwise, false.

trace_warning()

bool xtd::diagnostics::trace_switch::trace_warning

(

)

const

Gets a value indicating whether the switch allows warning messages.

Returns

true if the xtd::diagnostics::trace_switch::level property is set to xtd::diagnostics::trace_level::warning, xtd::diagnostics::trace_level::info, or xtd::diagnostics::trace_level::verbose; otherwise, false.

---

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

• xtd.core/include/xtd/diagnostics/trace_switch.h