SpecsCpp::ISpecHasVariables Struct Reference

#include <API.h>

Inheritance diagram for SpecsCpp::ISpecHasVariables:

Public Member Functions
virtual	~ISpecHasVariables ()=default
virtual ISpecVariableCollection *	variables () const =0
ISpecVariableCollection *	vars () const
bool	has_var (const char *name) const
IVoidPointer *	var (const char *name) const
template<typename T >
T	var (const char *name) const
template<typename T >
T *	var (const char *name, T *value, bool destructable=true)
template<typename T >
void	var (const char *name, T &&value, bool destructable=true)
template<typename T >
T *	managed_var (const char *name, T *value)
template<typename T >
void	managed_var (const char *name, T &&value)
template<typename T >
T *	unmanaged_var (const char *name, T *value)
template<typename T >
void	unmanaged_var (const char *name, T &&value)
const char *	var_text (const char *name)
const char *	var_text (const char *name, const char *value)

Detailed Description

Definition at line 219 of file API.h.

Constructor & Destructor Documentation

~ISpecHasVariables()

virtual SpecsCpp::ISpecHasVariables::~ISpecHasVariables ( )

virtualdefault

Member Function Documentation

has_var()

bool SpecsCpp::ISpecHasVariables::has_var ( const char *  name ) const

inline

Definition at line 227 of file API.h.

{ return variables()->exists(name); }

Referenced by SpecsCpp::SpecVariableCollection::exists().

managed_var() [1/2]

template<typename T >

void SpecsCpp::ISpecHasVariables::managed_var ( const char *  name, T &&  value  )

inline

Definition at line 260 of file API.h.

                                                      {
            variables()->set(name, new VoidPointer<T>(new T(std::forward<T>(value))), true);
        }

managed_var() [2/2]

template<typename T >

T * SpecsCpp::ISpecHasVariables::managed_var ( const char *  name, T *  value  )

inline

Definition at line 254 of file API.h.

                                                   {
            variables()->set(name, new VoidPointer<T>(value), true);
            return value;
        }

unmanaged_var() [1/2]

template<typename T >

void SpecsCpp::ISpecHasVariables::unmanaged_var ( const char *  name, T &&  value  )

inline

Definition at line 271 of file API.h.

                                                        {
            variables()->set(name, new VoidPointer<T>(new T(std::forward<T>(value))), false);
        }

unmanaged_var() [2/2]

template<typename T >

T * SpecsCpp::ISpecHasVariables::unmanaged_var ( const char *  name, T *  value  )

inline

Definition at line 265 of file API.h.

                                                     {
            variables()->set(name, new VoidPointer<T>(value), false);
            return value;
        }

var() [1/4]

IVoidPointer * SpecsCpp::ISpecHasVariables::var ( const char *  name ) const

inline

Definition at line 229 of file API.h.

                                                  {
            if (!variables()->exists(name)) {
                _Log_("Variable '{}' does not exist", name);
                return nullptr;
            }
            return variables()->get(name);
        }

Referenced by SpecsCpp::SpecVariableCollection::get(), var(), and var_text().

var() [2/4]

template<typename T >

T SpecsCpp::ISpecHasVariables::var ( const char *  name ) const

inline

Definition at line 238 of file API.h.

                                      {
            return var(name)->as<T>();
        }

var() [3/4]

template<typename T >

void SpecsCpp::ISpecHasVariables::var ( const char *  name, T &&  value, bool  destructable = true  )

inline

Definition at line 249 of file API.h.

                                                                        {
            variables()->set(name, new VoidPointer<T>(new T(std::forward<T>(value))), destructable);
        }

var() [4/4]

template<typename T >

T * SpecsCpp::ISpecHasVariables::var ( const char *  name, T *  value, bool  destructable = true  )

inline

Definition at line 243 of file API.h.

                                                                     {
            variables()->set(name, new VoidPointer<T>(value), destructable);
            return value;
        }

var_text() [1/2]

const char * SpecsCpp::ISpecHasVariables::var_text ( const char *  name )

inline

Definition at line 275 of file API.h.

                                               {
            char* value = var(name)->as<char*>();
            return value ? value : nullptr;
        }

Referenced by var_text().

var_text() [2/2]

const char * SpecsCpp::ISpecHasVariables::var_text ( const char *  name, const char *  value  )

inline

Definition at line 280 of file API.h.

                                                                  {
            char* copy = new char[strlen(value) + 1];
 
#ifdef _WIN32
            strcpy_s(copy, strlen(value) + 1, value);
#else
            strcpy(copy, value);
#endif
 
            variables()->set(name, new VoidPointer<char>(copy));
            return var_text(name);
        }

variables()

virtual ISpecVariableCollection * SpecsCpp::ISpecHasVariables::variables ( ) const

pure virtual

Implemented in SpecsCpp::SpecGroup, and SpecsCpp::SpecTest.

Referenced by has_var(), managed_var(), managed_var(), unmanaged_var(), unmanaged_var(), var(), var(), var(), var_text(), and vars().

vars()

ISpecVariableCollection * SpecsCpp::ISpecHasVariables::vars ( ) const

inline

Definition at line 225 of file API.h.

{ return variables(); }

---

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

• Specs.API/include/Specs/API/Internal/Undocumented/API.h