CIP C++ documentation for class "wfcElementTree"

Class wfcElementTree

# include <wfcElementTree.h> class wfcElementTree : public virtual pfcObject { xaideclare(wfcElementTree) ... };

Description

Method Summary


`void`	`CreateDtmCsysElemTreeFromFile (xrstring FileName)`


`wfcElement_ptr`	`GetElement (wfcElementPath_ptr Path)`
	Obtains the element from the element tree based on the element path.

`xbool`	`IsElementArray (wfcElementPath_ptr Path)`
	Returns true if the element is of array type.

`xbool`	`IsElementCompound (wfcElementPath_ptr Path)`
	Returns true if the element is a compound element.

`xbool`	`IsElementMultiVal (wfcElementPath_ptr Path)`
	Returns true if the element is a multi-valued element.

`wfcElements_ptr`	`ListTreeElements ()`
	Returns a sequence of elements.

`void`	`WriteElementTreeToFile (wfcElementTreeFormat Format, xrstring FileName)`
	Writes the element tree in the specified format

Method Detail

void WriteElementTreeToFile (wfcElementTreeFormat Format, xrstring FileName)

Writes the element tree in the specified format

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

Parameters:

Format
FileName

Returns:

wfcElements_ptr ListTreeElements ()

Returns a sequence of elements.

The elements are listed in the sequence as they appear in the element tree.

Exceptions thrown (but not limited to):

<reference 4 to unknown entity pfcExceptions::pfcXInAMethod>

Manual References:: Feature Element Tree: Feature Element Tree

Returns:

void CreateDtmCsysElemTreeFromFile (xrstring FileName)

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

Parameters:

FileName

Returns:

wfcElement_ptr GetElement (wfcElementPath_ptr Path)

Obtains the element from the element tree based on the element path.

Manual References:: Feature Element Tree: Feature Element Tree

Parameters:

Path

Returns:

xbool IsElementCompound (wfcElementPath_ptr Path)

Returns true if the element is a compound element.

Manual References:: Feature Element Tree: Feature Element Tree

Parameters:

Path

Returns:

xbool IsElementMultiVal (wfcElementPath_ptr Path)

Returns true if the element is a multi-valued element.

Manual References:: Feature Element Tree: Feature Element Tree

Parameters:

Path

Returns:

xbool IsElementArray (wfcElementPath_ptr Path)

Returns true if the element is of array type.

Manual References:: Feature Element Tree: Feature Element Tree

Parameters:

Path

Returns: