VICI  0.11.815
Visual Chart Interpreter
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Classes | Namespaces | Macros | Typedefs
discover.h File Reference

Provides the API for objects that need to be discoverable for testing. More...

#include "stringy.h"
#include <map>
#include <vector>
#include <memory>

Go to the source code of this file.

Classes

struct  VICI::cfi::DiscoverPointer
 Holds a pointer to a discoverable object. More...
 
class  VICI::cfi::Discoverable
 A mixin class that makes its owner discoverable. More...
 
class  VICI::cfi::DiscoveryMgr
 Manager for discoverable objects. More...
 

Namespaces

 VICI
 The namespace for the Visual Chart Interpreter project.
 
 VICI::cfi
 The namespace for the Common Facilities Infrastructure components.
 

Macros

#define DISCOVERABLE
 A macro which notifies the discovery manager of an object that is to be discoverable. More...
 

Typedefs

typedef std::shared_ptr
< DiscoverPointer > 
VICI::cfi::DiscoverSharedPointer
 A shared pointer that will be owned by a discoverable object.
 
typedef std::weak_ptr
< DiscoverPointer > 
VICI::cfi::DiscoverWeakPointer
 A weak pointer that will be held by the DiscoveryMgr.
 

Detailed Description

Provides the API for objects that need to be discoverable for testing.

This header should be included in the code for modules that need to be tested.

Macro Definition Documentation

#define DISCOVERABLE
Value:
VICI::cfi::DiscoveryMgr::instance().save( __PRETTY_FUNCTION__, \
(discover.reset( new VICI::cfi::DiscoverPointer( this )), discover) );
static DiscoveryMgr & instance()
Return a reference to the DiscoveryMgr.
Definition: discover.cpp:34
void save(const char *prettyName, DiscoverSharedPointer p)
Save a discoverable object.
Definition: discover.cpp:42
Holds a pointer to a discoverable object.
Definition: discover.h:52

A macro which notifies the discovery manager of an object that is to be discoverable.