porytiles2::OperandDeclaration Class Reference

A specification for operands required or produced by orchestration operations. More...

#include <operand_declaration.hpp>

Public Member Functions
	OperandDeclaration (std::string key, const std::type_index type)
	Constructs an operand declaration with the specified key and type.
const std::string &	key () const
	Gets the operand's unique identifier.
const std::type_index &	expected_type () const
	Gets the expected type information for this operand.
const std::string &	description () const
	Gets the human-readable description of this operand.
void	set_description (const std::string &desc)
	Sets a custom description for this operand.

Detailed Description

A specification for operands required or produced by orchestration operations.

OperandDeclaration provides a POD-like class that Operations use to declare input and output operand metadata. Each declaration specifies a key name, expected type, and optional human-readable description. This enables the orchestration framework to validate that OperandDeclaration contents match Operation requirements at runtime.

Definition at line 17 of file operand_declaration.hpp.

Constructor & Destructor Documentation

OperandDeclaration()

porytiles2::OperandDeclaration::OperandDeclaration ( std::string  key, const std::type_index  type  )

inline

Constructs an operand declaration with the specified key and type.

The constructor initializes the description to match the given key. The description setter provides a way to update this OperandDeclaration with a custom description.

Parameters

key	The unique identifier for this operand
type	The expected C++ type represented as std::type_index

Definition at line 29 of file operand_declaration.hpp.

Member Function Documentation

description()

const std::string & porytiles2::OperandDeclaration::description ( ) const

inline

Gets the human-readable description of this operand.

Returns

const reference to the description string

Definition at line 59 of file operand_declaration.hpp.

expected_type()

const std::type_index & porytiles2::OperandDeclaration::expected_type ( ) const

inline

Gets the expected type information for this operand.

Returns

const reference to the std::type_index representing the expected type

Definition at line 49 of file operand_declaration.hpp.

key()

const std::string & porytiles2::OperandDeclaration::key ( ) const

inline

Gets the operand's unique identifier.

Returns

const reference to the key string

Definition at line 39 of file operand_declaration.hpp.

set_description()

void porytiles2::OperandDeclaration::set_description ( const std::string &  desc )

inline

Sets a custom description for this operand.

Parameters

desc	The new description text to associate with this operand

Definition at line 69 of file operand_declaration.hpp.

---

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

• Porytiles2/include/porytiles2/domain/orchestration/operand_declaration.hpp