command_sch_export_bom.h File Reference

#include "command_pcb_export_base.h"

Go to the source code of this file.

Classes
class	CLI::SCH_EXPORT_BOM_COMMAND

Namespaces
namespace	CLI

Macros
#define	ARG_PRESET   "--preset"
#define	ARG_PRESET_DESC   "Use a named BOM preset setting from the schematic, e.g. \"Grouped By Value\"."
#define	ARG_FMT_PRESET   "--format-preset"
#define	ARG_FMT_PRESET_DESC   "Use a named BOM format preset setting from the schematic, e.g. CSV."
#define	ARG_FIELD_DELIMITER   "--field-delimiter"
#define	ARG_FIELD_DELIMITER_DESC   "Separator between output fields/columns."
#define	ARG_STRING_DELIMITER   "--string-delimiter"
#define	ARG_STRING_DELIMITER_DESC   "Character to surround fields with."
#define	ARG_REF_DELIMITER   "--ref-delimiter"
#define	ARG_REF_DELIMITER_DESC   "Character to place between individual references."
#define	ARG_REF_RANGE_DELIMITER   "--ref-range-delimiter"
#define	ARG_REF_RANGE_DELIMITER_DESC   "Character to place in ranges of references. Leave blank for no ranges."
#define	ARG_KEEP_TABS   "--keep-tabs"
#define	ARG_KEEP_TABS_DESC   "Keep tab characters from input fields. Stripped by default."
#define	ARG_KEEP_LINE_BREAKS   "--keep-line-breaks"
#define	ARG_KEEP_LINE_BREAKS_DESC   "Keep line break characters from input fields. Stripped by default."
#define	ARG_FIELDS   "--fields"
#define	ARG_FIELDS_DESC   "An ordered list of fields to export. See documentation for special substitutions."
#define	ARG_LABELS   "--labels"
#define	ARG_LABELS_DESC   "An ordered list of labels to apply the exported fields."
#define	ARG_GROUP_BY   "--group-by"
#define	ARG_GROUP_BY_DESC   "Fields to group references by when field values match."
#define	ARG_SORT_FIELD   "--sort-field"
#define	ARG_SORT_FIELD_DESC   "Field name to sort by."
#define	ARG_SORT_ASC   "--sort-asc"
#define	ARG_SORT_ASC_DESC   "Sort ascending (true) or descending (false)."
#define	ARG_FILTER   "--filter"
#define	ARG_FILTER_DESC   "Filter string to remove output lines."
#define	ARG_EXCLUDE_DNP   "--exclude-dnp"
#define	ARG_EXCLUDE_DNP_DESC   "Exclude symbols marked Do-Not-Populate."
#define	DEPRECATED_ARG_INCLUDE_EXCLUDED_FROM_BOM   "--include-excluded-from-bom"
#define	DEPRECATED_ARG_INCLUDE_EXCLUDED_FROM_BOM_DESC   "Deprecated. Has no effect."
#define	DEPRECATED_ARG_INCLUDE_EXCLUDED_FROM_BOM_WARNING

Macro Definition Documentation

ARG_EXCLUDE_DNP

#define ARG_EXCLUDE_DNP   "--exclude-dnp"

Definition at line 73 of file command_sch_export_bom.h.

ARG_EXCLUDE_DNP_DESC

#define ARG_EXCLUDE_DNP_DESC   "Exclude symbols marked Do-Not-Populate."

Definition at line 74 of file command_sch_export_bom.h.

Referenced by CLI::SCH_EXPORT_BOM_COMMAND::SCH_EXPORT_BOM_COMMAND().

ARG_FIELD_DELIMITER

#define ARG_FIELD_DELIMITER   "--field-delimiter"

Definition at line 36 of file command_sch_export_bom.h.

Referenced by CLI::SCH_EXPORT_BOM_COMMAND::doPerform(), and CLI::SCH_EXPORT_BOM_COMMAND::SCH_EXPORT_BOM_COMMAND().

ARG_FIELD_DELIMITER_DESC

#define ARG_FIELD_DELIMITER_DESC   "Separator between output fields/columns."

Definition at line 37 of file command_sch_export_bom.h.

Referenced by CLI::SCH_EXPORT_BOM_COMMAND::SCH_EXPORT_BOM_COMMAND().

ARG_FIELDS

#define ARG_FIELDS   "--fields"

Definition at line 55 of file command_sch_export_bom.h.

Referenced by CLI::SCH_EXPORT_BOM_COMMAND::doPerform(), and CLI::SCH_EXPORT_BOM_COMMAND::SCH_EXPORT_BOM_COMMAND().

ARG_FIELDS_DESC

#define ARG_FIELDS_DESC   "An ordered list of fields to export. See documentation for special substitutions."

