Kanzi Connect 3.9.10
kanzi::connect::ArgumentDescription Class Reference

Represents an argument. More...

#include <generic_invoker.hpp>

Public Member Functions

 ArgumentDescription ()
 Constructor.
 
size_t count () const
 Amount of attribute elements.
 
string toBinary (size_t index=0) const
 Converts a contained value to a string.
 
bool toBool (size_t index=0) const
 Converts a contained value to a boolean.
 
float toFloat (size_t index=0) const
 Converts a contained value to a float.
 
int toInt (size_t index=0) const
 Converts a contained value to a integer.
 
string toString (size_t index=0) const
 Converts a contained value to a string.
 

Public Attributes

string m_name
 
string m_type
 
string m_value
 
vector< string > m_values
 
bool m_vector
 

Detailed Description

Represents an argument.

Constructor & Destructor Documentation

◆ ArgumentDescription()

kanzi::connect::ArgumentDescription::ArgumentDescription ( )

Constructor.

Member Function Documentation

◆ count()

size_t kanzi::connect::ArgumentDescription::count ( ) const

Amount of attribute elements.

Returns
amount of elements.

◆ toBinary()

string kanzi::connect::ArgumentDescription::toBinary ( size_t index = 0) const

Converts a contained value to a string.

Parameters
indexoptional index to vector in case argument holds multiple values.
Returns
string value

◆ toBool()

bool kanzi::connect::ArgumentDescription::toBool ( size_t index = 0) const

Converts a contained value to a boolean.

Parameters
indexoptional index to vector in case argument holds multiple values.
Returns
boolean value

◆ toFloat()

float kanzi::connect::ArgumentDescription::toFloat ( size_t index = 0) const

Converts a contained value to a float.

Parameters
indexoptional index to vector in case argument holds multiple values.
Returns
float value

◆ toInt()

int kanzi::connect::ArgumentDescription::toInt ( size_t index = 0) const

Converts a contained value to a integer.

Parameters
indexoptional index to vector in case argument holds multiple values.
Returns
integer value

◆ toString()

string kanzi::connect::ArgumentDescription::toString ( size_t index = 0) const

Converts a contained value to a string.

Parameters
indexoptional index to vector in case argument holds multiple values.
Returns
string value

Member Data Documentation

◆ m_name

string kanzi::connect::ArgumentDescription::m_name

◆ m_type

string kanzi::connect::ArgumentDescription::m_type

◆ m_value

string kanzi::connect::ArgumentDescription::m_value

◆ m_values

vector<string> kanzi::connect::ArgumentDescription::m_values

◆ m_vector

bool kanzi::connect::ArgumentDescription::m_vector

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