7.2.2 Analog Input Channel Types

Figure 22 shows the block diagram for an analog Input Channel.

Figure 22 – Analog RIO Input Channel Block Diagram
7.2.2.1 RioPaAnalogInputChannelType

The RioPaAnalogInputChannelType provides access to the data of an analog Rio Input Channel according to RIOforPA.

Table 32 – RioPaAnalogInputChannelType
Attribute Value
BrowseNameRioPaAnalogInputChannelType
IsAbstractFalse
References Node Class BrowseName DataType TypeDefinition Other
Subtype of the RioChannelType.
0:HasComponentVariableProcessValueRioPaAnalogProcessValueDataTypeRioPaAnalogProcessValueVariableTypeM, RO
0:HasComponentVariableSignalValue0:Double0:BaseAnalogTypeO, RO
0:HasComponentVariableModeRioChannelModeEnumeration0:BaseDataVariableTypeM, RO
0:HasComponentVariable ManualProcessValueRioAnalogDataType0:BaseDataVariableTypeO, RO
0:HasComponentVariableSimulationEnabled0:Boolean0:BaseDataVariableTypeM, RO
0:HasComponentVariableSimulationValueRioPaAnalogValueDataType0:BaseDataVariableTypeO, RO
0:HasComponentVariableConfigRioPaAnalogInputConfigDataTypeRioPaAnalogInputConfigVariableTypeM, RO
0:HasComponentMethodSetModeO
0:HasComponentMethodSetManualProcessValueO
0:HasComponentMethodSetSimulationO
0:HasComponentMethodSetSimulationValueO
Conformance Units
PNRIO Channel Objects

The ProcessValue Variable contains the current analog Input value for usage by a Controller.

The SignalValue Variable contains the input signal value obtained by reading the input signal through the signal coupling in the Transducer.

The Mode Variable contains the current mode of operation encoded as RioChannelModeEnumeration. If Mode has the Value MANUAL, the Value of the ManualProcessValue Variable shall be used as Process Value.

The ManualProcessValue Variable contains the value used as Process Value if the Mode Variable of the channel contains the Value MANUAL. The optional Variable is used for Devices according to the PA V3 profile and maps to the “manual out value” property defined by this profile.

The SimulationEnabled Variable contains True if the Value of the SimulationValue Variable shall be used as Process Value, otherwise False.

The SimulationValue Variable contains the value used as Process Value if the SimulationEnabled Variable contains the Value True.

The Config Variable contains the configuration properties available for the RIO Channel. See the definition of the RioPaAnalogInputConfigVariableType (see chapter 9.4.5).

7.2.2.2 SetMode Method

This Method sets the Value of the Mode Variable. The security constraints defined in chapter 6.7 apply.

Signature

	SetMode (
		[in] RioChannelModeEnumeration	 Mode
		);
	
Argument Description
ModeDesired content of the Mode Variable.

The Method Result Codes (defined in Call Service) are defined in Table 33.

Table 33 – Possible Method result codes
Result Code Description
GoodThe Method execution was successful.
Bad_UserAccessDeniedThe user has not the right to execute the Method.
Bad_NotSupportedThe Server is currently not able to perform the demanded mode change.
Bad_UnexpectedErrorThe Server is not able to execute the function because an unexpected error occurred. The Device might be temporarily unavailable or unreachable due to network failure.

If the Mode Variable has already the same Value as the argument, the Method shall do nothing and return Good as result code.

7.2.2.3 SetManualProcessValue Method

This Method sets the Value of the ManualProcessValue Variable. The security constraints defined in chapter 6.7 apply.

Signature

	SetManualProcessValue (
		[in] RioAnalogDataType		ManualProcessValue
		);
	
Argument Description
ManualProcessValueDesired Value of the ManualProcessValue Variable.

The Method Result Codes (defined in Call Service) are defined in Table 34.

Table 34 – Possible Method result codes
Result Code Description
GoodThe Method execution was successful.
Bad_UserAccessDeniedThe user has not the right to execute the Method.
Bad_InvalidArgumentThe Server is not able to apply the argument value. For instance, the Server might reject manual values not within the channels value bounds.
Bad_UnexpectedErrorThe Server is not able to execute the function because an unexpected error occurred. The Device might be temporarily unavailable or unreachable due to network failure.

If the ManualProcessValue Variable has already the same Value as the argument, the Method shall do nothing and return Good as result code.

7.2.2.4 SetSimulation Method

This Method sets the Value of the SimulationEnabled Variable to the desired value. The security constraints defined in chapter 6.7 apply.

Signature

	SetSimulation (
		[in] 0:Boolean 	SimulationEnabled
	);
	
Argument Description
SimulationEnabledDesired content of the SimulationEnabled Variable.

The Method Result Codes (defined in Call Service) are defined in Table 35.

Table 35 – Possible Method result codes
Result Code Description
GoodThe Method execution was successful.
Bad_UserAccessDeniedThe user has not the right to execute the Method.
Bad_NotSupportedThe Server is not able to change into target mode.
Bad_UnexpectedErrorThe Server is not able to execute the function because an unexpected error occurred. The Device might be temporarily unavailable or unreachable due to network failure.

If the SimulationEnabled Variable already has the Value of the argument, the Method shall do nothing and return Good as result code.

7.2.2.5 SetSimulationValue Method

This Method sets the Value of the SimulationValue Variable. The security constraints defined in chapter 6.7 apply.

Signature

	SetSimulationValue (
		[in] RioAnalogDataType		Value
		[in] 0:Byte		Qualifier
		);
	
Argument Description
ValueDesired content of the Value struct member of the SimulationValue Variable.
QualifierDesired content of the Qualifier struct member of the SimulationValue Variable.

The Method Result Codes (defined in Call Service) are defined in Table 36.

Table 36 – Possible Method result codes
Result Code Description
GoodThe Method execution was successful.
Bad_UserAccessDeniedThe user has not the right to execute the Method.
Bad_InvalidArgumentThe Server is not able to apply the argument value. For instance, the Server might reject simulation values not within the channels value bounds.
Bad_UnexpectedErrorThe Server is not able to execute the function because an unexpected error occurred. The Device might be temporarily unavailable or unreachable due to network failure.
7.2.2.6 RioFaAnalogInputChannelType

The RioFaAnalogInputChannelType provides access to the data of an analog RIO Input Channel according to RIOforFA.

Table 37 – RioFaAnalogInputChannelType
Attribute Value
BrowseNameRioFaAnalogInputChannelType
IsAbstractFalse
References Node Class BrowseName DataType TypeDefinition Other
Subtype of the RioChannelType.
0:HasComponentVariableProcessValueRioFaAnalogProcessValueDataTypeRioFaAnalogProcessValueVariableTypeM, RO
0:HasComponentVariableSignalValue0:Double0:BaseAnalogTypeO, RO
0:HasComponentVariableConfigRioFaAnalogInputConfigDataTypeRioFaAnalogInputConfigVariableTypeM, RO
Conformance Units
PNRIO Channel Objects

The ProcessValue Variable contains the current analog Input value for usage by a Controller.

The SignalValue Variable contains the input signal value obtained by reading the input signal through the signal coupling in the Transducer.

The Config Variable contains the configuration properties available for the RIO Channel. See the definition of the RioFaAnalogInputConfigVariableType (see chapter 9.4.6).