Definition at line 56 of file command_sch_export_bom.h.

Referenced by CLI::SCH_EXPORT_BOM_COMMAND::SCH_EXPORT_BOM_COMMAND().

ARG_FILTER

#define ARG_FILTER   "--filter"

Definition at line 70 of file command_sch_export_bom.h.

Referenced by CLI::SCH_EXPORT_BOM_COMMAND::doPerform(), and CLI::SCH_EXPORT_BOM_COMMAND::SCH_EXPORT_BOM_COMMAND().

ARG_FILTER_DESC

#define ARG_FILTER_DESC   "Filter string to remove output lines."

Definition at line 71 of file command_sch_export_bom.h.

Referenced by CLI::SCH_EXPORT_BOM_COMMAND::SCH_EXPORT_BOM_COMMAND().

ARG_FMT_PRESET

#define ARG_FMT_PRESET   "--format-preset"

Definition at line 32 of file command_sch_export_bom.h.

Referenced by CLI::SCH_EXPORT_BOM_COMMAND::doPerform(), and CLI::SCH_EXPORT_BOM_COMMAND::SCH_EXPORT_BOM_COMMAND().

ARG_FMT_PRESET_DESC

#define ARG_FMT_PRESET_DESC   "Use a named BOM format preset setting from the schematic, e.g. CSV."

Definition at line 33 of file command_sch_export_bom.h.

Referenced by CLI::SCH_EXPORT_BOM_COMMAND::SCH_EXPORT_BOM_COMMAND().

ARG_GROUP_BY

#define ARG_GROUP_BY   "--group-by"

Definition at line 61 of file command_sch_export_bom.h.

Referenced by CLI::SCH_EXPORT_BOM_COMMAND::doPerform(), and CLI::SCH_EXPORT_BOM_COMMAND::SCH_EXPORT_BOM_COMMAND().

ARG_GROUP_BY_DESC

#define ARG_GROUP_BY_DESC   "Fields to group references by when field values match."

Definition at line 62 of file command_sch_export_bom.h.

Referenced by CLI::SCH_EXPORT_BOM_COMMAND::SCH_EXPORT_BOM_COMMAND().

ARG_KEEP_LINE_BREAKS

#define ARG_KEEP_LINE_BREAKS   "--keep-line-breaks"

Definition at line 51 of file command_sch_export_bom.h.

Referenced by CLI::SCH_EXPORT_BOM_COMMAND::doPerform(), and CLI::SCH_EXPORT_BOM_COMMAND::SCH_EXPORT_BOM_COMMAND().

ARG_KEEP_LINE_BREAKS_DESC

#define ARG_KEEP_LINE_BREAKS_DESC   "Keep line break characters from input fields. Stripped by default."

Definition at line 52 of file command_sch_export_bom.h.

Referenced by CLI::SCH_EXPORT_BOM_COMMAND::SCH_EXPORT_BOM_COMMAND().

ARG_KEEP_TABS

#define ARG_KEEP_TABS   "--keep-tabs"

Definition at line 48 of file command_sch_export_bom.h.

Referenced by CLI::SCH_EXPORT_BOM_COMMAND::doPerform(), and CLI::SCH_EXPORT_BOM_COMMAND::SCH_EXPORT_BOM_COMMAND().

ARG_KEEP_TABS_DESC

#define ARG_KEEP_TABS_DESC   "Keep tab characters from input fields. Stripped by default."

Definition at line 49 of file command_sch_export_bom.h.

Referenced by CLI::SCH_EXPORT_BOM_COMMAND::SCH_EXPORT_BOM_COMMAND().

ARG_LABELS

#define ARG_LABELS   "--labels"

Definition at line 58 of file command_sch_export_bom.h.

Referenced by CLI::SCH_EXPORT_BOM_COMMAND::doPerform(), and CLI::SCH_EXPORT_BOM_COMMAND::SCH_EXPORT_BOM_COMMAND().

ARG_LABELS_DESC

#define ARG_LABELS_DESC   "An ordered list of labels to apply the exported fields."

Definition at line 59 of file command_sch_export_bom.h.

Referenced by CLI::SCH_EXPORT_BOM_COMMAND::SCH_EXPORT_BOM_COMMAND().

ARG_PRESET

#define ARG_PRESET   "--preset"

Definition at line 29 of file command_sch_export_bom.h.

ARG_PRESET_DESC

#define ARG_PRESET_DESC   "Use a named BOM preset setting from the schematic, e.g. \"Grouped By Value\"."

Definition at line 30 of file command_sch_export_bom.h.

Referenced by CLI::SCH_EXPORT_BOM_COMMAND::SCH_EXPORT_BOM_COMMAND().

ARG_REF_DELIMITER

#define ARG_REF_DELIMITER   "--ref-delimiter"

