pdaView
Optional pda::View implementations; in the pdaConfig.xsd/cc code this is handled with the object factories to automatically add them.Views are defined in PDAFlow1 as C++ objects that can be created via an object factory. They can have arguments of any type, but not sub-views.
The idea of a view is to look at a building block / component in a flexible way, the view uses the information from the actual BB instance in a defined way; this can be things like layout, simulation as well as user interface aspects like icons, library references and so on.
Structure
The attributes and elements are shown below, in a sorted per type fashion.In case a list is printed after an element, it indicates that you can have many, otherwise it should be a single element. With a optional it tells the element is not required.
<pdaView name="..." ... > ...
<doc> ... </doc> list
<license> ... </license> list
<parameter> ... </parameter> list
<tex> ... </tex> list
<version> ... </version> list
</pdaView>
XSD The schema file can be downloaded or viewed at xPDK_Base.
Details
doc
Type pdaDocumentation documentation: Document anything relevant for the topic you want to define.This field allows some (short, few lines) documentation to be written. It can be a long string, but the idea is not to replace a design manual.
This fields is like
tex
which allows documentation in LaTex format; doc
is restricted to plain text.license
Type pdaLicense documentation: Define license information.State the basic conditions of using the file and typically refer to legal documents.
License information should be compact enough to be clear as reference. The reference is expected to be to signed documents like Non Disclose Agreements (NDA) or service contracts and so on.
name
Type pdaIdentifier documentation: Defines a valid name for an identifier.Identifiers are used in the Python library for the
getName()
and setName()
function and can thus be used to identify the different elements in lists.In text the specification is a letter, followed by letters, numbers, underscore or dot. The XSD schema validation is a regular expression: [A-Za-z]([A-Za-z0-9_])*
parameter
List of parameters (can be empty). Parameters are named-values and can have an unit, type and value. The value is defined via an expression. Type pdaNamedValue documentation: Create a named value with expression / type support.tex
Type pdaTexDocumentation documentation: Asdoc
, but tex
can be a long text in LaTex format to document the layer in more detail if needed.You can document anything relevant for the topic you want to define.
Multiple paragraphs is fine. Format is Latex, so more complex content is possible.