CIP C++ documentation for class "wfcElement"

Class wfcElement

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

Description

Manual References:: Feature Element Tree: Overview of Feature Creation, Feature Element Tree: Feature Element Tree, Feature Element Tree: Feature Elements

Method Summary


`static wfcElement_ptr`	`Create (xint Id, optional pfcArgValue_ptr Value, xint Level)`
	Creates a new `wfcElement` object.

`optional wfcElements_ptr`	`GetChildren ()`
	An array of child elements.

`optional xint`	`GetDecimals ()`
`void`	`SetDecimals (optional xint value)`


`optional wfcElementDiagnostics_ptr`	`GetDiagnostics ()`
	A list of the element diagnostics for the element.

`optional wfcRay_ptr`	`GetDirection ()`
	Direction specified by the element.

`optional wfcCollection_ptr`	`GetElemCollection ()`
`void`	`SetElemCollection (optional wfcCollection_ptr value)`
	The `wfcCollection` object.

`xint`	`GetId ()`
`void`	`SetId (xint value)`
	Identifier of the Element.

`xstring`	`GetIdAsString ()`
	String representation of element Id.

`xbool`	`GetIsArray ()`
	Determines whether the specified element contains an array of elements.

`xbool`	`GetIsCompound ()`
	Determines whether the specified element is compound.

`xbool`	`GetIsMultival ()`
	Determines whether the specified element is multivalued.

`xint`	`GetLevel ()`
`void`	`SetLevel (xint value)`
	The level at which the element is located in the element tree with respect to the root element.

`optional pfcSelections_ptr`	`GetSelections ()`
`void`	`SetSelections (optional pfcSelections_ptr value)`


`optional wfcSpecialValue_ptr`	`GetSpecialValueElem ()`
`void`	`SetSpecialValueElem (optional wfcSpecialValue_ptr value)`
	The special value element.

`optional pfcArgValue_ptr`	`GetValue ()`
`void`	`SetValue (optional pfcArgValue_ptr value)`
	Value of the element.

`optional xstring`	`GetValueAsString ()`
`void`	`SetValueAsString (optional xrstring value)`
	String representation of value of double and integer elements. You must set compatible options using `wfcElementWstringOption` object

Method Detail

`optional pfcArgValue_ptr`	`GetValue`	`()`
`void`	`SetValue`	`(optional pfcArgValue_ptr value)`

Value of the element.

Manual References:: Feature Element Tree: Feature Element Values, Feature Element Tree: Feature Element Values, Feature Element Tree: Feature Element Values

`xint`	`GetId`	`()`
`void`	`SetId`	`(xint value)`

Identifier of the Element.

Manual References:: Feature Element Tree: Feature Elements, Feature Element Tree: Feature Elements, Feature Element Tree: Feature Elements, Feature Element Tree: Feature Elements

`xint`	`GetLevel`	`()`
`void`	`SetLevel`	`(xint value)`

The level at which the element is located in the element tree with respect to the root element.

Manual References:: Feature Element Tree: Feature Elements, Feature Element Tree: Feature Elements, Feature Element Tree: Feature Elements, Feature Element Tree: Feature Elements

`optional xint`	`GetDecimals`	`()`
`void`	`SetDecimals`	`(optional xint value)`

Manual References:: Feature Element Tree: Feature Elements, Feature Element Tree: Feature Elements, Feature Element Tree: Feature Elements, Feature Element Tree: Feature Elements

`optional wfcSpecialValue_ptr`	`GetSpecialValueElem`	`()`
`void`	`SetSpecialValueElem`	`(optional wfcSpecialValue_ptr value)`

The special value element.

Manual References:: Feature Element Tree: Feature Elements, Feature Element Tree: Feature Elements, Feature Element Tree: Feature Elements, Feature Element Tree: Feature Elements

`optional wfcCollection_ptr`	`GetElemCollection`	`()`
`void`	`SetElemCollection`	`(optional wfcCollection_ptr value)`

The wfcCollection object.

This will be populated only if the element is a collection.

Manual References:: Feature Element Tree: Feature Elements, Feature Element Tree: Feature Elements, Feature Element Tree: Feature Elements

`optional pfcSelections_ptr`	`GetSelections`	`()`
`void`	`SetSelections`	`(optional pfcSelections_ptr value)`

optional wfcElementDiagnostics_ptr GetDiagnostics ()

A list of the element diagnostics for the element.

These contain warnings and errors regarding the value of the element, within the context of the feature and remainder of the element tree.

Manual References:: Feature Element Tree: Element Diagnostics, Feature Element Tree: Element Diagnostics

`optional xstring`	`GetValueAsString`	`()`
`void`	`SetValueAsString`	`(optional xrstring value)`

String representation of value of double and integer elements. You must set compatible options using wfcElementWstringOption object

Manual References:: Feature Element Tree: Feature Elements, Feature Element Tree: Feature Elements, Feature Element Tree: Feature Elements

xstring GetIdAsString ()

String representation of element Id.

Manual References:: Feature Element Tree: Feature Elements, Feature Element Tree: Feature Elements

xbool GetIsArray ()

Determines whether the specified element contains an array of elements.

Manual References:: Feature Element Tree: Feature Elements, Feature Element Tree: Feature Elements

xbool GetIsCompound ()

Determines whether the specified element is compound.

Manual References:: Feature Element Tree: Feature Elements, Feature Element Tree: Feature Elements

xbool GetIsMultival ()

Determines whether the specified element is multivalued.

Manual References:: Feature Element Tree: Feature Elements, Feature Element Tree: Feature Elements

optional wfcElements_ptr GetChildren ()

An array of child elements.

This will be populated only if the element is a compound element or an array.

Manual References:: Feature Element Tree: Feature Elements, Feature Element Tree: Feature Elements

optional wfcRay_ptr GetDirection ()

Direction specified by the element.

This will be populated only if the element is a PRO_E_DIRECTION_COMPOUND element.

static wfcElement_ptr Create (xint Id, optional pfcArgValue_ptr Value, xint Level)

Creates a new wfcElement object.

See Also:: pfcCreateBoolArgValue(xbool), pfcCreateDoubleArgValue(xreal), pfcCreateIntArgValue(xint), pfcCreateSelectionArgValue(pfcSelection_ptr), pfcCreateStringArgValue(xrstring), pfcCreateTransformArgValue(pfcTransform3D_ptr)

Manual References:: Feature Element Tree: Feature Elements, Feature Element Tree: Feature Elements

Parameters:

Id: Identifier of the element.
To define the Feature Element Id, use values described in Creo Parametric TOOLKIT headers.
Value: Value of the element.
For Compound and Array elements pass null.
For Collection elements pass null value and then use method SetElemCollection()
For all other elements depending upon type use methods described in the section See Also
Level: Level at which the element is located in the element tree with respect to the root element. Level starts from 0.

Returns: