OTest2
A C++ testing framework
Classes | Public Member Functions | List of all members
OTest2::UserData Class Reference

An object keeping user data passed from user's custom main function. More...

#include <userdata.h>

Classes

struct  Impl
 

Public Member Functions

 UserData (const UserData &)=delete
 
UserDataoperator= (const UserData &)=delete
 
 UserData ()
 Ctor. More...
 
 ~UserData ()
 Dtor. More...
 
template<typename Type_ >
void setDatum (const std::string &name_, Type_ *datum_)
 Set a user datum. More...
 
template<typename Type_ >
std::add_lvalue_reference< Type_ >::type getDatum (const std::string &name_) const
 Get user datum of specified type. More...
 

Detailed Description

An object keeping user data passed from user's custom main function.

Definition at line 120 of file userdata.h.

Constructor & Destructor Documentation

◆ UserData() [1/2]

OTest2::UserData::UserData ( const UserData )
delete

◆ UserData() [2/2]

OTest2::UserData::UserData ( )

Ctor.

Definition at line 108 of file userdata.cpp.

◆ ~UserData()

OTest2::UserData::~UserData ( )

Dtor.

Definition at line 113 of file userdata.cpp.

Member Function Documentation

◆ getDatum()

template<typename Type_ >
std::add_lvalue_reference<Type_>::type OTest2::UserData::getDatum ( const std::string &  name_) const
inline

Get user datum of specified type.

Template Parameters
Type_The requested type of the datum
Parameters
name_Name of the datum
Returns
Reference to the user datum value
Exceptions
UserDataMissingExceptionif the datum doesn't exist
UserDataWrongTypeExceptionif the requested type is different than the actual.

Definition at line 212 of file userdata.h.

◆ operator=()

UserData& OTest2::UserData::operator= ( const UserData )
delete

◆ setDatum()

template<typename Type_ >
void OTest2::UserData::setDatum ( const std::string &  name_,
Type_ *  datum_ 
)
inline

Set a user datum.

Parameters
name_Name of the datum.
datum_The actual datum. The ownership is not taken and the object must exist for the whole lifetime of this object.

Definition at line 195 of file userdata.h.


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