Description

#include <COptionController.h>

Inheritance diagram for isys::COptionController:

Public Member Functions
SPOptionController	add ()
	Adds an element to the array and returns COptionController for it.

SPOptionController	at (size_t nIndex)
	Return COptionController for element at nIndex.

void	clear ()
	Removes all elements.

	COptionController (isys::ConnectionMgrSPtr connectionMgr, const std::string &rstrBaseURL)
	Instantiates object.

SPOptionController	find (const std::string &rstrOption, const std::string &rstrValue, bool bAllowEmptyForSingleElement=false)
	Returns COptionController for the element whose rstrOption has value rstrValue.

std::string	get (const std::string &rstrOption)
	Returns string value of rstrOption.

bool	get_bool (const std::string &rstrOption)
	Gets bool value of rstrOption.

int64_t	get_int (const std::string &rstrOption)
	Gets integer value of rstrOption.

uint64_t	get_uint (const std::string &rstrOption)
	Gets unsigned integer value of rstrOption.

int	index_of (const std::string &rstrOption, const std::string &rstrValue)
	Returns index of element whose element rstrOption has value rstrValue, or -1 if element is not found.

SPOptionController	opt (const std::string &rstrOption)
	Returns COptionController based on rstrOption (appended to the base URL).

void	remove (size_t nIndex)
	Removes element at nIndex.

void	set (const std::string &rstrOption, const std::string &rstrValue)
	Sets rstrValue to rstrOption (appended to the base URL).

void	set_bool (const std::string &rstrOption, bool bValue)
	Sets bValue to rstrOption.

void	set_int (const std::string &rstrOption, int64_t iValue)
	Sets iValue to rstrOption.

void	set_multi (const iconnect::StrStrMap &inParams)
	Sets multiple option values with one call.

void	set_uint (const std::string &rstrOption, uint64_t nValue)
	Sets nValue to rstrOption.

size_t	size ()
	Returns array size of this instance.

std::string	URL ()
	Returns full option URL of this instance.

Protected Member Functions
std::string	get_option_URL (std::string strBase, std::string_view strvOption) const
	Possible parameters if we want the return string to be for example "/IDE/Info.VerMajor".

std::string	get_option_URL (std::string_view strvOption) const
	See `COptionController::get_option_URL(std::string, std::string_view) const` examples for getting the right URL.

Static Protected Member Functions
static std::string	format_index (size_t nIndex)
	returns "[<index dec>]"

Constructor & Destructor Documentation

◆ COptionController()

isys::COptionController::COptionController	(	isys::ConnectionMgrSPtr	connectionMgr,
		const std::string &	rstrBaseURL )

Instantiates object.

Parameters

connectionMgr	class which maintains connection to winIDEA. Connection must be established before this call.
rstrBaseURL	configuration node URL, for example /IDE/Debug.DownloadFiles In winIDEA see Help->Display Option...

Member Function Documentation

◆ add()

SPOptionController isys::COptionController::add ( )

Adds an element to the array and returns COptionController for it.

Returns: COptionController instance

Exceptions

TException if this is not an array, or the array size is static

Python example: test_add_remove.py

◆ at()

SPOptionController isys::COptionController::at ( size_t nIndex )

Return COptionController for element at nIndex.

Parameters

nIndex element index

Returns: COptionController for element at index

Python example: test_at.py

◆ clear()

void isys::COptionController::clear ( )

Removes all elements.

Exceptions

TException if this is not an array, the array size is static

Python example: test_add_remove.py

◆ find()

SPOptionController isys::COptionController::find	(	const std::string &	rstrOption,
		const std::string &	rstrValue,
		bool	bAllowEmptyForSingleElement = false )

Returns COptionController for the element whose rstrOption has value rstrValue.

Parameters

rstrOption	option string which is appended to the base URL
rstrValue	option value
bAllowEmptyForSingleElement	if a single element is present, allow access with empty rstrValue

Returns: COptionController for the element found

Exceptions

TException if this is not an array, rstrOption is not a valid option, or the element is not found

Python example: test_find.py

◆ get()

std::string isys::COptionController::get ( const std::string & rstrOption )

Returns string value of rstrOption.

Parameters

rstrOption option string which is appended to the base URL

Returns: string value

Exceptions

TException if rstrOption is invalid

Python example: test_get_set.py

◆ get_bool()

bool isys::COptionController::get_bool ( const std::string & rstrOption )

Gets bool value of rstrOption.

Parameters

rstrOption option string which is appended to the base URL

Returns: bool value

Exceptions

TException if rstrOption is invalid, or type is not bool

Python example: test_get_set_bool.py

