LcSettingC_Get_CC_API

LcSettingC - various functions to get data from a setting … More...

Collaboration diagram for LcSettingC_Get_CC_API:

Functions
LcSettingC *	cclcconfig::LcSettingC::GetElem (MK_I32 idx) const
	C++: LcSettingC* setting.GetElem(MK_I32 idx) → C-API This function fetches the element at the given index index in the setting setting, which must be an array, list, or group …
LcSettingC *	cclcconfig::LcSettingC::GetMember (MK_STRN name) const
	C++: LcSettingC* setting.GetMember(MK_STRN name) → C-API This function fetches the child setting named name from the group setting …
LcSettingC *	cclcconfig::LcSettingC::GetMember (const std::string &name) const
	C++: LcSettingC* setting.GetMember(MK_STRN name) → C-API This function fetches the child setting named name from the group setting …
MK_BOOL	cclcconfig::LcSettingC::GetBool () const
	C++: MK_BOOL setting.GetBool() → C-API These functions return the value of the given setting …
MK_BOOL	cclcconfig::LcSettingC::GetBoolElem (MK_I32 idx) const
	C++: MK_BOOL setting.GetBoolElem(MK_I32 idx) → C-API These functions return the value at the specified index index in the setting setting …
MK_DBL	cclcconfig::LcSettingC::GetFloat () const
	C++: MK_DBL setting.GetFloat() → C-API These functions return the value of the given setting …
MK_DBL	cclcconfig::LcSettingC::GetFloatElem (MK_I32 idx) const
	C++: MK_DBL setting.GetFloatElem(MK_I32 idx) → C-API These functions return the value at the specified index index in the setting setting …
LcConfigFormatE	cclcconfig::LcSettingC::GetFormat () const
	C++: LcConfigFormatE setting.GetFormat() → C-API These functions get and set the external format for the setting setting …
MK_I32	cclcconfig::LcSettingC::GetInt () const
	C++: MK_I32 setting.GetInt() → C-API These functions return the value of the given setting …
MK_I64	cclcconfig::LcSettingC::GetInt64 () const
	C++: MK_I64 setting.GetInt64() → C-API These functions return the value of the given setting …
MK_I64	cclcconfig::LcSettingC::GetInt64Elem (MK_I32 idx) const
	C++: MK_I64 setting.GetInt64Elem(MK_I32 idx) → C-API These functions return the value at the specified index index in the setting setting …
MK_I32	cclcconfig::LcSettingC::GetIntElem (MK_I32 idx) const
	C++: MK_I32 setting.GetIntElem(MK_I32 idx) → C-API These functions return the value at the specified index index in the setting setting …
MK_STRN	cclcconfig::LcSettingC::GetString () const
	C++: MK_STRN setting.GetString() → C-API These functions return the value of the given setting …
MK_STRN	cclcconfig::LcSettingC::GetStringElem (MK_I32 idx) const
	C++: MK_STRN setting.GetStringElem(MK_I32 idx) → C-API These functions return the value at the specified index index in the setting setting …

Detailed Description

LcSettingC - various functions to get data from a setting …

Function Documentation

GetBool()

MK_BOOL cclcconfig::LcSettingC::GetBool ( ) const

inline

C++: MK_BOOL setting.GetBool() → C-API
These functions return the value of the given setting …

Definition at line 140 of file LcSettingC_inline_cc.hh.

                                            {
    MK_UNUSED auto setting = getCFSN();
    MK_BOOL __retVal__L = LcSettingGetBool(setting);
    return __retVal__L;
  }

GetBoolElem()

MK_BOOL cclcconfig::LcSettingC::GetBoolElem ( MK_I32 idx ) const

inline

C++: MK_BOOL setting.GetBoolElem(MK_I32 idx) → C-API
These functions return the value at the specified index index in the setting setting …

Definition at line 147 of file LcSettingC_inline_cc.hh.

                                                          {
    MK_UNUSED auto setting = getCFSN();
    MK_BOOL __retVal__L = LcSettingGetBoolElem(setting, idx);
    return __retVal__L;
  }

GetElem()

LcSettingC * cclcconfig::LcSettingC::GetElem ( MK_I32 idx ) const

inline

C++: LcSettingC* setting.GetElem(MK_I32 idx) → C-API
This function fetches the element at the given index index in the setting setting, which must be an array, list, or group …

Definition at line 107 of file LcSettingC_inline_cc.hh.

                                                          {
    MK_UNUSED auto setting = getCFSN();
    LC_CFS __retVal__L = LcSettingGetElem(setting, idx);
    if (__retVal__L == NULL) {
      throw MkInitSoftError("LcSettingC::GetElem");
    }
    return LcSettingC::LcSettingC_ObjNew(MK_RT_CALL __retVal__L);
  }

GetFloat()

MK_DBL cclcconfig::LcSettingC::GetFloat ( ) const

inline

C++: MK_DBL setting.GetFloat() → C-API
These functions return the value of the given setting …

Definition at line 154 of file LcSettingC_inline_cc.hh.

                                            {
    MK_UNUSED auto setting = getCFSN();
    MK_DBL __retVal__L = LcSettingGetFloat(setting);
    return __retVal__L;
  }

GetFloatElem()

