Configuration of objects

You can read the information of ALL properties with one single request, using “-” in GI.monitor (see screenshot above), or an “empty” string in your own implementation.

C++/C#

If you set an empty string as property name (compare with GI.monitor → using “-”), the result will be a “Type_Config_<ObjectType>” (this is the base struct for the config-information of a certain object). GI.config will, depending on the object-ID, know the object-type.

To validate the estimated response, use “StructTypeID()” to compare with the result (see example code).

This example requested all property information form multiple Variable-Objects (→ number of Objects = Results.GetSize_Configs()) and “WithOptions” is set to TRUE. One element in the array of “Configs” is of type giconfig_ConfigAPI::CType_Config_Variable:

int cnt = Results.GetSize_Configs(); //all variable configs as an array of giconfig_ConfigAPI::CType_Base_ConfigWithOwner
for(int confIndex = 0; confIndex < cnt; confIndex++)
{
     giconfig_ConfigAPI::CType_Base_ConfigWithOwner result;
     Results.Get_Configs(confIndex, result); //the results are GInsXmlRpcValues
 
     //identify XmlRpcValue Result of "GetConfigs" of a Variable-Object with PropertyName = ""
     // -> compare structID of the result
     if (result.Get_Config().getStructTypeID().compare(giconfig_ConfigAPI::CType_Config_Variable::StructTypeID()) == 0)
     {
          giconfig_ConfigAPI::CType_Config_Variable value;
          result.Get_Config(value);
 
          //depending on the variable type, the result delivers valid/invalid structs for its elements
          //check valid elements with:
 
          if (value.Get_AnalogInput() != GInsXmlRpc::XmlRpcValue())  //check if valid
          {
               std::cout << "   -----> Analog Input found! " << std::endl;
               std::cout << "    Type: " << value.Get_AnalogInput().Get_Type().Get_Value().Get_Description() << std::endl;
 
               //if "WithOptions" is enabled, you can also read all possible type-options of this channel
               GInsXmlRpcStdAPI::CGIns_Edit_ElementSelectionList types;
	       value.Get_AnalogInput().Get_Type(types); 
	       for (int typeIndex = 0; typeIndex < types.GetSize_List(); typeIndex++)
	       {
			GInsXmlRpcStdAPI::CGIns_Base_ElementValue element;
			value.Get_AnalogInput().Get_Type().Get_List(typeIndex, element);
			std::cout << "       - " << element.Get_Description() << std::endl;
	       }
          }
          else if (value.Get_AnalogOutput() != GInsXmlRpc::XmlRpcValue())  //check if valid
          {
               std::cout << "   -----> Analog Output found! " << std::endl;
          }
          else if (value.Get_DigitalInput() != GInsXmlRpc::XmlRpcValue())  //check if valid
          {
               std::cout << "   -----> Digital Input found! " << std::endl;
          }
     }
}

To read all variable informations (also from “General” - see Type_config_variable), navigate through all sub-structs. Remember the path of the object-property elements for a quick access later.

To access a single property of an object directly, you need to set the “path” of the object-property as “PropertyName”. Example: reading the “Description” of a Variable-Object: as you can see in the API-description, this is an element in “Type_Config_Variable_General”. Based on the object type (respectively the object ID), GI.config already knows, that you are requesting a Variable-Information. The desired property (“Description”) is an element of the “General” information of this object type. So, the resulting “path” of this object property is General/Description.

To avoid using constant strings for the property names in your code, you can use the functions “ItemName_xxx()” of the strutcs, for example

	std::string PropertyName = giconfig_ConfigAPI::CType_Config_Variable::ItemName_General();
	PropertyName += "/";
	PropertyName += giconfig_ConfigAPI::CType_Config_Variable_General::ItemName_Description();

Again, similar as in the above example, iterate through the received array of “Configs” to get the requested information (“General/Description” of all Variables):

int cnt = Results.GetSize_Configs(); //all variable configs as an array of giconfig_ConfigAPI::CType_Base_ConfigWithOwner
for(int confIndex = 0; confIndex < cnt; confIndex++)
{
     giconfig_ConfigAPI::CType_Base_ConfigWithOwner result;
     Results.Get_Configs(confIndex, result); //the results are GInsXmlRpcValues
 
     //identify XmlRpcValue Struct-Type -> CGins_Edit_StringValue (see API-description for types)
     if (result.Get_Config().getStructTypeID().compare(GInsXmlRpcStdAPI::CGIns_Edit_StringValue::StructTypeID()) == 0)
     {
          GInsXmlRpcStdAPI::CGIns_Edit_StringValue value;
          result.Get_Config(value);
 
          std::cout << "VarName: " << value.Get_Value() << std::endl;
     }
}

When reading properties, you also have the possibility to read all available options for the selected property using the parameter “WithOptions = true” (and even “WithImages = true” - for connection diagrams for example - if available for the property):