ContractRegistry Class

Holds a set of Contracts and runs them to produce a ValidationReport. More...

Declaration

class simaai::neat::ContractRegistry { ... }

Included Headers

#include <ContractRegistry.h>

Public Member Typedefs Index

using	ContractPtr = std::shared_ptr< Contract >
	Shared-pointer alias for a Contract. More...

Public Constructors Index

	ContractRegistry ()=default
	Construct an empty registry. More...

Public Member Functions Index

ContractRegistry &	add (ContractPtr c)
	Add or replace a contract (keyed by id()); returns *this for chaining. More...
template <class T, class... Args>
ContractRegistry &	emplace (Args &&... args)
	Convenience: construct a contract of type T from args and add it. More...
bool	remove (const std::string &id)
	Remove a contract by id. Returns true if removed. More...
void	clear ()
	Drop all contracts; the registry becomes empty. More...
std::size_t	size () const noexcept
	Number of contracts currently registered. More...
bool	empty () const noexcept
	True if no contracts are registered. More...
ContractPtr	get (const std::string &id) const
	Get a contract by id (nullptr if missing). More...
std::vector< std::string >	ids () const
	Deterministic list of ids in insertion order. More...
ValidationReport	validate (const NodeGroup &nodes, const ValidationContext &ctx) const
	Run all contracts and return a ValidationReport. More...

Private Member Attributes Index

std::unordered_map< std::string, ContractPtr >	by_id_
std::vector< std::string >	order_

Description

Holds a set of Contracts and runs them to produce a ValidationReport.

Insertion order is preserved (and used as evaluation order). Adding a contract whose id() matches an existing one replaces the old contract in place. The registry is intentionally small and STL-only.

See Also

Contract

See Also

ValidationReport

See Also

Validators::DefaultRegistry

Definition at line 40 of file ContractRegistry.h.

Public Member Typedefs

ContractPtr

using simaai::neat::ContractRegistry::ContractPtr = std::shared_ptr<Contract>

Shared-pointer alias for a Contract.

Definition at line 43 of file ContractRegistry.h.

43 using ContractPtr = std::shared_ptr<Contract>;

Public Constructors

ContractRegistry()

simaai::neat::ContractRegistry::ContractRegistry ()

default

Construct an empty registry.

Definition at line 46 of file ContractRegistry.h.

Public Member Functions

add()

ContractRegistry & simaai::neat::ContractRegistry::add (ContractPtr c)

inline

Add or replace a contract (keyed by id()); returns *this for chaining.

Definition at line 49 of file ContractRegistry.h.

49 ContractRegistry& add(ContractPtr c) {

50 if (!c)

51 return *this;

52 const std::string cid = c->id();

53 if (cid.empty())

54 return *this;

55

56 auto it = by_id_.find(cid);

57 if (it == by_id_.end()) {

58 order_.push_back(cid);

59 }

60 by_id_[cid] = std::move(c);

61 return *this;

62 }

clear()

void simaai::neat::ContractRegistry::clear ()

inline

Drop all contracts; the registry becomes empty.

Definition at line 87 of file ContractRegistry.h.

87 void clear() {

88 by_id_.clear();

89 order_.clear();

90 }

emplace()

template <class T, class... Args>

ContractRegistry & simaai::neat::ContractRegistry::emplace (Args &&... args)

inline

Convenience: construct a contract of type T from args and add it.

Definition at line 65 of file ContractRegistry.h.

65 template <class T, class... Args> ContractRegistry& emplace(Args&&... args) {

66 return add(std::make_shared<T>(std::forward<Args>(args)...));

67 }

empty()

bool simaai::neat::ContractRegistry::empty ()

inline noexcept

True if no contracts are registered.

Definition at line 97 of file ContractRegistry.h.

97 bool empty() const noexcept {

98 return by_id_.empty();

99 }

get()

ContractPtr simaai::neat::ContractRegistry::get (const std::string & id)

inline

Get a contract by id (nullptr if missing).

Definition at line 102 of file ContractRegistry.h.

102 ContractPtr get(const std::string& id) const {

103 auto it = by_id_.find(id);

104 return (it == by_id_.end()) ? nullptr : it->second;

105 }

ids()

std::vector< std::string > simaai::neat::ContractRegistry::ids ()

inline

Deterministic list of ids in insertion order.

Definition at line 108 of file ContractRegistry.h.

108 std::vector<std::string> ids() const {

109 return order_;

110 }

remove()

bool simaai::neat::ContractRegistry::remove (const std::string & id)

inline

Remove a contract by id. Returns true if removed.

Definition at line 70 of file ContractRegistry.h.

70 bool remove(const std::string& id) {

71 auto it = by_id_.find(id);

72 if (it == by_id_.end())

73 return false;

74 by_id_.erase(it);

75

76 // Keep deterministic order_: erase id if present.

77 for (auto oit = order_.begin(); oit != order_.end(); ++oit) {

78 if (*oit == id) {

79 order_.erase(oit);

80 break;

81 }

82 }

83 return true;

84 }

size()

std::size_t simaai::neat::ContractRegistry::size ()

inline noexcept

Number of contracts currently registered.

Definition at line 93 of file ContractRegistry.h.

93 std::size_t size() const noexcept {

94 return by_id_.size();

95 }

validate()

ValidationReport simaai::neat::ContractRegistry::validate (const NodeGroup & nodes, const ValidationContext & ctx)

inline

Run all contracts and return a ValidationReport.

Defensive behavior:

• contract violations should be reported (not thrown)
• if a Contract throws, registry converts that into an internal ERROR issue

Definition at line 119 of file ContractRegistry.h.

119 ValidationReport validate(const NodeGroup& nodes, const ValidationContext& ctx) const {

120 ValidationReport report;

121 report.set_mode(static_cast<int>(ctx.mode));

122

123 for (const auto& id : order_) {

124 auto it = by_id_.find(id);

125 if (it == by_id_.end() || !it->second)

126 continue;

127

128 report.note_contract_run(id);

129

130 try {

131 it->second->validate(nodes, ctx, report);

132 } catch (const std::exception& e) {

133 report.add_issue({

134 .severity = ValidationSeverity::Error,

135 .contract_id = id,

136 .code = "CONTRACT_THREW",

137 .message = std::string("Contract threw exception: ") + e.what(),

138 .node_index = -1,

139 });

140 } catch (...) {

141 report.add_issue({

142 .severity = ValidationSeverity::Error,

143 .contract_id = id,

144 .code = "CONTRACT_THREW",

145 .message = "Contract threw unknown exception",

146 .node_index = -1,

147 });

148 }

149 }

150

151 return report;

152 }

Private Member Attributes

by_id_

std::unordered_map<std::string, ContractPtr> simaai::neat::ContractRegistry::by_id_

Definition at line 155 of file ContractRegistry.h.

155 std::unordered_map<std::string, ContractPtr> by_id_;

order_

std::vector<std::string> simaai::neat::ContractRegistry::order_

Definition at line 156 of file ContractRegistry.h.

156 std::vector<std::string> order_;

---

The documentation for this class was generated from the following file:

• ContractRegistry.h

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.