MK_DBL cclcconfig::LcSettingC::GetFloatElem ( MK_I32 idx ) const

inline

C++: MK_DBL setting.GetFloatElem(MK_I32 idx) → C-API
These functions return the value at the specified index index in the setting setting …

Definition at line 161 of file LcSettingC_inline_cc.hh.

                                                          {
    MK_UNUSED auto setting = getCFSN();
    MK_DBL __retVal__L = LcSettingGetFloatElem(setting, idx);
    return __retVal__L;
  }

GetFormat()

LcConfigFormatE cclcconfig::LcSettingC::GetFormat ( ) const

inline

C++: LcConfigFormatE setting.GetFormat() → C-API
These functions get and set the external format for the setting setting …

Definition at line 168 of file LcSettingC_inline_cc.hh.

                                                      {
    MK_UNUSED auto setting = getCFSN();
    enum LcConfigFormatE __retVal__L = LcSettingGetFormat(setting);
    return __retVal__L;
  }

GetInt()

MK_I32 cclcconfig::LcSettingC::GetInt ( ) const

inline

C++: MK_I32 setting.GetInt() → C-API
These functions return the value of the given setting …

Definition at line 175 of file LcSettingC_inline_cc.hh.

                                          {
    MK_UNUSED auto setting = getCFSN();
    MK_I32 __retVal__L = LcSettingGetInt(setting);
    return __retVal__L;
  }

GetInt64()

MK_I64 cclcconfig::LcSettingC::GetInt64 ( ) const

inline

C++: MK_I64 setting.GetInt64() → C-API
These functions return the value of the given setting …

Definition at line 182 of file LcSettingC_inline_cc.hh.

                                            {
    MK_UNUSED auto setting = getCFSN();
    MK_I64 __retVal__L = LcSettingGetInt64(setting);
    return __retVal__L;
  }

GetInt64Elem()

MK_I64 cclcconfig::LcSettingC::GetInt64Elem ( MK_I32 idx ) const

inline

C++: MK_I64 setting.GetInt64Elem(MK_I32 idx) → C-API
These functions return the value at the specified index index in the setting setting …

Definition at line 189 of file LcSettingC_inline_cc.hh.

                                                          {
    MK_UNUSED auto setting = getCFSN();
    MK_I64 __retVal__L = LcSettingGetInt64Elem(setting, idx);
    return __retVal__L;
  }

GetIntElem()

MK_I32 cclcconfig::LcSettingC::GetIntElem ( MK_I32 idx ) const

inline

C++: MK_I32 setting.GetIntElem(MK_I32 idx) → C-API
These functions return the value at the specified index index in the setting setting …

Definition at line 196 of file LcSettingC_inline_cc.hh.

                                                        {
    MK_UNUSED auto setting = getCFSN();
    MK_I32 __retVal__L = LcSettingGetIntElem(setting, idx);
    return __retVal__L;
  }

GetMember() [1/2]

LcSettingC * cclcconfig::LcSettingC::GetMember ( const std::string & name ) const

inline

C++: LcSettingC* setting.GetMember(MK_STRN name) → C-API
This function fetches the child setting named name from the group setting …

Definition at line 127 of file LcSettingC_inline_cc.hh.

                                                                       {
    MK_UNUSED auto setting = getCFSN();
    const MK_STRN name_hdl = name.c_str();
    LC_CFS __retVal__L = LcSettingGetMember(setting, name_hdl);
    if (__retVal__L == NULL) {
      throw MkInitSoftError("LcSettingC::GetMember");
    }
    return LcSettingC::LcSettingC_ObjNew(MK_RT_CALL __retVal__L);
  }

GetMember() [2/2]

LcSettingC * cclcconfig::LcSettingC::GetMember ( MK_STRN name ) const

inline

C++: LcSettingC* setting.GetMember(MK_STRN name) → C-API
This function fetches the child setting named name from the group setting …

Definition at line 117 of file LcSettingC_inline_cc.hh.

                                                              {
    MK_UNUSED auto setting = getCFSN();
    LC_CFS __retVal__L = LcSettingGetMember(setting, name);
    if (__retVal__L == NULL) {
      throw MkInitSoftError("LcSettingC::GetMember");
    }
    return LcSettingC::LcSettingC_ObjNew(MK_RT_CALL __retVal__L);
  }

GetString()

MK_STRN cclcconfig::LcSettingC::GetString ( ) const

inline

C++: MK_STRN setting.GetString() → C-API
These functions return the value of the given setting …

Definition at line 203 of file LcSettingC_inline_cc.hh.

                                              {
    MK_UNUSED auto setting = getCFSN();
    MK_STRN __retVal__L = LcSettingGetString(setting);
    return __retVal__L;
  }

GetStringElem()

MK_STRN cclcconfig::LcSettingC::GetStringElem ( MK_I32 idx ) const

inline

C++: MK_STRN setting.GetStringElem(MK_I32 idx) → C-API
These functions return the value at the specified index index in the setting setting …

Definition at line 210 of file LcSettingC_inline_cc.hh.

                                                            {
    MK_UNUSED auto setting = getCFSN();
    MK_STRN __retVal__L = LcSettingGetStringElem(setting, idx);
    return __retVal__L;
  }