BOM_writer_traversal Struct Reference

#include <bomwriter.h>

Data Fields
int	bomset_max_lines
logical	emit_unselected_ancestors
int	filter_by_level
logical	grdvua
logical	no_descendants
logical	revid
int	selected_count
tag_t *	selected_lines
BOM_writer_struct	struct_type
int	sub_count
tag_t *	sub_lines
logical	transient_unpack
logical	unload_lines
tag_t *	unselected_ancestors
int	unselected_ancestors_count
logical	varuid

Detailed Description

Flags to control the overall traversal.

Note

This structure must be initialized by calling BOM_writer_new_traversal in order to ensure that all members are properly initialized.

Definition at line 583 of file bomwriter.h.

Field Documentation

int BOM_writer_traversal::bomset_max_lines

           Specifies the maximum number of lines that a BOMSet contains during BOM expansion 

when BOMSet is enabled or used.

Definition at line 618 of file bomwriter.h.

logical BOM_writer_traversal::emit_unselected_ancestors

  Set to true if the traversal should return a list of

ancestor lines that were emitted without being explicitly requested. Undefined behavior with 'flatten'.

Definition at line 604 of file bomwriter.h.

int BOM_writer_traversal::filter_by_level

            Filter by level when process BOM. The traverse and process will get stopped at the

specific level.

Definition at line 616 of file bomwriter.h.

logical BOM_writer_traversal::grdvua

                     Value of grdvua_on option of PLMXML format, indicates whether export user attributes 

for GRDVA in <Instance> element.

Definition at line 624 of file bomwriter.h.

logical BOM_writer_traversal::no_descendants

[false] - if true, you only want ancestors and selected lines reported

Definition at line 585 of file bomwriter.h.

logical BOM_writer_traversal::revid

                      Value of revid_off option of PLMXML format, indicates whether export item_revision_id 

of ItemRevision in PRV name attribute.

Definition at line 622 of file bomwriter.h.

int BOM_writer_traversal::selected_count

             Selected_count/selected_lines <br>
   0/NULL     - Default: selects just the root of the bomwindow. <br>
   0/non-NULL - selected_lines must be a #NULLTAG-terminated array. <br>

non-0/NULL - undefined behaviour. Don't do this.
non-0/non-NULL - selected_lines must be an array of tags, of length selected_count.

If you want to select no lines, not even the root line, you must supply a one-element list containing NULLTAG. You should supply count=1 if you do this, for a marginal speed saving.

Definition at line 586 of file bomwriter.h.

tag_t* BOM_writer_traversal::selected_lines

selected_count

Definition at line 595 of file bomwriter.h.

BOM_writer_struct BOM_writer_traversal::struct_type

Definition at line 584 of file bomwriter.h.

int BOM_writer_traversal::sub_count

                  Sub_count/sub_lines - cause the marking of a subselection of lines in a

format-defined way. Input behavior is similar to selected_count/lines, except that 0/NULL defaults to 'no subselection'.

Note

The behavior is undefined if sub_lines contains lines that do not appear in the final output file. (Typically, you will observe extraneous subancestors.)

Definition at line 609 of file bomwriter.h.

tag_t* BOM_writer_traversal::sub_lines

sub_count

Definition at line 615 of file bomwriter.h.

logical BOM_writer_traversal::transient_unpack

           Set to true if the traversal should unpack and repack

bomlines it encounters during traversal. This option adversely affects performance and may cause unnecessary display updates; its use should be avoided if possible.

Definition at line 600 of file bomwriter.h.

logical BOM_writer_traversal::unload_lines

               Try to save memory by partially unloading bomlines during traversal. 

This may only be used when the BOM Window being traversed is used exclusively owned by the caller. References to BOM Lines will become invalid. (Note: in v7, this was hard-wired 'true'. In v8, the default is 'false'.)

Definition at line 596 of file bomwriter.h.

tag_t* BOM_writer_traversal::unselected_ancestors

Definition at line 608 of file bomwriter.h.

int BOM_writer_traversal::unselected_ancestors_count

Definition at line 607 of file bomwriter.h.

logical BOM_writer_traversal::varuid

                     Value of varuid_on option of PLMXML format, indicates whether loading variant 

condition for BVRs.

Definition at line 620 of file bomwriter.h.

---

The documentation for this struct was generated from the following file:

• bom/bomwriter.h