ALib C++ Library
Library Version: 2402 R1
Documentation generated by doxygen
No Matches
InMemoryPlugin::Entry Class Reference


A section entry. Corresponds to a configuration Variable .

Definition at line 73 of file inmemoryplugin.hpp.

#include <inmemoryplugin.hpp>

Collaboration diagram for InMemoryPlugin::Entry:

Public Field Index:

TValueList AdditionalValues
AString Comments
character Delim = '\0'
FormatHints FmtHints = FormatHints::None
String8 FormatAttrAlignment
String32 RawValue
String32 Value

Public Method Index:

 Entry (const String &pName, MonoAllocator *pAllocator, TValueList::TSharedRecycler &recycler)
const StringName () const
TValueList::Iterator SetValueCount (integer requestedSize)

Field Details:

◆ AdditionalValues

TValueList AdditionalValues

The rest of the values.

Definition at line 102 of file inmemoryplugin.hpp.

◆ Comments

AString Comments

The comments of the section.

Definition at line 85 of file inmemoryplugin.hpp.

◆ Delim

character Delim = '\0'

The delimiter (for splitting output into multiple lines).

Definition at line 88 of file inmemoryplugin.hpp.

◆ FmtHints

FormatHints FmtHints = FormatHints::None

The format hints of the variable

Definition at line 91 of file inmemoryplugin.hpp.

◆ FormatAttrAlignment

String8 FormatAttrAlignment

Used to vertically align attributes in multi-line attributes. Use cases are "=", ":" or "->".
Used by IniFile and potentially by custom derived plug-in types.

Definition at line 96 of file inmemoryplugin.hpp.

◆ name

String32 name

The entry's name

Definition at line 81 of file inmemoryplugin.hpp.

◆ RawValue

String32 RawValue

The value as received from an external source. Derived types may use this "original" value in the case that it was not changed by software. For example in case of INI-files, this approach preserves a user's manual format, when writing back the file.

Definition at line 108 of file inmemoryplugin.hpp.

◆ Value

String32 Value

The first values of the entry.

Definition at line 99 of file inmemoryplugin.hpp.

Constructor(s) / Destructor Details::

◆ Entry()

Entry ( const String & pName,
MonoAllocator * pAllocator,
TValueList::TSharedRecycler & recycler )

Constructs an Entry

pNameThe name of the entry.
pAllocatorThe allocator used for the list of additional values.
recyclerThe recycler for value entries.

Definition at line 116 of file inmemoryplugin.hpp.

Here is the call graph for this function:

Method Details:

◆ Name()

const String & Name ( ) const

Returns the (unique) name of this entry.

The name of this entry

Definition at line 133 of file inmemoryplugin.hpp.

◆ SetValueCount()

TValueList::Iterator SetValueCount ( integer requestedSize)

Increases or shrinks the number of elements in AdditionalValues to match the given requestedSize - 1.

requestedSizeThe requested number of values of this entry.
An iterator pointing to the first additional value, hence the second value of this entry.

Definition at line 146 of file inmemoryplugin.hpp.

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