iv::mimics::OnlineVariables Class Reference

#include <OnlineVariables.hpp>

Classes
struct	DefaultValues
struct	Keys
struct	Sections

Public Member Functions
	OnlineVariables ()=default
	~OnlineVariables ()=default
	OnlineVariables (const OnlineVariables &)=default
	OnlineVariables (OnlineVariables &&)=default
OnlineVariables &	operator= (const OnlineVariables &)=default
OnlineVariables &	operator= (OnlineVariables &&)=default
bool	load (const iv::file::xml::node &nodeOnlineVariables)
bool	save (iv::file::xml::node &nodeOnlineVariables) const
void	addVariable (const std::shared_ptr< OnlineVariable > &variable)
std::weak_ptr< OnlineVariable >	getVariable (const iv::types::onlineVariableId &variableName) const
std::weak_ptr< OnlineVariable >	getVariable (uint64_t variableIndex) const
std::weak_ptr< OnlineVariable >	getVariableByParamExternalId (const iv::types::externalParameterOnlineId &paramOnlineExternalId) const
uint64_t	numVariables () const
const std::vector< std::shared_ptr< OnlineVariable > > &	getAllVariables () const
void	removeVariable (uint64_t variableIndex)
void	removeVariable (const iv::types::onlineVariableId &variableName)
bool	hasVariables () const
bool	uploadVariablesValues () const
bool	downloadVariablesValues () const
bool	allVariablesUploadedCorrectly () const

Public Attributes
std::vector< std::shared_ptr< OnlineVariable > >	m_variables

Constructor & Destructor Documentation

OnlineVariables() [1/3]

iv::mimics::OnlineVariables::OnlineVariables ( )

default

~OnlineVariables()

iv::mimics::OnlineVariables::~OnlineVariables ( )

default

OnlineVariables() [2/3]

iv::mimics::OnlineVariables::OnlineVariables ( const OnlineVariables & )

default

OnlineVariables() [3/3]

iv::mimics::OnlineVariables::OnlineVariables ( OnlineVariables && )

default

Member Function Documentation

addVariable()

void iv::mimics::OnlineVariables::addVariable

(

const std::shared_ptr< OnlineVariable > &

variable

)

allVariablesUploadedCorrectly()

bool iv::mimics::OnlineVariables::allVariablesUploadedCorrectly ( ) const

nodiscard

downloadVariablesValues()

bool iv::mimics::OnlineVariables::downloadVariablesValues

(

)

const

getAllVariables()

const std::vector< std::shared_ptr< OnlineVariable > > & iv::mimics::OnlineVariables::getAllVariables ( ) const

nodiscard

getVariable() [1/2]

std::weak_ptr< OnlineVariable > iv::mimics::OnlineVariables::getVariable ( const iv::types::onlineVariableId & variableName ) const

nodiscard

getVariable() [2/2]

std::weak_ptr< OnlineVariable > iv::mimics::OnlineVariables::getVariable ( uint64_t variableIndex ) const

nodiscard

getVariableByParamExternalId()

std::weak_ptr< OnlineVariable > iv::mimics::OnlineVariables::getVariableByParamExternalId ( const iv::types::externalParameterOnlineId & paramOnlineExternalId ) const

nodiscard

hasVariables()

bool iv::mimics::OnlineVariables::hasVariables ( ) const

nodiscard

load()

bool iv::mimics::OnlineVariables::load

(

const iv::file::xml::node &

nodeOnlineVariables

)

numVariables()

uint64_t iv::mimics::OnlineVariables::numVariables ( ) const

nodiscard

operator=() [1/2]

OnlineVariables & iv::mimics::OnlineVariables::operator= ( const OnlineVariables & )

default

operator=() [2/2]

OnlineVariables & iv::mimics::OnlineVariables::operator= ( OnlineVariables && )

default

removeVariable() [1/2]

void iv::mimics::OnlineVariables::removeVariable

(

const iv::types::onlineVariableId &

variableName

)

removeVariable() [2/2]

void iv::mimics::OnlineVariables::removeVariable

(

uint64_t

variableIndex

)

save()

bool iv::mimics::OnlineVariables::save

(

iv::file::xml::node &

nodeOnlineVariables

)

const

uploadVariablesValues()

bool iv::mimics::OnlineVariables::uploadVariablesValues

(

)

const

Member Data Documentation

m_variables

std::vector<std::shared_ptr<OnlineVariable> > iv::mimics::OnlineVariables::m_variables

---

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

• src/mimics/OnlineVariables.hpp
• src/mimics/OnlineVariables.cpp