CIP C++ documentation for class "pfcExternalData"

Class pfcExternalData

# include <pfcExternal.h> class pfcExternalData : public xobject { xdeclare(pfcExternalData) ... }; This is a COMPACT class.

Description

A union class that represents a single data value that may be stored in external data. The type of the value is identified by the dicsriminator.

Identifies the data type (String, Double or Integer).

Manual References:: External Data: Retrieving External Data

Method Summary


`pfcExternalDataType`	`Getdiscr ()`
	Returns the union discriminant value.

`xreal`	`GetDoubleValue ()`
`void`	`SetDoubleValue (xreal value)`
	The double value.

`xint`	`GetIntegerValue ()`
`void`	`SetIntegerValue (xint value)`
	The integer value.

`xstring`	`GetStringValue ()`
`void`	`SetStringValue (xrstring value)`
	The string value.

Method Detail

pfcExternalDataType Getdiscr ()

Returns the union discriminant value.

`xint`	`GetIntegerValue`	`()`
`void`	`SetIntegerValue`	`(xint value)`

The integer value.

Exceptions thrown (but not limited to):

pfcXBadGetExternalData - Data is not an integer

Manual References:: External Data: Retrieving External Data, External Data: Retrieving External Data

`xreal`	`GetDoubleValue`	`()`
`void`	`SetDoubleValue`	`(xreal value)`

The double value.

Exceptions thrown (but not limited to):

pfcXBadGetExternalData - Data is not double

Manual References:: External Data: Retrieving External Data, External Data: Retrieving External Data

`xstring`	`GetStringValue`	`()`
`void`	`SetStringValue`	`(xrstring value)`

The string value.

Exceptions thrown (but not limited to):

pfcXBadGetExternalData - Data is not string

Manual References:: External Data: Retrieving External Data