MC_GrpReadParam

This function block reads the value of the specified group parameter.

Figure 8-163: MC_GrpReadParam

• 
  

• This function or function block returns cached data. See Programming a Dual Core Controller for more information.

Related FunctionA function calculates a result according to the current value of its inputs. A function has no internal data and is not linked to declared instances. Blocks

MC_GrpWriteParam, MC_ErrorDescription

Coordinated Motion, the top-level topic for Coordinated Motion.

Arguments

For more details on how inputs and outputs work, refer to PLCopenA vendor -and product- independent worldwide association active in Industrial Control and aiming at standardizing PLC file formats based on XML Function Blocks - General Rules.

Input

Enable	Description	If True, then request to read a value from the specified group parameter.
	Data Type	BOOL
	Range	0,1
	Unit	N/A
	Default	—
AxesGroupRef	Description	The axis group that the parameter value will be read from.
	Data Type	AXIS_GROUP_REF
	Range	N/A
	Unit	N/A
	Default	—
ParamNum	Description	Currently, only one parameter is supported: MC_GRP_PARAM_CIRCLE_TOLERANCE: (ID = 2000): The value read will be the axes group circle construction tolerance. See Axes Group Parameters for more information.
	Data Type	LREAL
	Range	See Axes Group Parameters
	Unit	LREAL
	Default	—

Output

Done	Description	If True, then the command completed successfully.
	Data Type	BOOL
Error	Description	If True, an error has occurred.
	Data Type	BOOL
ErrorID	Description	Indicates the error if Error output is set to TRUE. See the table in PLCopen Function BlockA function block groups an algorithm and a set of private data. It has inputs and outputs. ErrorID Output.
	Data Type	INT
ParamValue	Description	The value of the group parameter.
	Data Type	LREAL

Examples

ST

Inst_MC_GrpReadParam( DoEnable, Group1_ref, MC_GRP_PARAM_CIRCLE_TOLERANCE );       
CircleTolerance := Inst_MC_GrpReadParam.ParamValue;

FBD

FFLD

 [Top]