glass3::util::iInput Interface Reference

The input data retrieval interface, used to provide input data to other parts of neic-glass3. More...

#include <inputinterface.h>

Inheritance diagram for glass3::util::iInput:

Collaboration diagram for glass3::util::iInput:

Public Member Functions
virtual std::shared_ptr< json::Object >	getInputData ()=0
	Get input data. More...
virtual int	getInputDataCount ()=0
	Get count of remaining input data. More...

Detailed Description

The input data retrieval interface, used to provide input data to other parts of neic-glass3.

The iInput interface is a class interface implemented by class that manages an input source for neic-glass three (such as an input file directory or a HazDevBroker topic). This interface provides a method for other classes in neic-glass3 to retrieve input messages via the getdata() function, and a method for querying the pending data via the dataCount() function.

Member Function Documentation

virtual std::shared_ptr<json::Object> glass3::util::iInput::getInputData ( )

pure virtual

Get input data.

This pure virtual function is implemented by a class to support retrieving input data managed by the class.

Returns

Returns a std::shared_ptr to a json::object containing the input data.

Implemented in glass3::input::Input.

virtual int glass3::util::iInput::getInputDataCount ( )

pure virtual

Get count of remaining input data.

This pure virtual function is implemented by a class to support retrieving the current count of the remaining input data managed by the class.

Returns

Returns an integer value containing the current count of remaining input data.

Implemented in glass3::input::Input.

---

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

• util/include/inputinterface.h