#include <corenodes_instances.h>
Detailed Description
MicroNode is the base class of all micro node implementation classes such as BasicMicroNode or BatchMicroNode. To implement a new custom micro node, you usually write a subclass of BasicMicroNode.
There is a 1:1 correspondence between a MicroNodeInterface instance and a MicroNode instance: Each MicroNodeInterface instance holds its own MicroNode instance, see MicroNodeInterface::GetImplementation() and MicroNode::GetNode().
Although MicroNode itself has no data members, it is ensured by its subclasses that the data layout always starts with MicroNode::Base. MicroNode::ToBase() does the corresponding cast.
Classes | |
| class | AllowsChild |
| class | AllowsParent |
| class | Base |
| struct | Child |
| class | Lazy |
| class | PortsAccess |
| struct | Source |
Public Member Functions | |
| enum maxon::corenodes::MicroNode::TYPE | MAXON_ENUM_ORDERED_FLAGS_CLASS (TYPE) |
| enum maxon::corenodes::MicroNode::FLAGS | MAXON_ENUM_FLAGS_CLASS (FLAGS) |
| const Base & | ToBase () const |
| Base & | ToBase () |
| Bool | HasSameClass (const MicroNode &other) const |
| const MicroNodeInterface * | GetNode () const |
| MicroNodeInterface * | GetNode () |
| TYPE | GetType () const |
| FLAGS | GetFlags () const |
| enum maxon::corenodes::MicroNode::PORTSACCESS_FLAGS | MAXON_ENUM_FLAGS_CLASS (PORTSACCESS_FLAGS) |
Static Public Member Functions | |
| static void | InitUserData () |
| static void | GetLlvmAssembly (const LlvmGlobalsReceiver &) |
Public Attributes | |
| class maxon::corenodes::MicroNode::Base | MAXON_ENUM_FLAGS_CLASS |
Static Public Attributes | |
| static const TYPE | INPUT_TYPE_MASK |
| static const TYPE | OUTPUT_TYPE_MASK |
| static const FLAGS | MICRONODE_FLAGS |
Member Typedef Documentation
◆ Input
| using Input = typename PORT::PrivateInput |
◆ Ports
| using Ports = typename PortsAccess<PORTSACCESS_FLAGS::NONE, PORTS...>::Members |
You have to use {const Ports<...>&} as the parameter type of the Process method of a BasicMicroNode.
- Template Parameters
-
PORTS The ports which shall be accessed within the Process method.
Member Enumeration Documentation
◆ TYPE
|
strong |
This enum lists the defined micro node types.
| Enumerator | |
|---|---|
| INVALID | |
| BASIC | Enum value for BasicMicroNode. |
| BATCH | |
| SPLIT_MERGE | |
| ITERATION | |
| SEQUENCING | |
| RECURSION_STEP | |
| LIST_INPUT_GROUP | |
| PREVIOUS_ITERATION_VALUE | |
| COPY | |
| VARIABLE_MASK | |
| VALUE_PORT_MASK | |
| INPUT_PORT_MASK | |
| EXPORTED_PORT | |
| VIRTUAL_INPUT_PORT | |
| OUTPUT_PORT_MASK | |
| VARIABLE | |
| PORT_MASK | |
| FACTOR_MASK | |
| ROOT | |
| SWITCH | |
| CASE | |
| WHILE_CONDITION | |
| INDEFINITE_LOOP | |
| TOP_LEVEL_FACTOR_MASK | |
| FRAME_MASK | |
| TOP_LEVEL_FRAME | |
| FRAME | |
| PARAMETER_MASK | |
| PARAMETERS | |
| EVENT_MASK | |
| EVENT | |
| DIMENSIONAL_HEAD_MASK | |
| INDEFINITE_LOOP_HEAD | |
| RECURSION_HEAD | |
| DEFINITE_FACTOR_HEAD_MASK | |
| DEFINITE_LOOP_HEAD | |
| CONTAINER_OUTPUT_HEAD_MASK | |
| CONTAINER_OUTPUT_HEAD | |
| ARRAY_OUTPUT_HEAD | |
| CONTAINER_LOOP_MASK | |
| CONTAINER_LOOP | |
| ARRAY_LOOP | |
| CONTAINER_LOOP_HEAD_MASK | |
| CONTAINER_LOOP_HEAD | |
| ARRAY_LOOP_HEAD | |
| CONTAINER_FACTOR_MASK | |
| DEFINITE_FACTOR_MASK | |
| DEFINITE_LOOP | |
| OTHER_FACTOR_MASK | |
| RECURSION | |
| DIMENSIONAL_FACTOR_MASK | |
| INPUT_ELEMENT_MASK | |
| ARRAY_INPUT_ELEMENT | |
| LIST_INPUT_ELEMENT | |
| INPUT_MASK | |
| FACTOR_REFERENCE_MASK | |
| FACTOR_REFERENCE | |
| CONTAINER_OUTPUT_ELEMENT | |
| ARRAY_OUTPUT_ELEMENT | |
| LIST_PARAMETER | |
| ARRAY_PARAMETER | |
| OUTPUT_MASK | |
| LIST_MASK | |
| LIST | |
| ARRAY | |
| CONTAINER_OUTPUT_MASK | |
| CONTAINER_OUTPUT | |
| ALL | |
◆ FLAGS
|
strong |
This enum lists the flags for micro nodes as returned by GetFlags().
◆ PORTSACCESS_FLAGS
|
strong |
Member Function Documentation
◆ MAXON_ENUM_ORDERED_FLAGS_CLASS()
| enum maxon::corenodes::MicroNode::TYPE MAXON_ENUM_ORDERED_FLAGS_CLASS | ( | TYPE | ) |
◆ MAXON_ENUM_FLAGS_CLASS() [1/2]
| enum maxon::corenodes::MicroNode::FLAGS MAXON_ENUM_FLAGS_CLASS | ( | FLAGS | ) |
◆ ToBase() [1/2]
| const Base& ToBase | ( | ) | const |
◆ ToBase() [2/2]
| Base& ToBase | ( | ) |
◆ HasSameClass()
Checks if this micro node has the same implementation class as #other.
- Parameters
-
[in] other Another micro node.
- Returns
- This object, casted to MicroNode.
◆ GetNode() [1/2]
| const MicroNodeInterface* GetNode | ( | void | ) | const |
Returns the MicroNodeInterface instance which owns this MicroNode.
- Returns
- The owning MicroNodeInterface.
◆ GetNode() [2/2]
| MicroNodeInterface* GetNode | ( | void | ) |
Returns the MicroNodeInterface instance which owns this MicroNode.
- Returns
- The owning MicroNodeInterface.
◆ GetType()
| TYPE GetType | ( | void | ) | const |
Returns the type of this micro node.
- Returns
- Type of this micro node.
◆ GetFlags()
| FLAGS GetFlags | ( | void | ) | const |
Returns the flags of this micro node.
- Returns
- Flags of this micro node.
◆ MAXON_ENUM_FLAGS_CLASS() [2/2]
| enum maxon::corenodes::MicroNode::PORTSACCESS_FLAGS MAXON_ENUM_FLAGS_CLASS | ( | PORTSACCESS_FLAGS | ) |
◆ InitUserData()
|
static |
◆ GetLlvmAssembly()
|
static |
Member Data Documentation
◆ MAXON_ENUM_FLAGS_CLASS
| class maxon::corenodes::MicroNode::Base MAXON_ENUM_FLAGS_CLASS |
◆ INPUT_TYPE_MASK
|
static |
◆ OUTPUT_TYPE_MASK
|
static |
◆ MICRONODE_FLAGS
|
static |