Detailed Description
Definition at line 48 of file ModuleDefBuilder.h.
Public Member Functions | |
| ModuleDefBuilder (const std::string &name) | |
| template<typename ModuleType > | |
| ModuleDefBuilder & | Type () |
| ModuleDefBuilder & | Attr (const std::string &spec) |
Adds an attribute to the module definition (and returns *this). More... | |
| ModuleDefBuilder & | GlobalAttr (const std::string &spec) |
Adds a global attribute to the module definition (and returns *this). More... | |
| ModuleDefBuilder & | OptionalAttr (const std::string &spec) |
Adds an optional attribute to the module definition (and returns *this). More... | |
| ModuleDefBuilder & | Input (const std::string &spec) |
Adds an input to the module definition (and returns *this). More... | |
| ModuleDefBuilder & | OptionalInput (const std::string &spec) |
Adds an optional input to the module definition (and returns *this). More... | |
| ModuleDefBuilder & | Inputs (const std::string &spec) |
Adds inputs to the module definition (and returns *this). More... | |
| ModuleDefBuilder & | OptionalInputs (const std::string &spec) |
Adds optional inputs to the module definition (and returns *this). More... | |
| ModuleDefBuilder & | Output (const std::string &spec) |
| ModuleDefBuilder & | Sticky () |
| Flag this module as sticky. More... | |
| ModuleRegistrationData | Build () const |
| std::string | name () const |
Member Function Documentation
◆ Attr()
| ModuleDefBuilder & momemta::registration::ModuleDefBuilder::Attr | ( | const std::string & | spec | ) |
Adds an attribute to the module definition (and returns *this).
The spec has format <name>:<type> or <name>:<type>=<default>
where <name> matches regexp [a-zA-Z][a-zA-Z0-9_]*
<type> can be:
string,int,double,bool,pset,pathlist(string),list(double), ...(meaning lists of the above types)
<default>, if included, is the default value of the attribute. For lists use [a, b, c] format.
Definition at line 236 of file ModuleDefBuilder.cc.
◆ GlobalAttr()
| ModuleDefBuilder & momemta::registration::ModuleDefBuilder::GlobalAttr | ( | const std::string & | spec | ) |
Adds a global attribute to the module definition (and returns *this).
The spec has format <name>:<type> or <name>:<type>=<default>
where <name> matches regexp [a-zA-Z][a-zA-Z0-9_]*
<type> can be:
string,int,double,bool,pset,pathlist(string),list(double), ...(meaning lists of the above types)
<default>, if included, is the default value of the attribute. For lists use [a, b, c] format.
Definition at line 241 of file ModuleDefBuilder.cc.
◆ Input()
| ModuleDefBuilder & momemta::registration::ModuleDefBuilder::Input | ( | const std::string & | spec | ) |
Adds an input to the module definition (and returns *this).
The spec has format <name> or <name>=<default>
where <name> matches regexp [a-zA-Z][a-zA-Z0-9_]*
Input can also be nested inside attributes. In this case, spec has format <attr>/[<attr>/]*<name> where <attr> matches regex defined in Attr() and <name> matches regexp defined above.
Definition at line 208 of file ModuleDefBuilder.cc.
◆ Inputs()
| ModuleDefBuilder & momemta::registration::ModuleDefBuilder::Inputs | ( | const std::string & | spec | ) |
Adds inputs to the module definition (and returns *this).
The spec has format <name> or <name>=<default>
where <name> matches regexp [a-zA-Z][a-zA-Z0-9_]*
Input can also be nested inside attributes. In this case, spec has format <attr>/[<attr>/]*<name> where <attr> matches regex defined in Attr() and <name> matches regexp defined above.
Definition at line 219 of file ModuleDefBuilder.cc.
◆ OptionalAttr()
| ModuleDefBuilder & momemta::registration::ModuleDefBuilder::OptionalAttr | ( | const std::string & | spec | ) |
Adds an optional attribute to the module definition (and returns *this).
The spec has format <name>:<type> or <name>:<type>=<default>
where <name> matches regexp [a-zA-Z][a-zA-Z0-9_]*
<type> can be:
string,int,double,bool,pset,pathlist(string),list(double), ...(meaning lists of the above types)
<default>, if included, is the default value of the attribute. For lists use [a, b, c] format.
Definition at line 247 of file ModuleDefBuilder.cc.
◆ OptionalInput()
| ModuleDefBuilder & momemta::registration::ModuleDefBuilder::OptionalInput | ( | const std::string & | spec | ) |
Adds an optional input to the module definition (and returns *this).
The spec has format <name> or <name>=<default>
where <name> matches regexp [a-zA-Z][a-zA-Z0-9_]*
Input can also be nested inside attributes. In this case, spec has format <attr>/[<attr>/]*<name> where <attr> matches regex defined in Attr() and <name> matches regexp defined above.
Definition at line 213 of file ModuleDefBuilder.cc.
◆ OptionalInputs()
| ModuleDefBuilder & momemta::registration::ModuleDefBuilder::OptionalInputs | ( | const std::string & | spec | ) |
Adds optional inputs to the module definition (and returns *this).
The spec has format <name> or <name>=<default>
where <name> matches regexp [a-zA-Z][a-zA-Z0-9_]*
Input can also be nested inside attributes. In this case, spec has format <attr>/[<attr>/]*<name> where <attr> matches regex defined in Attr() and <name> matches regexp defined above.
Definition at line 225 of file ModuleDefBuilder.cc.
◆ Sticky()
| ModuleDefBuilder & momemta::registration::ModuleDefBuilder::Sticky | ( | ) |
Flag this module as sticky.
A sticky module is a module which can't be removed from the graph, even if its outputs are not used
Definition at line 253 of file ModuleDefBuilder.cc.
The documentation for this class was generated from the following files:
- include/momemta/ModuleDefBuilder.h
- core/src/registry/ModuleDefBuilder.cc
