An alphabetical listing and summary of items that are frequently used. There are additional items for code generation primitives, they will be explained in later sections.
| Keyword | Summary | Required |
|---|---|---|
| acknowledge | the names of other contributors to the primitive | no |
| author | the name(s) of the author(s) of the primitive | no |
| begin | C++ code to execute at start time, after the scheduler setup method is called | no |
| ccinclude | specify other files to include in the .cc file | no |
| code | C++ code to include in the .cc file outside the class definition | no |
| codeblock | define a code segment for a code-generation primitive | no |
| conscalls | define constructor calls for members of the primitive class | no |
| constructor | C++ code to include in the constructor for the primitive | no |
| copyright | copyright information to include in the generated code | no |
| cleanup | method to free all memory when a simulation ends | no |
| defevent | define an event | no |
| defmemory | define a memory | no |
| defresource | define a resource | no |
| defparameter | define a parameter | no |
| derived | alternative form of derivedfrom | no |
| derivedfrom | the base class, which must also be a primitive | no |
| desc | alternative form of descriptor | no |
| descriptor | a short summary of the functionality of the primitive | no |
| destructor | C++ code to include in the destructor for the primitive | no |
| domain | the domain, and the prefix of the name of the class | yes |
| explanation | full documentation (deprecated, use htmldoc instead) | no |
| exectime | specify the execution time for a code generation primitive | no |
| go | C++ code to execute when the primitive fires | no |
| header | C++ code to include in the \pl{.h} file, before the class definition | no |
| hinclude | specify other files to include in the \pl{.h} file | no |
| htmldoc | full documentation, optionally using HTML items | no |
| inmulti | define a set of inputs | no |
| inout | define a (bidirectional) input and output | no |
| input | define an input to the primitive | no |
| location | an indication of where a user might find the primitive | no |
| method | define a member function for the primitive class | no |
| name | the name of the primitive, and the root of the name of the class | yes |
| outmulti | define a set of outputs | no |
| output | define an output from the primitive | no |
| private | define private data members of the primitive class | no |
| protected | defined protected data members of the primitive class | no |
| public | define public data members of the primitive class | no |
| setup | C++ code to execute at start time, before compile-time scheduling | no |
| version | version number and date | no |
| wrapup | C++ code to invoke at the end of a run (if no error occurred) | no |