Definition at line 42 of file command_sch_export_bom.h.

Referenced by CLI::SCH_EXPORT_BOM_COMMAND::doPerform(), and CLI::SCH_EXPORT_BOM_COMMAND::SCH_EXPORT_BOM_COMMAND().

ARG_REF_DELIMITER_DESC

#define ARG_REF_DELIMITER_DESC   "Character to place between individual references."

Definition at line 43 of file command_sch_export_bom.h.

Referenced by CLI::SCH_EXPORT_BOM_COMMAND::SCH_EXPORT_BOM_COMMAND().

ARG_REF_RANGE_DELIMITER

#define ARG_REF_RANGE_DELIMITER   "--ref-range-delimiter"

Definition at line 45 of file command_sch_export_bom.h.

Referenced by CLI::SCH_EXPORT_BOM_COMMAND::doPerform(), and CLI::SCH_EXPORT_BOM_COMMAND::SCH_EXPORT_BOM_COMMAND().

ARG_REF_RANGE_DELIMITER_DESC

#define ARG_REF_RANGE_DELIMITER_DESC   "Character to place in ranges of references. Leave blank for no ranges."

Definition at line 46 of file command_sch_export_bom.h.

Referenced by CLI::SCH_EXPORT_BOM_COMMAND::SCH_EXPORT_BOM_COMMAND().

ARG_SORT_ASC

#define ARG_SORT_ASC   "--sort-asc"

Definition at line 67 of file command_sch_export_bom.h.

Referenced by CLI::SCH_EXPORT_BOM_COMMAND::doPerform(), and CLI::SCH_EXPORT_BOM_COMMAND::SCH_EXPORT_BOM_COMMAND().

ARG_SORT_ASC_DESC

#define ARG_SORT_ASC_DESC   "Sort ascending (true) or descending (false)."

Definition at line 68 of file command_sch_export_bom.h.

Referenced by CLI::SCH_EXPORT_BOM_COMMAND::SCH_EXPORT_BOM_COMMAND().

ARG_SORT_FIELD

#define ARG_SORT_FIELD   "--sort-field"

Definition at line 64 of file command_sch_export_bom.h.

Referenced by CLI::SCH_EXPORT_BOM_COMMAND::doPerform(), and CLI::SCH_EXPORT_BOM_COMMAND::SCH_EXPORT_BOM_COMMAND().

ARG_SORT_FIELD_DESC

#define ARG_SORT_FIELD_DESC   "Field name to sort by."

Definition at line 65 of file command_sch_export_bom.h.

Referenced by CLI::SCH_EXPORT_BOM_COMMAND::SCH_EXPORT_BOM_COMMAND().

ARG_STRING_DELIMITER

#define ARG_STRING_DELIMITER   "--string-delimiter"

Definition at line 39 of file command_sch_export_bom.h.

Referenced by CLI::SCH_EXPORT_BOM_COMMAND::doPerform(), and CLI::SCH_EXPORT_BOM_COMMAND::SCH_EXPORT_BOM_COMMAND().

ARG_STRING_DELIMITER_DESC

#define ARG_STRING_DELIMITER_DESC   "Character to surround fields with."

Definition at line 40 of file command_sch_export_bom.h.

Referenced by CLI::SCH_EXPORT_BOM_COMMAND::SCH_EXPORT_BOM_COMMAND().

DEPRECATED_ARG_INCLUDE_EXCLUDED_FROM_BOM

#define DEPRECATED_ARG_INCLUDE_EXCLUDED_FROM_BOM   "--include-excluded-from-bom"

Definition at line 76 of file command_sch_export_bom.h.

Referenced by CLI::SCH_EXPORT_BOM_COMMAND::doPerform(), and CLI::SCH_EXPORT_BOM_COMMAND::SCH_EXPORT_BOM_COMMAND().

DEPRECATED_ARG_INCLUDE_EXCLUDED_FROM_BOM_DESC

#define DEPRECATED_ARG_INCLUDE_EXCLUDED_FROM_BOM_DESC   "Deprecated. Has no effect."

Definition at line 77 of file command_sch_export_bom.h.

Referenced by CLI::SCH_EXPORT_BOM_COMMAND::SCH_EXPORT_BOM_COMMAND().

DEPRECATED_ARG_INCLUDE_EXCLUDED_FROM_BOM_WARNING

#define DEPRECATED_ARG_INCLUDE_EXCLUDED_FROM_BOM_WARNING

Value:

                                                         "--include-excluded-from-bom has been deprecated as of " \
                                                         "KiCad 10.0.0.  It will have no effect."

Definition at line 78 of file command_sch_export_bom.h.

Referenced by CLI::SCH_EXPORT_BOM_COMMAND::doPerform().