Class pfcArgValue

API Documentation > Interface Classes > Class pfcArgValue

Class pfcArgValue

# include <pfcArgument.h>

class pfcArgValue
: public xobject
{
xdeclare(pfcArgValue)
...
};
This is a COMPACT class.

Description

This interface represents an argument value, which may be one of several different types.

See Also:

pfcCreateASCIIStringArgValue(xrstring), pfcCreateBoolArgValue(xbool), pfcCreateDoubleArgValue(xreal), pfcCreateIntArgValue(xint), pfcCreateSelectionArgValue(pfcSelection_ptr), pfcCreateStringArgValue(xrstring), pfcCreateTransformArgValue(pfcTransform3D_ptr), pfcArgument::Create(xrstring, pfcArgValue_ptr)

Manual References:

Feature Element Values:pfcArgValue, Managing Application Arguments:pfcArgValue,

Method Summary

xstring	GetASCIIStringValue ()

void	SetASCIIStringValue (xrstring value)


	Used if the argument value contains a character string.
xbool	GetBoolValue ()

void	SetBoolValue (xbool value)


	Used if the argument value contains a boolean.
pfcArgValueType	Getdiscr ()


	Returns the union discriminant value.
xreal	GetDoubleValue ()

void	SetDoubleValue (xreal value)


	Used if the argument value contains a double.
xint	GetIntValue ()

void	SetIntValue (xint value)


	Used if the argument value contains an integer.
pfcSelection_ptr	GetSelectionValue ()

void	SetSelectionValue (pfcSelection_ptr value)


	Used if the argument value contains a Creo Parametric selection.
xstring	GetStringValue ()

void	SetStringValue (xrstring value)


	Used if the argument value contains a string.
pfcTransform3D_ptr	GetTransformValue ()

void	SetTransformValue (pfcTransform3D_ptr value)


	Used if the argument value contains a coordinate transformation.

Method Detail

pfcArgValueType

Getdiscr

()

Returns the union discriminant value.

xint	GetIntValue	()
void	SetIntValue	(xint value)

Used if the argument value contains an integer.

Exceptions thrown (but not limited to):

pfcXBadGetArgValue - Argument value does not contain an integer

Manual References:

Managing Application Arguments:GetIntValue

xreal	GetDoubleValue	()
void	SetDoubleValue	(xreal value)

Used if the argument value contains a double.

Exceptions thrown (but not limited to):

pfcXBadGetArgValue - Argument value does not contain a double

Manual References:

Managing Application Arguments:GetDoubleValue

xbool	GetBoolValue	()
void	SetBoolValue	(xbool value)

Used if the argument value contains a boolean.

Exceptions thrown (but not limited to):

pfcXBadGetArgValue - Argument value does not contain a boolean

Manual References:

Managing Application Arguments:GetBoolValue

xstring	GetASCIIStringValue	()
void	SetASCIIStringValue	(xrstring value)

Used if the argument value contains a character string.

Exceptions thrown (but not limited to):

pfcXBadGetArgValue - Argument value does not contain a character string

Manual References:

Managing Application Arguments:GetASCIIStringValue

xstring	GetStringValue	()
void	SetStringValue	(xrstring value)

Used if the argument value contains a string.

Exceptions thrown (but not limited to):

pfcXBadGetArgValue - Argument value does not contain a string

Manual References:

Managing Application Arguments:GetStringValue

pfcSelection_ptr	GetSelectionValue	()
void	SetSelectionValue	(pfcSelection_ptr value)

Used if the argument value contains a Creo Parametric selection.

Exceptions thrown (but not limited to):

pfcXBadGetArgValue - Argument value does not contain a Creo Parametric selection

Manual References:

Managing Application Arguments:GetSelectionValue

pfcTransform3D_ptr	GetTransformValue	()
void	SetTransformValue	(pfcTransform3D_ptr value)

Used if the argument value contains a coordinate transformation.

Exceptions thrown (but not limited to):

pfcXBadGetArgValue - Argument value does not contain a coordinate transformation

Manual References:

Managing Application Arguments:GetTransformValue

Was this helpful?