Commit cbd4ee88 authored by Dick Hollenbeck's avatar Dick Hollenbeck

document LIB_TABLE better, extend scope of SCH namespace, and fix typos

parent cba930fe
...@@ -7,7 +7,7 @@ email address. ...@@ -7,7 +7,7 @@ email address.
2010-Dec-13 UPDATE Dick Hollenbeck <dick@softplc.com> 2010-Dec-13 UPDATE Dick Hollenbeck <dick@softplc.com>
================================================================================ ================================================================================
++eeschema: ++eeschema:
Committed a new design for a "Distributed Library Managment System". Committed a new design for a "Distributed Library System".
To make the html docs, run doxygen in <kicad_base>/new with that as your To make the html docs, run doxygen in <kicad_base>/new with that as your
current working directory, or run the shell script in there. You need current working directory, or run the shell script in there. You need
Doxygen installed. Doxygen installed.
......
namespace SCH {
/** @mainpage /** @mainpage
...@@ -392,8 +393,6 @@ struct PARSE_ERROR : public IO_ERROR ...@@ -392,8 +393,6 @@ struct PARSE_ERROR : public IO_ERROR
/** @} exception_types Exception Types */ /** @} exception_types Exception Types */
namespace SCH {
/** /**
* Class PART * Class PART
...@@ -433,12 +432,16 @@ protected: // not likely to have C++ descendants, but protected none-the-le ...@@ -433,12 +432,16 @@ protected: // not likely to have C++ descendants, but protected none-the-le
// 3 separate lists for speed: // 3 separate lists for speed:
/// A property list. /// A property list.
PROPERTIES properties;
/// A drawing list for graphics /// A drawing list for graphics
DRAWINGS drawings;
/// A pin list /// A pin list
PINS pins;
/// Alternate body forms. /// Alternate body forms.
ALTERNATES alternates;
// lots of other stuff, like the mandatory properties. // lots of other stuff, like the mandatory properties.
...@@ -692,7 +695,7 @@ protected: ///< derived classes must implement ...@@ -692,7 +695,7 @@ protected: ///< derived classes must implement
* to honor this portion of the API contract. * to honor this portion of the API contract.
* *
* @param aQuery is a string holding a domain specific query language expression. One candidate * @param aQuery is a string holding a domain specific query language expression. One candidate
* here is an s-expression that uses (and ..) and (or ..) operators and used them as RPN. For example * here is an s-expression that uses (and ..) and (or ..) operators and uses them as RPN. For example
* "(and (footprint 0805)(value 33ohm)(category passives))". * "(and (footprint 0805)(value 33ohm)(category passives))".
* The UI can shield the user from this if it wants. * The UI can shield the user from this if it wants.
* *
...@@ -1026,8 +1029,8 @@ public: ...@@ -1026,8 +1029,8 @@ public:
/** /**
* Function GetModel * Function GetModel
* returns a spreadsheet table model that allows both reading and writing to * returns a spreadsheet table model that allows both reading and writing to
* rows in a spreadsheet. The UI hold the actual screen widgets, but * rows in a spreadsheet. The UI holds the actual screen widgets, but
* the table model is this. * this is the table model, i.e. the PARTS_LIST is.
*/ */
SPREADSHEET_TABLE_MODEL* GetModel(); SPREADSHEET_TABLE_MODEL* GetModel();
}; };
...@@ -1104,6 +1107,21 @@ public: ...@@ -1104,6 +1107,21 @@ public:
*/ */
class LIB_TABLE class LIB_TABLE
{ {
public:
/**
* Constructor LIB_TABLE
* builds a library table from an s-expression form of the library table.
* @param aLibraryTable is an s-expression form of all the rows in a library
* table fragment. These rows take presedence over rows in @a aFallBackTable.
* @param aFallBackTable is another LIB_TABLE which is searched only when
* a record is not found in this table.
*/
LIB_TABLE( const STRING& aLibraryTable, LIB_TABLE* aFallBackTable = NULL )
{
// s-expression is chosen so we can read a table fragment from either
// a schematic or a disk file.
}
}; };
} // namespace SCH } // namespace SCH
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment