Public Member Functions | Public Attributes | Protected Member Functions | Private Attributes | List of all members
SimpleCoroAction Class Reference
Inheritance diagram for SimpleCoroAction:
Inheritance graph
[legend]

Public Member Functions

virtual void halt () override
 
void setRequiredTime (Millisecond ms)
 
 SimpleCoroAction (milliseconds timeout, bool will_fail, const std::string &node_name, const BT::NodeConfiguration &config)
 
bool wasHalted ()
 
- Public Member Functions inherited from BT::CoroActionNode
 CoroActionNode (const std::string &name, const NodeConfiguration &config)
 
virtual NodeStatus executeTick () overridefinal
 The method that should be used to invoke tick() and setStatus();. More...
 
void setStatusRunningAndYield ()
 Use this method to return RUNNING and temporary "pause" the Action. More...
 
virtual ~CoroActionNode () override
 
- Public Member Functions inherited from BT::ActionNodeBase
 ActionNodeBase (const std::string &name, const NodeConfiguration &config)
 
virtual NodeType type () const overridefinal
 
 ~ActionNodeBase () override=default
 
- Public Member Functions inherited from BT::LeafNode
 LeafNode (const std::string &name, const NodeConfiguration &config)
 
virtual ~LeafNode () override=default
 
- Public Member Functions inherited from BT::TreeNode
const NodeConfigurationconfig () const
 
template<typename T >
Result getInput (const std::string &key, T &destination) const
 
template<typename T >
Optional< T > getInput (const std::string &key) const
 
bool isHalted () const
 
const std::string & name () const
 Name of the instance, not the type. More...
 
const std::string & registrationName () const
 registrationName is the ID used by BehaviorTreeFactory to create an instance. More...
 
template<typename T >
Result setOutput (const std::string &key, const T &value)
 
void setStatus (NodeStatus new_status)
 
NodeStatus status () const
 
StatusChangeSubscriber subscribeToStatusChange (StatusChangeCallback callback)
 subscribeToStatusChange is used to attach a callback to a status change. When StatusChangeSubscriber goes out of scope (it is a shared_ptr) the callback is unsubscribed automatically. More...
 
 TreeNode (std::string name, NodeConfiguration config)
 TreeNode main constructor. More...
 
uint16_t UID () const
 
BT::NodeStatus waitValidStatus ()
 
virtual ~TreeNode ()=default
 

Public Attributes

bool will_fail_
 

Protected Member Functions

virtual BT::NodeStatus tick () override
 Method to be implemented by the user. More...
 
- Protected Member Functions inherited from BT::TreeNode
void modifyPortsRemapping (const PortsRemapping &new_remapping)
 
void setRegistrationID (StringView ID)
 

Private Attributes

bool halted_
 
Timepoint start_time_
 
std::chrono::milliseconds timeout_
 

Additional Inherited Members

- Public Types inherited from BT::TreeNode
typedef std::shared_ptr< TreeNodePtr
 
using StatusChangeCallback = StatusChangeSignal::CallableFunction
 
using StatusChangeSignal = Signal< TimePoint, const TreeNode &, NodeStatus, NodeStatus >
 
using StatusChangeSubscriber = StatusChangeSignal::Subscriber
 
- Static Public Member Functions inherited from BT::TreeNode
static Optional< StringViewgetRemappedKey (StringView port_name, StringView remapping_value)
 
static bool isBlackboardPointer (StringView str)
 
static StringView stripBlackboardPointer (StringView str)
 
- Protected Attributes inherited from BT::CoroActionNode
std::unique_ptr< Pimpl_p
 

Detailed Description

Definition at line 11 of file gtest_coroutines.cpp.

Constructor & Destructor Documentation

SimpleCoroAction::SimpleCoroAction ( milliseconds  timeout,
bool  will_fail,
const std::string &  node_name,
const BT::NodeConfiguration config 
)
inline

Definition at line 14 of file gtest_coroutines.cpp.

Member Function Documentation

virtual void SimpleCoroAction::halt ( )
inlineoverridevirtual

You may want to override this method. But still, remember to call this implementation too.

Example:

void MyAction::halt()
{
    // do your stuff here
    CoroActionNode::halt();
}

Reimplemented from BT::CoroActionNode.

Definition at line 24 of file gtest_coroutines.cpp.

void SimpleCoroAction::setRequiredTime ( Millisecond  ms)
inline

Definition at line 37 of file gtest_coroutines.cpp.

virtual BT::NodeStatus SimpleCoroAction::tick ( )
inlineoverrideprotectedvirtual

Method to be implemented by the user.

Implements BT::TreeNode.

Definition at line 43 of file gtest_coroutines.cpp.

bool SimpleCoroAction::wasHalted ( )
inline

Definition at line 32 of file gtest_coroutines.cpp.

Member Data Documentation

bool SimpleCoroAction::halted_
private

Definition at line 71 of file gtest_coroutines.cpp.

Timepoint SimpleCoroAction::start_time_
private

Definition at line 70 of file gtest_coroutines.cpp.

std::chrono::milliseconds SimpleCoroAction::timeout_
private

Definition at line 69 of file gtest_coroutines.cpp.

bool SimpleCoroAction::will_fail_

Definition at line 66 of file gtest_coroutines.cpp.


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


behaviortree_cpp
Author(s): Michele Colledanchise, Davide Faconti
autogenerated on Sat Jun 8 2019 18:04:05