balb::ControlManager::ControlManager_Entry Class Reference

#include <balb_controlmanager.h>

List of all members.

Public Member Functions
	BSLMF_NESTED_TRAIT_DECLARATION (ControlManager_Entry, bslma::UsesBslmaAllocator)
	ControlManager_Entry (bslma::Allocator *basicAllocator=0)
	ControlManager_Entry (const ControlManager::ControlHandler &callback, const bsl::string_view &arguments, const bsl::string_view &description, bslma::Allocator *basicAllocator=0)
	ControlManager_Entry (const ControlManager_Entry &original, bslma::Allocator *basicAllocator=0)
	~ControlManager_Entry ()
ControlManager_Entry &	operator= (const ControlManager_Entry &rhs)
void	setCallback (const ControlManager::ControlHandler &callback)
bsl::string &	arguments ()
bsl::string &	description ()
const ControlManager::ControlHandler &	callback () const
const bsl::string &	arguments () const
const bsl::string &	description () const

---

Detailed Description

This component-private class represents a function with documentation.

See Component balb_controlmanager

---

Constructor & Destructor Documentation

balb::ControlManager::ControlManager_Entry::ControlManager_Entry

(

bslma::Allocator *

basicAllocator = 0

)

[explicit]

Create a ControlManager_Entry object. Optionally specify a basicAllocator used to supply memory. If basicAllocator is 0, the currently installed default allocator is used.

balb::ControlManager::ControlManager_Entry::ControlManager_Entry	(	const ControlManager::ControlHandler &	callback,
		const bsl::string_view &	arguments,
		const bsl::string_view &	description,
		bslma::Allocator *	basicAllocator = 0
	)

Create an ControlManager_Entry object with the specified initial values.

balb::ControlManager::ControlManager_Entry::ControlManager_Entry	(	const ControlManager_Entry &	original,
		bslma::Allocator *	basicAllocator = 0
	)

Create an ControlManager_Entry object having the value of the specified original object. Optionally specify a basicAllocator used to supply memory. If basicAllocator is 0, the currently installed default allocator is used.

balb::ControlManager::ControlManager_Entry::~ControlManager_Entry

(

)

Destroy this object.

---

Member Function Documentation

balb::ControlManager::ControlManager_Entry::BSLMF_NESTED_TRAIT_DECLARATION	(	ControlManager_Entry	,
		bslma::UsesBslmaAllocator
	)

ControlManager_Entry& balb::ControlManager::ControlManager_Entry::operator=

(

const ControlManager_Entry &

rhs

)

Assign to this object the value of the specified rhs object.

void balb::ControlManager::ControlManager_Entry::setCallback

(

const ControlManager::ControlHandler &

callback

)

Set the specified callback as the value of the callback member of this object.

bsl::string& balb::ControlManager::ControlManager_Entry::arguments

(

)

Return a modifiable reference to the arguments member of this object.

bsl::string& balb::ControlManager::ControlManager_Entry::description

(

)

Return a modifiable reference to the description member of this object.

const ControlManager::ControlHandler& balb::ControlManager::ControlManager_Entry::callback

(

)

const

Return a non-modifiable reference to the callback member of this object.

const bsl::string& balb::ControlManager::ControlManager_Entry::arguments

(

)

const

Return a non-modifiable reference to the arguments member of this object.

const bsl::string& balb::ControlManager::ControlManager_Entry::description

(

)

const

Return a non-modifiable reference to the arguments member of this object.

---

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

• balb_controlmanager.h