Members
FieldsTemplate
holds the template data for fields
should be KiCadXmlFilePath/fields.conf
- Source:
GroupTemplate
holds the template data for table group should be KiCadXmlFilePath/group.conf
- Source:
HeadersTemplate
holds the template data for table headers
should be KiCadXmlFilePath/headers.conf
- Source:
KiCadXmlFilePath
This is the project KiCad XML file to use to
extract the BOM information
- Source:
KiCadXMLRevision
Defines KiCad Revision number
- Source:
MinmumNumOfExpectedArguments
Defines the minimum number of arguments this plugins takes
- Source:
NumberOfUniqueParts
keep track of the number of unique parts found while
creating the BOM
- Source:
OutputFilePath
the path and file name to use to create the output BOM
- Source:
OutputHeader
holds the processed header data
- Source:
Path
Path is used to handle parsing system path urls
- Source:
PluginRevisionNumber
Defines the plugin revision number
- Source:
RowTemplate
holds the template data for table rows should be KiCadXmlFilePath/row.conf
- Source:
Template
holds the template data for main body template should be KiCadXmlFilePath/template.conf
- Source:
TemplateFolder
This is the path to the template files to use
when creating the BOM
- Source:
TotalNumberOfParts
keep track of the number of parts found while
creating the BOM
- Source:
UserProjectNetData
javascript object class of the KiCadXmlFilePath file
- Source:
Methods
ErrorMessage()
this function is used to make a standard format
for error messages.
this also handle exiting the program
- Source:
ExtractAndGenerateDataForThePart()
return the generated part table
- Source:
Returns:
the output
GenerateBOM()
This will generate the Bill of material based on the
template given
- Source:
GenerateTable(fieldsList, GroupedList, partGroupedList)
creates the table
Parameters:
| Name | Type | Description |
|---|---|---|
fieldsList |
the array that has all the various filed names | |
GroupedList |
the array that has all the parts grouped by the ref prefix | |
partGroupedList |
the array that actually contains all the parts data |
- Source:
Returns:
the output
GetArguments()
Handles getting the arguments pass to the plugin
- Source:
PathExist()
This function can be used to check if the given path
exist
- Source:
Returns:
true on success else false false
ReadFieldFile()
read fields.conf
- Source:
ReadGroupFile()
read group.conf
- Source:
ReadHeadersFile()
read headers.conf
- Source:
ReadRowFile()
read row.conf
- Source:
ReadTemplateFile()
read template.conf
- Source:
ReadXmlFile()
read the user KiCad file. This will also convert the
the xml data to javascript object.
- Source:
SearchUniquePartIndex(source, searchTerm, listOfGroups)
This will check the entire part list for a matching
value and fields and return the part's index number that matches
Parameters:
| Name | Type | Description |
|---|---|---|
source |
holds the original list of unsorted parts | |
searchTerm |
the part information to search for | |
listOfGroups |
holds the list of groups |
- Source:
Returns:
-1 = no match else the index number of the found item
Task()
Handles the machine state.
- Source: