openpine::CreateInstanceOptions Class Reference

Options for creating an Instance. More...

#include <instance.hpp>

Public Member Functions
	CreateInstanceOptions (const std::string &source, const std::string &timeframe, const std::string &symbol, const std::optional< std::string > &path=std::nullopt)
void	setBackgroundColor (uint32_t color)
	Sets the background color (0xAARRGGBB).
void	setLastInfo (const LastInfo &last_info)
	Sets last-bar info.
void	setDataProvider (DataProvider *provider)
	Injects a DataProvider.
void	setOutputMode (ffi::COutputMode mode)
	Sets the output mode.

Friends
class	Instance

Detailed Description

Options for creating an Instance.

Definition at line 184 of file instance.hpp.

Constructor & Destructor Documentation

CreateInstanceOptions()

openpine::CreateInstanceOptions::CreateInstanceOptions ( const std::string & source, const std::string & timeframe, const std::string & symbol, const std::optional< std::string > & path = std::nullopt )

inline

Definition at line 186 of file instance.hpp.

Member Function Documentation

setBackgroundColor()

void openpine::CreateInstanceOptions::setBackgroundColor ( uint32_t color )

inline

Sets the background color (0xAARRGGBB).

Definition at line 197 of file instance.hpp.

setDataProvider()

void openpine::CreateInstanceOptions::setDataProvider ( DataProvider * provider )

inline

Injects a DataProvider.

Parameters

provider

Must remain valid for the lifetime of the Instance.

Definition at line 206 of file instance.hpp.

setLastInfo()

void openpine::CreateInstanceOptions::setLastInfo ( const LastInfo & last_info )

inline

Sets last-bar info.

Definition at line 200 of file instance.hpp.

setOutputMode()

void openpine::CreateInstanceOptions::setOutputMode ( ffi::COutputMode mode )

inline

Sets the output mode.

Parameters

mode	ffi::COutputMode::Chart (default) or ffi::COutputMode::Stream.

Definition at line 213 of file instance.hpp.

Friends And Related Symbol Documentation

Instance

friend class Instance

friend

Definition at line 215 of file instance.hpp.

References Instance.

Referenced by Instance.

---

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

• cpp/include/instance.hpp