CIP JAVA documentation for class "com.ptc.wfc.wfcElementTree.Element"

Interface Element

package com.ptc.wfc.wfcElementTree; public interface Element extends jxobject

Description

Method Summary
`/optional/ Elements`	`GetChildren ()` Get method for attribute "Children" An array of child elements.
`/optional/ Integer`	`GetDecimals ()` Get method for attribute "Decimals"
`/optional/ ElementDiagnostics`	`GetDiagnostics ()` Get method for attribute "Diagnostics" A list of the element diagnostics for the element.
`/optional/ Ray`	`GetDirection ()` Get method for attribute "Direction" Direction specified by the element.
`/optional/ Collection`	`GetElemCollection ()` Get method for attribute "ElemCollection" The `Collection` object.
`int`	`GetId ()` Get method for attribute "Id" Identifier of the Element.
`String`	`GetIdAsString ()` Get method for attribute "IdAsString" String representation of element Id.
`boolean`	`GetIsArray ()` Get method for attribute "IsArray" Determines whether the specified element contains an array of elements.
`boolean`	`GetIsCompound ()` Get method for attribute "IsCompound" Determines whether the specified element is compound.
`boolean`	`GetIsMultival ()` Get method for attribute "IsMultival" Determines whether the specified element is multivalued.
`int`	`GetLevel ()` Get method for attribute "Level" The level at which the element is located in the element tree with respect to the root element.
`/optional/ Selections`	`GetSelections ()` Get method for attribute "Selections"
`/optional/ SpecialValue`	`GetSpecialValueElem ()` Get method for attribute "SpecialValueElem" The special value element.
`/optional/ ArgValue`	`GetValue ()` Get method for attribute "Value" Value of the element.
`/optional/ String`	`GetValueAsString ()` Get method for attribute "ValueAsString" String representation of value of double and integer elements. You must set compatible options using `ElementWstringOption` object
`void`	`SetDecimals ( /optional/ Integer value)` Set method for attribute "Decimals"
`void`	`SetElemCollection ( /optional/ Collection value)` Set method for attribute "ElemCollection" The `Collection` object.
`void`	`SetId (int value)` Set method for attribute "Id" Identifier of the Element.
`void`	`SetLevel (int value)` Set method for attribute "Level" The level at which the element is located in the element tree with respect to the root element.
`void`	`SetSelections ( /optional/ Selections value)` Set method for attribute "Selections"
`void`	`SetSpecialValueElem ( /optional/ SpecialValue value)` Set method for attribute "SpecialValueElem" The special value element.
`void`	`SetValue ( /optional/ ArgValue value)` Set method for attribute "Value" Value of the element.
`void`	`SetValueAsString ( /optional/ String value)` Set method for attribute "ValueAsString" String representation of value of double and integer elements. You must set compatible options using `ElementWstringOption` object

Method Detail

GetValue/SetValue

`/optional/ ArgValue`	`GetValue`	`()`
`void`	`SetValue`	`( /optional/ ArgValue 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

GetId/SetId

`int`	`GetId`	`()`
`void`	`SetId`	`(int 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

GetLevel/SetLevel

`int`	`GetLevel`	`()`
`void`	`SetLevel`	`(int 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

GetDecimals/SetDecimals

`/optional/ Integer`	`GetDecimals`	`()`
`void`	`SetDecimals`	`( /optional/ Integer value)`

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

GetSpecialValueElem/SetSpecialValueElem

`/optional/ SpecialValue`	`GetSpecialValueElem`	`()`
`void`	`SetSpecialValueElem`	`( /optional/ SpecialValue 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

GetElemCollection/SetElemCollection

`/optional/ Collection`	`GetElemCollection`	`()`
`void`	`SetElemCollection`	`( /optional/ Collection value)`

The Collection 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

GetSelections/SetSelections

`/optional/ Selections`	`GetSelections`	`()`
`void`	`SetSelections`	`( /optional/ Selections value)`

GetDiagnostics

/*optional*/ ElementDiagnostics 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

GetValueAsString/SetValueAsString

`/optional/ String`	`GetValueAsString`	`()`
`void`	`SetValueAsString`	`( /optional/ String value)`

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

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

GetIdAsString

String GetIdAsString ()

String representation of element Id.

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

GetIsArray

boolean GetIsArray ()

Determines whether the specified element contains an array of elements.

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

GetIsCompound

boolean GetIsCompound ()

Determines whether the specified element is compound.

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

GetIsMultival

boolean GetIsMultival ()

Determines whether the specified element is multivalued.

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

GetChildren

/*optional*/ Elements 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

GetDirection

/*optional*/ Ray GetDirection ()

Direction specified by the element.

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