CIP C++ documentation for class "pfcUDFVariantDimension"

Class pfcUDFVariantDimension

# include <pfcUDFCreate.h> class pfcUDFVariantDimension : public virtual pfcUDFVariantValue { xdeclare(pfcUDFVariantDimension) ... }; This is a COMPACT class.

Description

This class specifies the value of the dimension name the user must supply to place the UDF.

Manual References:: Features: Creating a Custom UDF

Method Summary


`static pfcUDFVariantDimension_ptr`	`Create (xrstring Name, xreal DimensionValue)`
	Specifies the value of the dimension the user must supply to place the UDF.

`xreal`	`GetDimensionValue ()`
`void`	`SetDimensionValue (xreal value)`
	The dimension value.

Methods Inherited from Class pfcUDFVariantValue:: GetType, GetName, SetName

Method Detail

`xreal`	`GetDimensionValue`	`()`
`void`	`SetDimensionValue`	`(xreal value)`

The dimension value.

static pfcUDFVariantDimension_ptr Create (xrstring Name, xreal DimensionValue)

Specifies the value of the dimension the user must supply to place the UDF.

Used as a component of pfcUDFCustomCreateInstructions .

Manual References:: Features: Creating a Custom UDF, Features: Creating a Custom UDF

Parameters:

Name: The name given to the dimension by the UDF.
DimensionValue: The dimension value.

Returns:: Instance of the UDFVariantDimension object.