fwPeriphAddressSNMP.ctl File Reference

Functions

 _fwPeriphAddressSNMP_set (string dpe, dyn_anytype addressConfig, dyn_string &exceptionInfo)
 Internal function to setup the SNMP addressing.
 _fwPeriphAddressSNMP_get (string dpe, dyn_anytype &addressConfig, bool &isActive, dyn_string &exceptionInfo)
 Internal function to get the SNMP addressing.
 _fwPeriphAddressSNMP_delete (string dpe, dyn_string &exceptionInfo)
 Internal function to cleanup before deleting the SNMP _address and _distrib configs.
 fwPeriphAddressSNMP_check (dyn_anytype &addressConfig, dyn_string &exceptionInfo)
 Function to check SNMP address configurtion parameters before attempting to save them to the DP element.
 _fwPeriphAddressSNMP_initPanel (string dpe, dyn_string &exceptionInfo)
 _fwPeriphAddressSNMP_saveFromPanel (string dpe, dyn_string &exceptionInfo)
dyn_string _fwPeriphAddressSNMP_getPollGroups (string systemName="")
 _fwPeriphAddressSNMP_updatePanel ()
string fwPeriphAddressSNMP_dataTypeIntToString (int type)
int fwPeriphAddressSNMP_dataTypeStringToInt (string type)
 _fwPeriphAddressSNMP_showModeInPanel (int mode)
int _fwPeriphAddressSNMP_readModeFromPanel ()

Variables

const string fwPeriphAddress_TYPE_SNMP = "SNMP"
const unsigned fwPeriphAddress_SNMP_POLL_GROUP = 11
const unsigned fwPeriphAddress_SNMP_SUBINDEX = 12
const unsigned fwPeriphAddress_SNMP_AGENT_ID = 13
const unsigned fwPeriphAddress_SNMP_AGENT_VERSION = 14
const unsigned fwPeriphAddress_SNMP_OBJECT_SIZE = 14

Function Documentation

_fwPeriphAddressSNMP_set ( string  dpe,
dyn_anytype  addressConfig,
dyn_string &  exceptionInfo 
)

Internal function to setup the SNMP addressing.

Constraints
Should only be called from fwPeriphAddress_set
Parameters:
dpe Datapoint element to act on
addressConfig Address object is passed here:

  • addressConfig[FW_PARAMETER_FIELD_DRIVER] contains driver number
  • addressConfig[FW_PARAMETER_FIELD_ADDRESS] contains the SNMP OID (starting with "1.3.6.1")
  • addressConfig[FW_PARAMETER_FIELD_SUBINDEX] contains the subindex
  • addressConfig[FW_PARAMETER_FIELD_DATATYPE] contains the translation datatype
  • addressConfig[FW_PARAMETER_FIELD_COMMUNICATION] should be equal to fwPeriphAddress_TYPE_SNMP ("SNMP")
  • addressConfig[FW_PARAMETER_FIELD_MODE] contains the communication direction and type from the list:
    -- DPATTR_ADDR_MODE_INPUT_SPONT
    -- DPATTR_ADDR_MODE_INPUT_SQUERY
    -- DPATTR_ADDR_MODE_INPUT_POLL
    -- DPATTR_ADDR_MODE_IO_SQUERY
    -- DPATTR_ADDR_MODE_IO_POLL
    -- DPATTR_ADDR_MODE_OUTPUT_SINGLE
  • addressConfig[FW_PARAMETER_FIELD_ACTIVE] contains whether or not the address is active
  • addressConfig[fwPeriphAddress_SNMP_AGENT_ID] contains the WinCC OA ID number of the SNMP Agent
  • addressConfig[fwPeriphAddress_SNMP_AGENT_VERSION] is the SNMP agent version (V1/V2 or V3)
  • addressConfig[fwPeriphAddress_SNMP_POLL_GROUP] is the nameof the poll group DP
exceptionInfo Details of any errors are returned here
_fwPeriphAddressSNMP_get ( string  dpe,
dyn_anytype &  addressConfig,
bool &  isActive,
dyn_string &  exceptionInfo 
)

Internal function to get the SNMP addressing.

Constraints
Should only be called from fwPeriphAddress_get
Parameters:
dpe Datapoint element to read from
addressConfig Address object is returned here (configParameters). See description for addressConfig on _fwPeriphAddressSNMP_set()
isActive TRUE if address config is active, else FALSE
exceptionInfo Details of any errors are returned here
_fwPeriphAddressSNMP_delete ( string  dpe,
dyn_string &  exceptionInfo 
)

Internal function to cleanup before deleting the SNMP _address and _distrib configs.

Constraints
Should only be called from fwPeriphAddress_delete
This function currently does nothing because the SNMP addressing can be deleted by simply removing the _address and _distrib configs
Parameters:
dpe Datapoint element to read from
exceptionInfo Details of any errors are returned here
fwPeriphAddressSNMP_check ( dyn_anytype &  addressConfig,
dyn_string &  exceptionInfo 
)

Function to check SNMP address configurtion parameters before attempting to save them to the DP element.

Parameters:
addressConfig The address configuration object is passed here. In some cases, an amended (fixed) version may be returned here
exceptionInfo Details of errors in the address configuration are returned here
_fwPeriphAddressSNMP_initPanel ( string  dpe,
dyn_string &  exceptionInfo 
)
_fwPeriphAddressSNMP_saveFromPanel ( string  dpe,
dyn_string &  exceptionInfo 
)
dyn_string _fwPeriphAddressSNMP_getPollGroups ( string  systemName = ""  ) 
_fwPeriphAddressSNMP_updatePanel (  ) 
string fwPeriphAddressSNMP_dataTypeIntToString ( int  type  ) 
int fwPeriphAddressSNMP_dataTypeStringToInt ( string  type  ) 
_fwPeriphAddressSNMP_showModeInPanel ( int  mode  ) 
int _fwPeriphAddressSNMP_readModeFromPanel (  ) 

Variable Documentation

const string fwPeriphAddress_TYPE_SNMP = "SNMP"
const unsigned fwPeriphAddress_SNMP_POLL_GROUP = 11
const unsigned fwPeriphAddress_SNMP_SUBINDEX = 12
const unsigned fwPeriphAddress_SNMP_AGENT_ID = 13
const unsigned fwPeriphAddress_SNMP_OBJECT_SIZE = 14

Generated on 10 Dec 2015 for fwConfigs by  doxygen 1.6.1