#include <cpptoml.h>

Inheritance diagram for cpptoml::array:

Collaboration diagram for cpptoml::array:

Public Types
using	size_type = std::size_t

using	iterator = std::vector< std::shared_ptr< base > >::iterator

using	const_iterator = std::vector< std::shared_ptr< base > >::const_iterator

Public Member Functions
std::shared_ptr< base >	clone () const override

MBool	is_array () const override

iterator	begin ()

const_iterator	begin () const

iterator	end ()

const_iterator	end () const

std::vector< std::shared_ptr< base > > &	get ()

const std::vector< std::shared_ptr< base > > &	get () const

std::shared_ptr< base >	at (size_t idx) const

template<class T >
std::vector< std::shared_ptr< value< T > > >	array_of () const

template<class T >
array_of_trait< T >::return_type	get_array_of () const

std::vector< std::shared_ptr< array > >	nested_array () const

template<class T >
void	push_back (const std::shared_ptr< value< T > > &val)

void	push_back (const std::shared_ptr< array > &val)

template<class T >
void	push_back (T &&val, typename value_traits< T >::type *=0)

template<class T >
iterator	insert (iterator position, const std::shared_ptr< value< T > > &value)

iterator	insert (iterator position, const std::shared_ptr< array > &value)

template<class T >
iterator	insert (iterator position, T &&val, typename value_traits< T >::type *=0)

iterator	erase (iterator position)

void	clear ()

void	reserve (size_type n)

	array (const array &obj)=delete

array &	operator= (const array &obj)=delete

template<>
array_of_trait< array >::return_type	get_array_of () const

Public Member Functions inherited from cpptoml::base
virtual	~base ()=default

virtual std::shared_ptr< base >	clone () const =0

virtual MBool	is_value () const

virtual MBool	is_table () const

std::shared_ptr< table >	as_table ()

virtual MBool	is_array () const

std::shared_ptr< array >	as_array ()

virtual MBool	is_table_array () const

std::shared_ptr< table_array >	as_table_array ()

template<class T >
std::shared_ptr< value< T > >	as ()

template<class T >
std::shared_ptr< const value< T > >	as () const

template<class Visitor , class... Args>
void	accept (Visitor &&visitor, Args &&... args) const

base_type	type () const

template<>
std::shared_ptr< value< double > >	as ()

template<>
std::shared_ptr< const value< double > >	as () const

Private Member Functions
	array ()

	array ()=default

template<class InputIterator >
	array (InputIterator begin, InputIterator end)

Private Attributes
std::vector< std::shared_ptr< base > >	values_

Friends
std::shared_ptr< array >	make_array ()

Additional Inherited Members
Protected Member Functions inherited from cpptoml::base
	base (const base_type t)

	base ()

Detailed Description

Definition at line 673 of file cpptoml.h.

Member Typedef Documentation

◆ const_iterator

using cpptoml::array::const_iterator = std::vector<std::shared_ptr<base> >::const_iterator

arrays can be iterated over. Const version.

Definition at line 691 of file cpptoml.h.

◆ iterator

using cpptoml::array::iterator = std::vector<std::shared_ptr<base> >::iterator

arrays can be iterated over

Definition at line 686 of file cpptoml.h.

◆ size_type

using cpptoml::array::size_type = std::size_t

Definition at line 681 of file cpptoml.h.

Constructor & Destructor Documentation

◆ array() [1/4]

cpptoml::array::array ( )

inlineprivate

Definition at line 844 of file cpptoml.h.

          : base(base_type::ARRAY) {
    // empty
  }

◆ array() [2/4]

cpptoml::array::array ( )

privatedefault

◆ array() [3/4]

template<class InputIterator >

cpptoml::array::array	(	InputIterator	begin,
		InputIterator	end
	)

inlineprivate

Definition at line 852 of file cpptoml.h.

                                                : values_{begin, end} {
    // nothing
  }

◆ array() [4/4]

cpptoml::array::array ( const array & obj )

delete

Member Function Documentation

◆ array_of()

template<class T >

std::vector< std::shared_ptr< value< T > > > cpptoml::array::array_of ( ) const

inline

Obtains an array of value<T>s. Note that elements may be nullptr if they cannot be converted to a value<T>.