◆ get_int()

int64_t isys::COptionController::get_int ( const std::string & rstrOption )

Gets integer value of rstrOption.

Parameters

rstrOption option string which is appended to the base URL

Returns: int64_t value

Exceptions

TException if rstrOption is invalid, or type is not integer

Python example: test_get_set_int_uint.py

◆ get_option_URL()

std::string isys::COptionController::get_option_URL	(	std::string	strBase,
		std::string_view	strvOption ) const

protected

Possible parameters if we want the return string to be for example "/IDE/Info.VerMajor".

("" , "IDE/Info.VerMajor")
("/IDE/" , "Info.VerMajor")
("/IDE/Info", "VerMajor")

◆ get_uint()

uint64_t isys::COptionController::get_uint ( const std::string & rstrOption )

Gets unsigned integer value of rstrOption.

Parameters

rstrOption option string which is appended to the base URL

Returns: uint64_t value

Exceptions

TException if rstrOption is invalid, or type is not a positive integer

Python example: test_get_set_int_uint.py

◆ index_of()

int isys::COptionController::index_of	(	const std::string &	rstrOption,
		const std::string &	rstrValue )

Returns index of element whose element rstrOption has value rstrValue, or -1 if element is not found.

Parameters

rstrOption	option string which is appended to the base URL
rstrValue	option value

Returns: index if element exists, -1 otherwise

Exceptions

TException if this is not an array, or rstrOption is not an element name

Python example: test_index_of.py

◆ opt()

SPOptionController isys::COptionController::opt ( const std::string & rstrOption )

Returns COptionController based on rstrOption (appended to the base URL).

Parameters

rstrOption option string which is appended to the base URL

Returns: COptionController instance

Python example: test_opt.py

◆ remove()

void isys::COptionController::remove ( size_t nIndex )

Removes element at nIndex.

Parameters

nIndex element index

Exceptions

TException if this is not an array, the array size is static, or nIndex is out of array range

Python example: test_add_remove.py

◆ set()

void isys::COptionController::set	(	const std::string &	rstrOption,
		const std::string &	rstrValue )

Sets rstrValue to rstrOption (appended to the base URL).

Parameters

rstrOption	option string which is appended to the base URL
rstrValue	string value

Exceptions

TException if rstrOption is invalid

Python example: test_get_set.py

◆ set_bool()

void isys::COptionController::set_bool	(	const std::string &	rstrOption,
		bool	bValue )

Sets bValue to rstrOption.

Parameters

rstrOption	option string which is appended to the base URL
bValue	bool value

Exceptions

TException if rstrOption is invalid

Python example: test_get_set_bool.py

◆ set_int()

void isys::COptionController::set_int	(	const std::string &	rstrOption,
		int64_t	iValue )

Sets iValue to rstrOption.

Parameters

rstrOption	option string which is appended to the base URL
iValue	int64_t value

Exceptions

TException if rstrOption is invalid

Python example: test_get_set_int_uint.py

◆ set_multi()

void isys::COptionController::set_multi ( const iconnect::StrStrMap & inParams )

Sets multiple option values with one call.

Parameters

inParams map of string option value pairs

Note: Python and Java support Python mapping and Java Map as input type in addition to isystem.connect.StrStrMap. Examples:

Python: optCtrlApp0.set_multi({"Name": "MyApp", "SymbolFiles.DefaultFile": "0"});

Java:   optCtrlApp0.set_multi(Map.of("Name", "MyApp", "SymbolFiles.DefaultFile", "0"));

Python example: test_set_multi.py

◆ set_uint()

void isys::COptionController::set_uint	(	const std::string &	rstrOption,
		uint64_t	nValue )

Sets nValue to rstrOption.

Parameters

rstrOption	option string which is appended to the base URL
nValue	uint64_t value

Exceptions

TException if rstrOption is invalid

Python example: test_get_set_int_uint.py

◆ size()

size_t isys::COptionController::size ( )

Returns array size of this instance.

Returns: size of array

Exceptions

TException if this is not an array

Python example: test_size.py

◆ URL()

std::string isys::COptionController::URL ( )

Returns full option URL of this instance.

Returns: full option URL

Python example: test_url.py

Description

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Constructor & Destructor Documentation

◆ COptionController()

Member Function Documentation

◆ add()

◆ at()

◆ clear()

◆ find()

◆ get()

◆ get_bool()

◆ get_int()

◆ get_option_URL()

◆ get_uint()

◆ index_of()

◆ opt()

◆ remove()

◆ set()

◆ set_bool()

◆ set_int()

◆ set_multi()

◆ set_uint()

◆ size()

◆ URL()