smtk::task::SubmitOperationAgent::ParameterSpec Struct Reference

Per-parameter configuration of item values. More...

#include <SubmitOperationAgent.h>

Collaboration diagram for smtk::task::SubmitOperationAgent::ParameterSpec:

Public Attributes
PortDataHandler	m_portDataHandler
	How to ingest objects present in port data.
std::string	m_resourceTypeName
	Resource type-name specifier (smtk::attribute::Resource for now)
smtk::string::Token	m_resourceTemplate
	Resource schema specifier (or empty when no match is required).
std::string	m_componentSelector
	Component selector to identify which components in the resource can provide a value for the parameter (e.g. More...
std::string	m_sourceItemPath
	A recipe to extract a value from matching components. (For attributes, this is an item path.)
std::string	m_targetItemPath
	The destination for the extracted value in the operation's parameters (an item path).
ConfiguredBy	m_configuredBy = ConfiguredBy::Static
	What should be allowed to modify the parameter.
bool	m_userOverride
	False by default; true when user has modified the parameter. Skip when true and m_configuredBy == User.
nlohmann::json	m_values
	Values to assign to the item (UUIDs for reference items) if m_configuredBy == Static.
ItemVisibility	m_visibility = ItemVisibility::On
	Should this item (and potentially its children) be shown or hidden.

Detailed Description

Per-parameter configuration of item values.

This class directs the agent how to ingest data from any input port(s) of the parent task. The agent requires port-data to be of type ObjectsInRoles and stores a nested collection of ParameterSpec instances indexed first by port name and then by role name. When a port is marked as having updated port data, ParameterSpec instances describe how to act on the objects present at a given port under a given role using m_portDataHandler:

• If objects are in an expected role, they may be added to a reference item in the operation parameters if (1) they pass the m_resourceTypeName and m_componentSelector filters (2) they or their parent resource has a matching m_resourceTypeName and (if valid) m_resourceTemplate. This also accommodates associating the objects to the operation since associations are held in a ReferenceItem that is explicitly named. These may be strictly additive (AddObjects) – so that no objects are removed from the item unless they are expunged – or reset the item on each update (SetObjects).
• If a port-data object is an attribute (AssignFromAttribute) or attribute resource (AssignFromAttributeResource) with the given m_resourceTemplate and it contains attribute instances matching m_componentSelector, then an item (or association) may be copied to an item (or association) of the operation parameters. If you wish both cases to be handled, use AssignMatchingAttributes.

Member Data Documentation

m_componentSelector

std::string smtk::task::SubmitOperationAgent::ParameterSpec::m_componentSelector

Component selector to identify which components in the resource can provide a value for the parameter (e.g.

"attribute[type='Foo']{string['name'='Bar']}")

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/smtk/checkouts/latest/smtk/task/SubmitOperationAgent.h