Documentation for microsoft::quantum::ConfigurationManager::Section
microsoft::quantum::ConfigurationManager::Section
#include <Commandline/ConfigurationManager.hpp>
Public Attributes
Name | |
---|---|
TypeId | type Type of the configuration. |
String | name Name of the section. |
String | description Description of the section. |
bool | can_disable Whether or not this section can be disabled. |
bool | enabled_by_default Whether or not this section is enabled by default. |
VoidPtr | configuration Configuration class instance. |
ConfigList | settings List of parameter bindings. |
BoolPtr | active Whether or not this component is active;. |
String | id Id referring to this component. |
Detailed Description
struct microsoft::quantum::ConfigurationManager::Section;
Section defines a section in the configuration. It holds the type of the configuration class, the name of the section a description, the instance of the configuration class itself and list of parameter bindings.
Public Attributes Documentation
variable type
TypeId type {[TypeId](/qat/Api/Classes/classmicrosoft_1_1quantum_1_1_configuration_manager/#using-typeid)(typeid(std::nullptr_t))};
Type of the configuration.
variable name
String name {};
Name of the section.
variable description
String description {};
Description of the section.
variable can_disable
bool can_disable {false};
Whether or not this section can be disabled.
variable enabled_by_default
bool enabled_by_default {true};
Whether or not this section is enabled by default.
variable configuration
VoidPtr configuration {};
Configuration class instance.
variable settings
ConfigList settings {};
List of parameter bindings.
variable active
BoolPtr active {nullptr};
Whether or not this component is active;.
variable id
String id {};
Id referring to this component.
Updated on 1 August 2023 at 16:25:10 UTC