Compute Library
 21.02
Example Class Reference

Abstract Example class. More...

#include <Utils.h>

Public Member Functions

virtual bool do_setup (int argc, char **argv)
 Setup the example. More...
 
virtual void do_run ()
 Run the example. More...
 
virtual void do_teardown ()
 Teardown the example. More...
 
virtual ~Example ()=default
 Default destructor. More...
 

Detailed Description

Abstract Example class.

All examples have to inherit from this class.

Definition at line 78 of file Utils.h.

Constructor & Destructor Documentation

◆ ~Example()

virtual ~Example ( )
virtualdefault

Default destructor.

Member Function Documentation

◆ do_run()

virtual void do_run ( )
inlinevirtual

Run the example.

Definition at line 94 of file Utils.h.

94 {};

◆ do_setup()

virtual bool do_setup ( int  argc,
char **  argv 
)
inlinevirtual

Setup the example.

Parameters
[in]argcArgument count.
[in]argvArgument values.
Returns
True in case of no errors in setup else false

Definition at line 88 of file Utils.h.

References ARM_COMPUTE_UNUSED.

89  {
90  ARM_COMPUTE_UNUSED(argc, argv);
91  return true;
92  };
#define ARM_COMPUTE_UNUSED(...)
To avoid unused variables warnings.
Definition: Error.h:152

◆ do_teardown()

virtual void do_teardown ( )
inlinevirtual

Teardown the example.

Definition at line 96 of file Utils.h.

References arm_compute::utils::run_example().

96 {};

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