BringObjectToLocation Class Reference
#include <RobotSkillTemplates/libraries/skill_bring_object/BringObjectToLocation.h>
Inheritance diagram for BringObjectToLocation:Public Types | |
| using | ArgType = arondto::BringObjectToLandmarkAcceptedType |
| Public Types inherited from SpecializedSkill< arondto::BringObjectToLandmarkAcceptedType > | |
| using | ParamType = arondto::BringObjectToLandmarkAcceptedType |
| Public Types inherited from Skill | |
| using | CallbackT = std::function< void(const aron::data::DictPtr &)> |
Public Member Functions | |
| BringObjectToLocation (const BringObjectSkillContext &context) | |
| MainResult | main (const SpecializedMainInput &in) final |
| Override this method with the actual implementation. The callback is for status updates to the calling instance. More... | |
| Public Member Functions inherited from BringObjectSkill | |
| BringObjectSkill (const BringObjectSkillContext &c) | |
| Public Member Functions inherited from SpecializedSkill< arondto::BringObjectToLandmarkAcceptedType > | |
| Skill::MainResult | executeFullSkill (const SpecializedMainInput &in) |
| Skill::ExitResult | exitSkill (const SpecializedExitInput &in) |
| Skill::InitResult | initSkill (const SpecializedInitInput &in) |
| bool | isSkillAvailable (const SpecializedInitInput &in) const |
| Skill::MainResult | mainOfSkill (const SpecializedMainInput &in) |
| Skill ()=delete | |
| Skill (const SkillDescription &) | |
| virtual | ~SpecializedSkill ()=default |
| Public Member Functions inherited from Skill | |
| bool | checkWhetherSkillShouldStopASAP () const |
| MainResult | executeFullSkill (const MainInput &in) |
| Do init, main, exit together. More... | |
| ExitResult | exitSkill (const ExitInput &in) |
| SkillID | getSkillId () const |
| The id of the skill (combination of provider and name must be unique). More... | |
| InitResult | initSkill (const InitInput &in) |
| bool | isSkillAvailable (const InitInput &in) const |
| MainResult | mainOfSkill (const MainInput &in) |
| void | notifySkillToStopASAP () |
| void | resetSkill () |
| Skill ()=delete | |
| Skill (const SkillDescription &) | |
| void | waitForDependenciesOfSkill () |
| virtual | ~Skill ()=default |
| Public Member Functions inherited from Logging | |
| SpamFilterDataPtr | deactivateSpam (float deactivationDurationSec=10.0f, const std::string &identifier="", bool deactivate=true) const |
| disables the logging for the current line for the given amount of seconds. More... | |
| MessageTypeT | getEffectiveLoggingLevel () const |
| Logging () | |
| void | setLocalMinimumLoggingLevel (MessageTypeT level) |
| With setLocalMinimumLoggingLevel the minimum verbosity-level of log-messages can be set. More... | |
| void | setTag (const LogTag &tag) |
| void | setTag (const std::string &tagName) |
| virtual | ~Logging () |
Static Public Attributes | |
| static SkillDescription | Description |
Additional Inherited Members | |
| Static Public Member Functions inherited from SpecializedSkill< arondto::BringObjectToLandmarkAcceptedType > | |
| static armarx::aron::type::ObjectPtr | GetAcceptedType () |
| returns the accepted type of the skill More... | |
| Data Fields inherited from Skill | |
| const SkillDescription | description |
| The descripion of the skill, which will be available via the provider/manager. More... | |
| armarx::core::time::DateTime | exited = armarx::core::time::DateTime::Invalid() |
| manager::dti::SkillManagerInterfacePrx | manager = nullptr |
| proxy that called the skills. Will be set from provider and is const afterwards More... | |
| std::string | providerName = "INVALID PROVIDER NAME" |
| the provider that owns this skill. Will be set from provider and is const afterwards More... | |
| armarx::core::time::DateTime | started = armarx::core::time::DateTime::Invalid() |
| running params More... | |
| Protected Member Functions inherited from Skill | |
| void | _exit () |
| void | _init () |
| void | _main () |
| void | installConditionWithCallback (std::function< bool()> &&f, std::function< void()> &&cb) |
| install a condition which is frequently checked from the conditionCheckingThread More... | |
| void | notifyTimeoutReached () |
| Protected Member Functions inherited from Logging | |
| bool | checkLogLevel (MessageTypeT level) const |
| const LogSenderPtr & | getLogSender () const |
| Retrieve log sender. More... | |
| LogSenderPtr | loghelper (const char *file, int line, const char *function) const |
| Static Protected Member Functions inherited from Skill | |
| static MainResult | MakeAbortedResult (aron::data::DictPtr data=nullptr) |
| Protected Attributes inherited from BringObjectSkill | |
| const BringObjectSkillContext & | context |
| Protected Attributes inherited from Skill | |
| std::vector< std::pair< std::function< bool()>, std::function< void()> > > | callbacks |
| active conditions. First is condition (bool return func) More... | |
| std::mutex | callbacksMutex |
| std::atomic_bool | running = false |
| Use conditions this way. More... | |
| std::atomic_bool | stopped = false |
| std::atomic_bool | timeoutReached = false |
| Protected Attributes inherited from Logging | |
| MessageTypeT | minimumLoggingLevel |
| SpamFilterDataPtr | spamFilter |
| LogTag | tag |
Detailed Description
Definition at line 46 of file BringObjectToLocation.h.
Member Typedef Documentation
◆ ArgType
| using ArgType = arondto::BringObjectToLandmarkAcceptedType |
Definition at line 51 of file BringObjectToLocation.h.
Constructor & Destructor Documentation
◆ BringObjectToLocation()
| BringObjectToLocation | ( | const BringObjectSkillContext & | context | ) |
Definition at line 30 of file BringObjectToLocation.cpp.
Member Function Documentation
◆ main()
|
finalvirtual |
Override this method with the actual implementation. The callback is for status updates to the calling instance.
Reimplemented from SpecializedSkill< arondto::BringObjectToLandmarkAcceptedType >.
Definition at line 36 of file BringObjectToLocation.cpp.
Here is the call graph for this function:Field Documentation
◆ Description
|
static |
Initial value:
= SkillDescription{
"BringObjectToLocation", "Bring an object to some location",
{}, armarx::Duration::MilliSeconds(60000),
arondto::BringObjectToLandmarkAcceptedType::ToAronType(),
GetDefaultParameterization().toAron()
}
Definition at line 57 of file BringObjectToLocation.h.
The documentation for this class was generated from the following files:
- RobotSkillTemplates/libraries/skill_bring_object/BringObjectToLocation.h
- RobotSkillTemplates/libraries/skill_bring_object/BringObjectToLocation.cpp