Definition at line 718 of file cpptoml.h.

                                                      {
    std::vector<std::shared_ptr<value<T>>> result(values_.size());
 
    std::transform(values_.begin(), values_.end(), result.begin(),
                   [&](const std::shared_ptr<base>& v) { return v->as<T>(); });
 
    return result;
  }

◆ at()

std::shared_ptr< base > cpptoml::array::at ( size_t idx ) const

inline

Definition at line 711 of file cpptoml.h.

711{ return values_.at(idx); }

◆ begin() [1/2]

iterator cpptoml::array::begin ( )

inline

Definition at line 693 of file cpptoml.h.

693{ return values_.begin(); }

◆ begin() [2/2]

const_iterator cpptoml::array::begin ( ) const

inline

Definition at line 695 of file cpptoml.h.

695{ return values_.begin(); }

◆ clear()

void cpptoml::array::clear ( )

inline

Clear the array

Definition at line 833 of file cpptoml.h.

833{ values_.clear(); }

◆ clone()

std::shared_ptr< base > cpptoml::array::clone ( ) const

inlineoverridevirtual

Implements cpptoml::base.

Definition at line 1437 of file cpptoml.h.

                                              {
  auto result = make_array();
  result->reserve(values_.size());
  for(const auto& ptr : values_)
    result->values_.push_back(ptr->clone());
  return result;
}

◆ end() [1/2]

iterator cpptoml::array::end ( )

inline

Definition at line 697 of file cpptoml.h.

697{ return values_.end(); }

◆ end() [2/2]

const_iterator cpptoml::array::end ( ) const

inline

Definition at line 699 of file cpptoml.h.

699{ return values_.end(); }

◆ erase()

iterator cpptoml::array::erase ( iterator position )

inline

Erase an element from the array

Definition at line 828 of file cpptoml.h.

828{ return values_.erase(position); }

◆ get() [1/2]

std::vector< std::shared_ptr< base > > & cpptoml::array::get ( )

inline

Obtains the array (vector) of base values.

Definition at line 704 of file cpptoml.h.

704{ return values_; }

◆ get() [2/2]

const std::vector< std::shared_ptr< base > > & cpptoml::array::get ( ) const

inline

Obtains the array (vector) of base values. Const version.

Definition at line 709 of file cpptoml.h.

709{ return values_; }

◆ get_array_of() [1/2]

template<class T >

array_of_trait< T >::return_type cpptoml::array::get_array_of ( ) const

inline

Obtains a option<vector<T>>. The option will be empty if the array contains values that are not of type T.

Definition at line 732 of file cpptoml.h.

                                                                    {
    std::vector<T> result;
    result.reserve(values_.size());
 
    for(const auto& val : values_) {
      if(auto v = val->as<T>())
        result.push_back(v->get());
      else
        return {};
    }
 
    return {std::move(result)};
  }

◆ get_array_of() [2/2]

template<>

array_of_trait< array >::return_type cpptoml::array::get_array_of ( ) const

inline

Obtains a option<vector<T>>. The option will be empty if the array contains values that are not of type T.

Definition at line 895 of file cpptoml.h.

                                                                                  {
  std::vector<std::shared_ptr<array>> result;
  result.reserve(values_.size());
 
  for(const auto& val : values_) {
    if(auto v = val->as_array())
      result.push_back(v);
    else
      return {};
  }
 
  return {std::move(result)};
}

◆ insert() [1/3]

iterator cpptoml::array::insert	(	iterator	position,
		const std::shared_ptr< array > &	value
	)

inline

Insert an array into the array

Definition at line 809 of file cpptoml.h.

                                                                        {
    if(values_.empty() || values_[0]->is_array()) {
      return values_.insert(position, value);
    } else {
      THROW_(array_exception, "Arrays must be homogenous.");
    }
  }

◆ insert() [2/3]

template<class T >

iterator cpptoml::array::insert	(	iterator	position,
		const std::shared_ptr< value< T > > &	value
	)

inline

Insert a value into the array

Definition at line 798 of file cpptoml.h.

                                                                           {
    if(values_.empty() || values_[0]->as<T>()) {
      return values_.insert(position, value);
    } else {
      THROW_(array_exception, "Arrays must be homogenous.");
    }
  }

◆ insert() [3/3]

template<class T >

