alib::lox::CVVerbosities Struct Reference

Description:

Variable data struct, defining the verbosities of the domains of a Logger in a Lox. This struct is used with the configuration variable named ALOX/LOGGERNAME/VERBOSITY_WITH_LOXNAME.

Note that during the run of software, the verbosity values are stored differently and this variable type is only for importing and exporting such values to external systems.

Definition at line 82 of file aloxcamp.hpp.

#include <aloxcamp.hpp>

Inheritance diagram for alib::lox::CVVerbosities:

Collaboration diagram for alib::lox::CVVerbosities:

Public Field Index:
bool	ExportAll =false
bool	WriteBack =false

Public Method Index:
	CVVerbosities (AllocatorType &pAllocator)
	~CVVerbosities ()
	Destructor. Frees all allocated strings.
integer	Add (const strings::TString< character > &src)
void	Clear ()
	Frees all allocated strings and clears vector.
bool	IsEmpty ()
integer	Size () const noexcept

Additional Inherited Members
Protected Type Index: inherited from alib::strings::util::TStringVector< character, PoolAllocator >
using	vectorBase
	The vector type that TAllocator specifies.
using	AllocatorType
	The allocator type that TAllocator specifies.
Protected Method Index: inherited from alib::strings::util::TStringVector< character, PoolAllocator >
	TStringVector ()
	Constructor.
	TStringVector (AllocatorType &pAllocator)
	~TStringVector ()=default
	Destructor.
integer	Add (const strings::TString< character > &src)
AllocatorType &	GetAllocator () noexcept
integer	Size () const noexcept
String	TryGet (integer idx)

Field Details:

ExportAll

bool alib::lox::CVVerbosities::ExportAll =false

Determines whether only the minimum necessary domain tree is written when the verbosities are exported. If true, redundant verbosity information is given, even if Subdomains have the same value.

Definition at line 86 of file aloxcamp.hpp.

WriteBack

bool alib::lox::CVVerbosities::WriteBack =false

Determines whether changes should be written back to configuration sources, if possible.

See also

Methods Lox::SetVerbosityExport, Variable::IsWriteBack, and the virtual method used to implement this feature: VMeta::isWriteBack.

Definition at line 91 of file aloxcamp.hpp.

Constructor(s) / Destructor Details:

CVVerbosities()

alib::lox::CVVerbosities::CVVerbosities ( AllocatorType & pAllocator )

inline

Constructor.

Parameters

pAllocator

The allocator to use.

Definition at line 95 of file aloxcamp.hpp.

~CVVerbosities()

alib::lox::CVVerbosities::~CVVerbosities ( )

inline

Destructor. Frees all allocated strings.

Definition at line 99 of file aloxcamp.hpp.

Here is the call graph for this function:

Method Details:

Add()

integer alib::strings::util::TStringVector< character, PoolAllocator >::Add ( const strings::TString< character > & src )

inline

Adds a string to the end of the list of strings.

Parameters

src	Source string to be copied.

Returns

The index of the created string in this vector.

Definition at line 81 of file vector.hpp.

Clear()

void alib::lox::CVVerbosities::Clear ( )

inline

Frees all allocated strings and clears vector.

Definition at line 110 of file aloxcamp.hpp.

Here is the call graph for this function:

IsEmpty()

bool alib::lox::CVVerbosities::IsEmpty ( )

inline

Returns

true if this vector is empty, false otherwise.

Definition at line 107 of file aloxcamp.hpp.

Size()

integer alib::strings::util::TStringVector< character, PoolAllocator >::Size ( ) const

inlinenoexcept

Returns the size of this vector as integer.

Returns

The number of strings stored.

Definition at line 76 of file vector.hpp.

---

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

• aloxcamp.hpp