|
| smtkTypeMacro (smtk::task::FillOutAttributes) |
|
| smtkSuperclassMacro (smtk::task::Task) |
|
| smtkCreateMacro (smtk::task::Task) |
|
| FillOutAttributes (const Configuration &config, Manager &taskManager, const smtk::common::Managers::Ptr &managers=nullptr) |
|
| FillOutAttributes (const Configuration &config, const PassedDependencies &dependencies, Manager &taskManager, const smtk::common::Managers::Ptr &managers=nullptr) |
|
void | configure (const Configuration &config) |
| Parse configuration information to initialize this instance.
|
|
bool | getViewData (smtk::common::TypeContainer &configuration) const override |
| Provide the attribute resource(s) that the user should edit.
|
|
smtk::common::Visit | visitAttributeSets (ConstAttributeSetVisitor visitor) const |
|
smtk::common::Visit | visitAttributeSets (AttributeSetVisitor visitor) |
|
| smtkTypeMacro (smtk::task::Task) |
|
| smtkSuperclassMacro (smtk::resource::Component) |
|
| smtkCreateMacro (smtk::task::Task) |
|
| Task (const Configuration &config, Manager &taskManager, const std::shared_ptr< smtk::common::Managers > &managers=nullptr) |
|
| Task (const Configuration &config, const PassedDependencies &dependencies, Manager &taskManager, const std::shared_ptr< smtk::common::Managers > &managers=nullptr) |
|
const common::UUID & | id () const override |
| Set/get the task's unique identifier.
|
|
bool | setId (const common::UUID &newId) override |
| Assign an ID to this object (used by readers; not for arbitrary reuse). More...
|
|
std::string | name () const override |
| Return the task's name.
|
|
virtual void | setName (const std::string &name) |
|
const std::shared_ptr< resource::Resource > | resource () const override |
| Components are required to return their owning resource (if any). More...
|
|
void | configure (const Configuration &config) |
| A method called by all constructors passed Configuration information. More...
|
|
const std::string & | title () const |
| Return the title of the task (if one was provided).
|
|
void | setTitle (const std::string &title) |
| Set the title of the task to be presented to users. More...
|
|
const std::set< smtk::string::Token > & | style () const |
| Set/get style classes for the task. More...
|
|
bool | addStyle (const smtk::string::Token &styleClass) |
|
bool | removeStyle (const smtk::string::Token &styleClass) |
|
bool | clearStyle () |
|
virtual State | state () const |
| Get the state. More...
|
|
virtual bool | editableCompletion () const |
| Return whether or not users are allowed to mark a task completed. More...
|
|
virtual bool | markCompleted (bool completed) |
| This public method allows user-interface components to indicate when the user marks a task complete (or unmarks it). More...
|
|
bool | areDependenciesStrict () const |
| Return true if this task has been configured with strict dependency enforcement. More...
|
|
PassedDependencies | dependencies () const |
| Return the tasks which this task depends upon. More...
|
|
bool | canAddDependency (const std::shared_ptr< Task > &dependency) |
| Check whether inserting a dependency would induce a cycle. More...
|
|
bool | addDependency (const std::shared_ptr< Task > &dependency) |
| Add a dependency. More...
|
|
template<typename Container > |
bool | addDependencies (const Container &tasks) |
| Add a container of task-pointers as dependencies. More...
|
|
bool | removeDependency (const std::shared_ptr< Task > &dependency) |
| Remove a dependency. More...
|
|
template<typename Container > |
bool | removeDependencies (const Container &tasks) |
| Remove a container of task-pointers as dependencies. More...
|
|
Task * | parent () const |
| Return a parent task if one exists; null otherwise.
|
|
virtual bool | hasChildren () const |
| Return whether or not the task has children. More...
|
|
virtual smtk::common::Visit | visit (RelatedTasks relation, Visitor visitor) const |
| Visit children. More...
|
|
Observers & | observers () |
| Return this object's observers so other classes may insert themselves.
|
|
State | internalState () const |
| Return the internal state of the task. More...
|
|
Manager * | manager () const |
| Return the tasks's manager (or null if unmanaged).
|
|
| smtkTypeMacro (smtk::resource::Component) |
|
| smtkSuperclassMacro (smtk::resource::PersistentObject) |
|
| smtkSharedFromThisMacro (smtk::resource::PersistentObject) |
|
virtual Resource * | parentResource () const |
| Return a raw (not shared) pointer to the resource that owns this component. More...
|
|
template<typename ResourceType > |
ResourceType * | parentResourceAs () const |
| This variant of parentResource casts the result to the given ResourceType.
|
|
Links & | links () override |
| Return the links that connect this component to external resources/components.
|
|
const Links & | links () const override |
|
Properties & | properties () override |
| Return properties defined on this component.
|
|
const Properties & | properties () const override |
|
| smtkTypeMacroBase (smtk::resource::PersistentObject) |
|
template<typename T > |
T::Ptr | as () |
| Attempt to cast this object to a subclass.
|
|
template<typename T > |
T::ConstPtr | as () const |
| Attempt to cast this object to a subclass.
|
|
|
smtk::common::Managers::Ptr | m_managers |
|
smtk::operation::Observers::Key | m_observer |
|
std::vector< AttributeSet > | m_attributeSets |
|
std::string | m_name |
| A task name to present to the user.
|
|
std::set< smtk::string::Token > | m_style |
| The set of style classes for this task.
|
|
bool | m_completed = false |
| Whether the user has marked the task completed or not.
|
|
std::map< WeakPtr, Observers::Key, std::owner_less< WeakPtr > > | m_dependencies |
| A set of dependent tasks and the keys used to observe their state so that this task can update its state in response.
|
|
bool | m_strictDependencies = false |
| Should dependencies be strictly enforced?
|
|
std::set< WeakPtr, std::owner_less< WeakPtr > > | m_dependents |
| Tasks upon which this task depends. More...
|
|
Observers | m_observers |
| The set of observers of this task's state.
|
|
Task * | m_parent = nullptr |
| If this task is the child of another task, this pointer references its parent. More...
|
|
std::weak_ptr< smtk::task::Manager > | m_manager |
| If this task is being managed, this will refer to its manager.
|
|
smtk::common::UUID | m_id |
| The unique identifier for this task.
|
|
FillOutAttributes is a task that is incomplete until specified attributes are valid.
This task accepts an input attribute resource (configured by a predecessor task or specified via a role) and observe an operation manager for operations. After each operation, attributes with a definition are validated. If all attributes identify are valid, the task becomes completable. Otherwise, the task will remain (or become) incomplete.