XJ music engine  1.9.6
In-game runtime engine for XJ music.
Public Member Functions | List of all members
XJ::ConfigListValue Class Referencefinal

#include <ConfigParser.h>

Inheritance diagram for XJ::ConfigListValue:
XJ::ConfigValue

Public Member Functions

unsigned long size () const
 
std::vector< std::string > asListOfStrings () const
 
std::set< std::string > asSetOfStrings () const
 
std::vector< std::map< std::string, std::variant< std::string, std::vector< std::string > > > > asListOfMapsOfStrings ()
 
ConfigSingleValue atSingle (const unsigned long &index)
 
ConfigObjectValue atObject (const unsigned long &index)
 
void add (const std::variant< ConfigSingleValue, ConfigObjectValue > &value)
 
bool operator== (const ConfigListValue &other) const
 
bool operator!= (const ConfigListValue &other) const
 
- Public Member Functions inherited from XJ::ConfigValue
virtual ~ConfigValue ()=default
 

Detailed Description

A list value in a HOCON configuration

Member Function Documentation

◆ add()

void ConfigListValue::add ( const std::variant< ConfigSingleValue, ConfigObjectValue > &  value)

Add a value to the list

Parameters
valueThe value to add

◆ asListOfMapsOfStrings()

std::vector< std::map< std::string, std::variant< std::string, std::vector< std::string > > > > ConfigListValue::asListOfMapsOfStrings ( )

◆ asListOfStrings()

std::vector< std::string > ConfigListValue::asListOfStrings ( ) const

Get the list as a vector of strings

Returns
The list as a vector of strings

◆ asSetOfStrings()

std::set< std::string > ConfigListValue::asSetOfStrings ( ) const

Get the list as a vector of strings

Returns
The list as a vector of strings

◆ atObject()

ConfigObjectValue ConfigListValue::atObject ( const unsigned long &  index)

Get an object value from the list

Parameters
indexat which to get the value
Returns
object value

◆ atSingle()

ConfigSingleValue ConfigListValue::atSingle ( const unsigned long &  index)

Get a single value from the list

Parameters
indexat which to get the value
Returns
single value

◆ operator!=()

bool ConfigListValue::operator!= ( const ConfigListValue other) const

Compare two ConfigListValue for inequality

Parameters
otherThe ConfigListValue to compare
Returns
true if inequal

◆ operator==()

bool ConfigListValue::operator== ( const ConfigListValue other) const

Compare two ConfigListValue for equality

Parameters
otherThe ConfigListValue to compare
Returns
true if equal

◆ size()

unsigned long ConfigListValue::size ( ) const

Get the size of the list

Returns
The size of the list

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