AuxPort 0.2
Modules for Audio Software Development
Loading...
Searching...
No Matches
AuxPort::Case Class Reference

Represents a Test Case. More...

#include <AuxCase.h>

Inheritance diagram for AuxPort::Case:
AuxPort::ILog

Public Member Functions

 Case (const Case &testcase)=default
 
void setTestID (const std::string &testID)
 Sets the ID for Test Case.
 
void setTestName (const std::string &testName)
 Sets testcase name.
 
std::string & getTestID ()
 Returns the Test Case ID.
 
std::string & getTestName ()
 Returns the Test Case Name.
 
void Log () override
 Logs the details of the Test Case.
 

Public Attributes

std::function< bool(const std::vector< std::string > &commands)> testCase = 0
 Lambda Function that will be called to run the Test Case.
 

Additional Inherited Members

- Protected Member Functions inherited from AuxPort::ILog
void setColour (const ColourType &colourType)
 This function allows you to set text colour for the text to be printed onto the console.
 

Detailed Description

Represents a Test Case.

Definition at line 51 of file AuxCase.h.

Member Function Documentation

◆ getTestID()

std::string & AuxPort::Case::getTestID ( )

Returns the Test Case ID.

Definition at line 50 of file AuxCase.cpp.

◆ getTestName()

std::string & AuxPort::Case::getTestName ( )

Returns the Test Case Name.

Definition at line 55 of file AuxCase.cpp.

◆ Log()

void AuxPort::Case::Log ( )
overridevirtual

Logs the details of the Test Case.

Reimplemented from AuxPort::ILog.

Definition at line 60 of file AuxCase.cpp.

◆ setTestID()

void AuxPort::Case::setTestID ( const std::string & testID)

Sets the ID for Test Case.

Definition at line 40 of file AuxCase.cpp.

◆ setTestName()

void AuxPort::Case::setTestName ( const std::string & testName)

Sets testcase name.

Definition at line 45 of file AuxCase.cpp.

Member Data Documentation

◆ testCase

std::function<bool(const std::vector<std::string>& commands)> AuxPort::Case::testCase = 0

Lambda Function that will be called to run the Test Case.

Takes some commands as paramater, which can be used to provide some parameters to the module being tested.

Returns
Returns true if test succeeds, otherwise returns false

Definition at line 75 of file AuxCase.h.


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