iterator cpptoml::array::insert	(	iterator	position,
		T &&	val,
		typename value_traits< T >::type *	= `0`
	)

inline

Convenience function for inserting a simple element in the array

Definition at line 821 of file cpptoml.h.

                                                                                 {
    return insert(position, make_value(std::forward<T>(val)));
  }

◆ is_array()

MBool cpptoml::array::is_array ( ) const

inlineoverridevirtual

Determines if the TOML element is an array of "leaf" elements.

Reimplemented from cpptoml::base.

Definition at line 679 of file cpptoml.h.

679{ return true; }

◆ nested_array()

std::vector< std::shared_ptr< array > > cpptoml::array::nested_array ( ) const

inline

Obtains an array of arrays. Note that elements may be nullptr if they cannot be converted to a array.

Definition at line 750 of file cpptoml.h.

                                                       {
    std::vector<std::shared_ptr<array>> result(values_.size());
 
    std::transform(values_.begin(), values_.end(), result.begin(),
                   [&](const std::shared_ptr<base>& v) -> std::shared_ptr<array> {
                     if(v->is_array()) return std::static_pointer_cast<array>(v);
                     return std::shared_ptr<array>{};
                   });
 
    return result;
  }

◆ operator=()

array & cpptoml::array::operator= ( const array & obj )

delete

◆ push_back() [1/3]

void cpptoml::array::push_back ( const std::shared_ptr< array > & val )

inline

Add an array to the end of the array

Definition at line 777 of file cpptoml.h.

                                                  {
    if(values_.empty() || values_[0]->is_array()) {
      values_.push_back(val);
    } else {
      THROW_(array_exception, "Arrays must be homogenous.");
    }
  }

◆ push_back() [2/3]

template<class T >

void cpptoml::array::push_back ( const std::shared_ptr< value< T > > & val )

inline

Add a value to the end of the array

Definition at line 766 of file cpptoml.h.

                                                     {
    if(values_.empty() || values_[0]->as<T>()) {
      values_.push_back(val);
    } else {
      THROW_(array_exception, "Arrays must be homogenous.");
    }
  }

◆ push_back() [3/3]

template<class T >

void cpptoml::array::push_back	(	T &&	val,
		typename value_traits< T >::type *	= `0`
	)

inline

Convenience function for adding a simple element to the end of the array.

Definition at line 790 of file cpptoml.h.

                                                             {
    push_back(make_value(std::forward<T>(val)));
  }

◆ reserve()

void cpptoml::array::reserve ( size_type n )

inline

Reserve space for n values.

Definition at line 838 of file cpptoml.h.

838{ values_.reserve(n); }

Friends And Related Function Documentation

◆ make_array

std::shared_ptr< array > make_array ( )

friend

Definition at line 873 of file cpptoml.h.

                                         {
#if not defined(MAIA_INTEL_COMPILER)
  struct make_shared_enabler : public array {
    make_shared_enabler() = default;
  };
 
  return std::make_shared<make_shared_enabler>();
#else
  return std::make_shared<ARRAY_::make_shared_enabler>();
#endif
}

Member Data Documentation

◆ values_

std::vector<std::shared_ptr<base> > cpptoml::array::values_

private

Definition at line 861 of file cpptoml.h.

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

/home/gitlab-runner/scratch/builds/oxpnswJ6/1/aia/m-AIA/m-AIA/src/IO/cpptoml.h

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ iterator

◆ size_type

Constructor & Destructor Documentation

◆ array() [1/4]

◆ array() [2/4]

◆ array() [3/4]

◆ array() [4/4]

Member Function Documentation

◆ array_of()

◆ at()

◆ begin() [1/2]

◆ begin() [2/2]

◆ clear()

◆ clone()

◆ end() [1/2]

◆ end() [2/2]

◆ erase()

◆ get() [1/2]

◆ get() [2/2]

◆ get_array_of() [1/2]

◆ get_array_of() [2/2]

◆ insert() [1/3]

◆ insert() [2/3]

◆ insert() [3/3]

◆ is_array()

◆ nested_array()

◆ operator=()

◆ push_back() [1/3]

◆ push_back() [2/3]

◆ push_back() [3/3]

◆ reserve()

Friends And Related Function Documentation

◆ make_array

Member Data Documentation

◆ values_