Skip to main content

NodeContractDefinition.h File

Structural definition of a Node's contract (ports, fields, override policies). More...

Included Headers​

#include <string> #include <vector>

Namespaces Index​

namespacesimaai
namespaceneat

Classes Index​

structContractPortSpec

Per-port contract: the shape/type/segment requirements for one input or output. More...

structContractFieldSpec

Per-field contract: where the field value comes from and the override policy. More...

structNodeContractDefinition

Bundle of port and field specs that fully describes a Node's contract. More...

Description​

Structural definition of a Node's contract (ports, fields, override policies).

NodeContractDefinition is the static, declarative shape of a Node's contract: which input/output ports it has, what fields are configurable, where each field's value comes from, and whether the Builder can override it. The Builder consumes these definitions during contract resolution; the resolved/compiled output is CompiledNodeContract (not in this header).

See Also

NodeContractProvider

See Also

ContractRegistry

File Listing​

The file content with the documentation metadata removed is:

1
15#pragma once
16
17#include <string>
18#include <vector>
19
20namespace simaai::neat {
21
31enum class ContractFieldSource {
32 Fixed,
33 BuilderOption,
34 ModelOnly,
35 InputOnly,
36 UpstreamOnly,
37 GraphOwned,
38};
39
44enum class ContractOverridePolicy {
45 Forbidden,
46 BuilderOnly,
47};
48
58struct ContractPortSpec {
59 std::string port_id;
60 std::string media_type;
61 std::string format;
62 std::string dtype;
63 std::string layout;
64 std::vector<std::string> required_segment_names;
65 std::vector<std::string>
66 required_preprocess_meta_fields;
67 bool require_quant = false;
68};
69
74struct ContractFieldSpec {
75 std::string field_id;
76 ContractFieldSource source = ContractFieldSource::Fixed;
77 ContractOverridePolicy override_policy = ContractOverridePolicy::Forbidden;
78 bool required = false;
79};
80
90struct NodeContractDefinition {
91 std::string node_kind;
92 std::string plugin_kind;
93 std::vector<ContractPortSpec> inputs;
94 std::vector<ContractPortSpec> outputs;
95 std::vector<ContractFieldSpec> fields;
96};
97
98} // namespace simaai::neat

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.