winIDEA SDK
|
FNet SPI configuration.
#include <CFNetCtrl.h>
Inherits isys::COptionFNetCfg.
Public Member Functions | |
void | set_enabled (const bool bEnabled) |
Enables the SPI. More... | |
void | set_operation (const bool bCSActiveHigh, const bool bSamplingOnSecondEdge, const bool bClockIdleHigh) |
Sets the config parameters. More... | |
void | set_name (const std::string &rstrName) |
Sets the name of the network. More... | |
void | add_description_file (const std::string &rstrPath) |
Sets a SPI Description File. More... | |
std::string | get_name () |
Get name. More... | |
std::string | URL () |
Returns full option URL of this instance. More... | |
SPOptionController | opt (const std::string &rstrOption) |
Returns COptionController based on rstrOption (appended to the base URL). More... | |
std::string | get (const std::string &rstrOption) |
Returns string value of rstrOption. More... | |
void | set (const std::string &rstrOption, const std::string &rstrValue) |
Sets rstrValue to rstrOption (appended to the base URL). More... | |
void | set_multi (const iconnect::StrStrMap &inParams) |
Sets multiple option values with one call. More... | |
void | set_bool (const std::string &rstrOption, bool bValue) |
Sets bValue to rstrOption. More... | |
bool | get_bool (const std::string &rstrOption) |
Gets bool value of rstrOption. More... | |
void | set_int (const std::string &rstrOption, int64_t iValue) |
Sets iValue to rstrOption. More... | |
int64_t | get_int (const std::string &rstrOption) |
Gets integer value of rstrOption. More... | |
void | set_uint (const std::string &rstrOption, uint64_t nValue) |
Sets nValue to rstrOption. More... | |
uint64_t | get_uint (const std::string &rstrOption) |
Gets unsigned integer value of rstrOption. More... | |
size_t | size () |
Returns array size of this instance. More... | |
SPOptionController | at (size_t nIndex) |
Return COptionController for element at nIndex. More... | |
SPOptionController | add () |
Adds an element to the array and returns COptionController for it. More... | |
void | clear () |
Removes all elements. More... | |
void | remove (size_t nIndex) |
Removes element at nIndex. More... | |
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. More... | |
SPOptionController | find (const std::string &rstrOption, const std::string &rstrValue) |
Returns COptionController for the element whose rstrOption has value rstrValue. More... | |
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". More... | |
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>]" | |
|
inherited |
Adds an element to the array and returns COptionController for it.
TException | if this is not an array, or the array size is static |
Python example: test_add_remove.py
void isys::COptionFNetSPICfg::add_description_file | ( | const std::string & | rstrPath | ) |
Sets a SPI Description File.
rstrPath | path to file |
|
inherited |
Return COptionController for element at nIndex.
nIndex | element index |
Python example: test_at.py
|
inherited |
Removes all elements.
TException | if this is not an array, the array size is static |
Python example: test_add_remove.py
|
inherited |
Returns COptionController for the element whose rstrOption has value rstrValue.
rstrOption | option string which is appended to the base URL |
rstrValue | option value |
TException | if this is not an array, rstrOption is not a valid option, or the element is not found |
Python example: test_find.py
|
inherited |
Returns string value of rstrOption.
rstrOption | option string which is appended to the base URL |
TException | if rstrOption is invalid |
Python example: test_get_set.py
|
inherited |
Gets bool value of rstrOption.
rstrOption | option string which is appended to the base URL |
TException | if rstrOption is invalid, or type is not bool |
Python example: test_get_set_bool.py
|
inherited |
Gets integer value of rstrOption.
rstrOption | option string which is appended to the base URL |
TException | if rstrOption is invalid, or type is not integer |
Python example: test_get_set_int_uint.py
std::string isys::COptionFNetSPICfg::get_name | ( | ) |
Get name.
|
protectedinherited |
Possible parameters if we want the return string to be for example "/IDE/Info.VerMajor".
|
inherited |
Gets unsigned integer value of rstrOption.
rstrOption | option string which is appended to the base URL |
TException | if rstrOption is invalid, or type is not a positive integer |
Python example: test_get_set_int_uint.py
|
inherited |
Returns index of element whose element rstrOption has value rstrValue, or -1 if element is not found.
rstrOption | option string which is appended to the base URL |
rstrValue | option value |
TException | if this is not an array, or rstrOption is not an element name |
Python example: test_index_of.py
|
inherited |
Returns COptionController based on rstrOption (appended to the base URL).
rstrOption | option string which is appended to the base URL |
Python example: test_opt.py
|
inherited |
Removes element at nIndex.
nIndex | element index |
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
|
inherited |
Sets rstrValue to rstrOption (appended to the base URL).
rstrOption | option string which is appended to the base URL |
rstrValue | string value |
TException | if rstrOption is invalid |
Python example: test_get_set.py
|
inherited |
Sets bValue to rstrOption.
rstrOption | option string which is appended to the base URL |
bValue | bool value |
TException | if rstrOption is invalid |
Python example: test_get_set_bool.py
void isys::COptionFNetSPICfg::set_enabled | ( | const bool | bEnabled | ) |
Enables the SPI.
bEnabled |
|
inherited |
Sets iValue to rstrOption.
rstrOption | option string which is appended to the base URL |
iValue | int64_t value |
TException | if rstrOption is invalid |
Python example: test_get_set_int_uint.py
|
inherited |
Sets multiple option values with one call.
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
void isys::COptionFNetSPICfg::set_name | ( | const std::string & | rstrName | ) |
Sets the name of the network.
rstrName | desired name |
void isys::COptionFNetSPICfg::set_operation | ( | const bool | bCSActiveHigh, |
const bool | bSamplingOnSecondEdge, | ||
const bool | bClockIdleHigh | ||
) |
Sets the config parameters.
bCSActiveHigh | true will set it to High, false to Low |
bSamplingOnSecondEdge | set to true for sampling on second edge, false for sampling on first edge |
bClockIdleHigh | true will set it to High, false to Low |
|
inherited |
Sets nValue to rstrOption.
rstrOption | option string which is appended to the base URL |
nValue | uint64_t value |
TException | if rstrOption is invalid |
Python example: test_get_set_int_uint.py
|
inherited |
Returns array size of this instance.
TException | if this is not an array |
Python example: test_size.py
|
inherited |