WsfAdvancedBehaviorTreeSequenceNode Class Reference
#include <WsfAdvancedBehaviorTreeNode.hpp>
Inheritance diagram for WsfAdvancedBehaviorTreeSequenceNode:
Collaboration diagram for WsfAdvancedBehaviorTreeSequenceNode:
Public Member Functions | |
| WsfAdvancedBehaviorTreeSequenceNode (const WsfScenario &aScenario) | |
| WsfAdvancedBehaviorTreeSequenceNode (const WsfAdvancedBehaviorTreeCompositeNode &aCompositeNode) | |
| WsfAdvancedBehaviorTreeSequenceNode & | operator= (const WsfAdvancedBehaviorTreeSequenceNode &aRhs)=delete |
| WsfAdvancedBehaviorTreeSequenceNode * | Clone () const override |
| Clone this node. | |
| BT::ReturnStatus | TickFunction () override |
| Tick forward and update the execution of this node, and its children. | |
| Public Member Functions inherited from WsfAdvancedBehaviorTreeCompositeNode | |
| WsfAdvancedBehaviorTreeCompositeNode (const WsfScenario &aScenario) | |
| WsfAdvancedBehaviorTreeCompositeNode (const WsfAdvancedBehaviorTreeCompositeNode &aSrc) | |
| ~WsfAdvancedBehaviorTreeCompositeNode () override=default | |
| WsfAdvancedBehaviorTreeCompositeNode & | operator= (const WsfAdvancedBehaviorTreeCompositeNode &)=delete |
| void | AddChild (std::shared_ptr< WsfAdvancedBehaviorTreeNode > aChildPtr) override |
| Add a child to this node. | |
| void | AddTree (ut::CloneablePtr< WsfAdvancedBehaviorTree > &aTreePtr) override |
| Add a tree child to this node. | |
| std::vector< std::shared_ptr< WsfAdvancedBehaviorTreeNode > > & | GetChildren () override |
| Return a list of current children held by this node. | |
| std::map< size_t, ut::CloneablePtr< WsfAdvancedBehaviorTree > > & | GetTrees () override |
| Return a list of current children trees held by this node. | |
| void | OutputTreeStructures (const double aSimTime) override |
| Output this nodes children trees structures to the event pipe. | |
| void | OutputTreeStates (const double aSimTime) override |
| Output this nodes tree states to the event pipe if they are outputting. | |
| const int | GetDepth () const override |
| Get the depth of this node recursively through it's children. | |
| void | Halt (const std::string &aReason) override |
| Halt the execution of this node and it's children. | |
| const bool | HasChildrenContainer () const override |
| Get if this node can have children. | |
| bool | Initialize (double aSimTime, WsfScriptContext *aParentContextPtr) override |
| Initializes this node. | |
| const double | PreconditionValue () const override |
| Returns a fitness value representing how important this node is. | |
| void | SetTree (WsfAdvancedBehaviorTree *aTreePtr) override |
| Set the owning tree for this node. | |
| void | TurnOff () override |
| Turns this node off, and it's children recursively. | |
| void | TurnOn () override |
| Turns this node on, and it's children recursively. | |
| void | ResetPreconditionVars () override |
| Reset the precondition ran and met var to false at the beginning of the tree tick, recursing through all children nodes. | |
| Public Member Functions inherited from WsfAdvancedBehaviorTreeNode | |
| WsfAdvancedBehaviorTreeNode (const WsfScenario &aScenario) | |
| WsfAdvancedBehaviorTreeNode (const WsfAdvancedBehaviorTreeNode &aSrc) | |
| ~WsfAdvancedBehaviorTreeNode () override | |
| WsfAdvancedBehaviorTreeNode & | operator= (const WsfAdvancedBehaviorTreeNode &)=delete |
| const time_t & | GetFileLastModTime () const |
| Return the last time the script this node was declared in was modified. | |
| const std::string & | GetFilePath () const |
| Return the file path to the script this node was declared in. | |
| std::shared_ptr< WsfAttributeContainer > | GetBlackboard () |
| Return a pointer to the blackboard for this node. | |
| const std::string & | GetNodeName () const |
| Get the name of this node. | |
| void | SetNodeName (const std::string &aName) |
| Set the name of this node. | |
| const std::string & | GetDescription () const |
| Get the description of this node. | |
| void | SetDescription (const std::string &aDesc) |
| Set the description of this node. | |
| const BT::ReturnStatus & | GetNodeStatus () const |
| Get the ReturnStatus of this node. | |
| const WsfScenario & | GetScenario () const |
| Return the current scenario. | |
| const char * | GetScriptClassName () const override |
| Return the script class name for this node. | |
| const WsfScriptContext & | GetScriptContext () const |
| Returns a reference to the script context for this node. | |
| WsfSimulation * | GetSimulation () const |
| Return a pointer to the simulation. | |
| const std::string & | GetPreconditionTooltip () const |
| Return the current precondition tooltip text for this node. | |
| const std::string & | GetExecuteTooltip () const |
| Return the current execute tooltip text for this node. | |
| const bool & | GetTurnedOn () const |
| Returns if this node is on. | |
| const bool & | HasParent () const |
| Get if this node has a parent. | |
| const unsigned int & | Id () const |
| Return the unique id for this node. | |
| const UtColor & | GetColor () const |
| Return this node's color. | |
| bool | HasDefinedColor () const |
| Return the string representation of this node's color. | |
| WsfPlatform * | GetOwningPlatform () const |
| Return a pointer to the owning platform of this node. | |
| WsfScriptProcessor * | GetOwningProcessor () const |
| Return a pointer to the owning processor of this node. | |
| WsfAdvancedBehaviorTree * | GetOwningTree () const |
| Return a pointer to the owning tree of this node. | |
| WsfAdvancedBehaviorTreeNode * | GetParent () const |
| Returns a pointer to the current parent of this node. | |
| const bool | PreconditionsMet () const |
| Returns a boolean representing if the precondition ran successfully or not. | |
| bool | ProcessInput (UtInput &aInput) override |
| Process input from a script. | |
| virtual bool | ProcessMessage (double aSimTime, const WsfMessage &aMessage) |
| Process a script message. | |
| virtual void | RegisterInput (UtInput &aInput) |
| Register a file path and last modified time from an input. | |
| void | SetFilePath (const std::string &aPath) |
| Set the file path for this node. | |
| void | SetHasParent (const bool aValue) |
| Set if this node has a parent. | |
| void | SetParent (WsfAdvancedBehaviorTreeNode *aNodePtr) |
| Set the parent of this node. | |
| void | SetTooltip (const std::string &aText, const bool aSendEvent=false) |
| Set the tooltip text for this node. | |
| void | SetPreconditionTooltip (const std::string &aText, const bool aSendEvent=false) |
| Set the tooltip text for this node. | |
| void | SetExecuteTooltip (const std::string &aText, const bool aSendEvent=false) |
| Set the tooltip text for this node. | |
| virtual BT::ReturnStatus | Tick () |
| Tick forward and update the execution of this node. | |
| bool | ExecutedLastTick () const |
| WsfAdvancedBehaviorTreeNode * | FindNode (const std::string &aNodeName) |
| Find the node based on the script-configured name. | |
| void | FindLastExecuted (std::vector< WsfAdvancedBehaviorTreeNode * > &aLastExecuted) |
| Find and return all nodes exectued last tick. | |
| void | SetIsTreeRootNode (const bool aState) |
| Set if this node is the root node for a tree. | |
| bool | GetIsTreeRootNode () const |
| Get if this tree is a root node for a tree. | |
| WsfScriptStateMachine * | ChildStateMachine () |
| WsfAdvancedBehaviorTreeNode * | GetTopRootNode () |
| Get the top-most root node (ignore nodes considered as tree root nodes). | |
| UtScript * | GetExecuteScript () |
| Return a pointer to the execute script for this node. | |
| void | SetInitScript (UtScript *aScriptPtr) |
| Public Member Functions inherited from WsfObject | |
| WsfObject () | |
| This is the constructor for the WsfObject class. | |
| ~WsfObject () override | |
| This is the destructor for the WsfObject class. | |
| const char * | GetScriptClassName () const override |
| const std::string & | GetType () const |
| WsfStringId | GetTypeId () const |
| Get the string ID of the 'type' of the object. | |
| void | SetType (WsfStringId aType) |
| const std::string & | GetBaseType () const |
| WsfStringId | GetBaseTypeId () const |
| const TypeList & | GetTypeList () const |
| bool | IsA_TypeOf (WsfStringId aType) const |
| WsfObject & | operator= (const WsfObject &aRhs) |
| Assignment operator. | |
| template<typename T> | |
| void | Serialize (T &aBuff) |
| For XIO (de)serialization. | |
| const std::string & | GetName () const |
| WsfStringId | GetNameId () const |
| void | SetName (WsfStringId aName) |
Additional Inherited Members | |
| Public Types inherited from WsfObject | |
| typedef std::vector< WsfStringId > | TypeList |
| The list of types returned by GetTypeList. | |
| Static Public Member Functions inherited from WsfAdvancedBehaviorTreeNode | |
| static unsigned int | GetUniqueNodeId () |
| Get a unique int id for this node. | |
| static void | Reset () |
| Reset the unique int counter. | |
| Protected Member Functions inherited from WsfAdvancedBehaviorTreeCompositeNode | |
| const bool | AreChildrenRunning () const |
| Get if any children are running. | |
| const unsigned int | GetLastEnabledChild () const |
| Get the last(rightmost) enabled child in this node's children. | |
| const unsigned int | GetNumEnabledChildren () const |
| Get the number of enabled children. | |
| void | HaltChildren (unsigned int aIndex, const std::string &aReason) override |
| Halt the execution of this node's children starting at an index. | |
| void | HaltRunning (const std::string &aReason) |
| Halt the execution of this node's children that are running. | |
| Protected Member Functions inherited from WsfAdvancedBehaviorTreeNode | |
| bool | RegisterExternVariable (const std::string &aVariableType, const std::string &aVariableName) |
| Register an external variable. | |
| UtScriptContext * | GetScriptAccessibleContext () const override |
| Return the context from the script. | |
| void | SetFileInfo (const std::string &aPath, const time_t &aModTime) |
| Set the file path and last mod time for this node. | |
| void | SetNodeStatus (const BT::ReturnStatus aStatus) |
| Set the ReturnStatus of this node. | |
| WsfObject (const WsfObject &aSrc) | |
| Copy constructor (for Clone()). | |
| Protected Attributes inherited from WsfAdvancedBehaviorTreeCompositeNode | |
| std::vector< std::shared_ptr< WsfAdvancedBehaviorTreeNode > > | mChildren |
| std::map< size_t, ut::CloneablePtr< WsfAdvancedBehaviorTree > > | mTrees |
| Protected Attributes inherited from WsfAdvancedBehaviorTreeNode | |
| unsigned int | mId {0} |
| const WsfScenario & | mScenario |
| std::shared_ptr< WsfAttributeContainer > | mBlackboard |
| WsfScriptContext * | mContextPtr {nullptr} |
| WsfScriptMessageHandler * | mMessageHandlerPtr {nullptr} |
| WsfAdvancedBehaviorTreeNode * | mParentPtr {nullptr} |
| WsfAdvancedBehaviorTree * | mParentTreePtr {nullptr} |
| WsfScriptStateMachine * | mFiniteStateMachinePtr {nullptr} |
| int | mStateIndex {0} |
| time_t | mFileLastModTime |
| bool | mDebug {false} |
| bool | mInitialized {false} |
| bool | mTurnedOn {true} |
| bool | mIsTreeRootNode {false} |
| bool | mHasParent {false} |
| bool | mExecutedLastTick {false} |
| bool | mInPrecondition {false} |
| bool | mPreconditionRan {false} |
| bool | mPreconditionMet {false} |
| BT::ReturnStatus | mReturnStatus {BT::cIDLE} |
| std::string | mFullPathFileName {""} |
| std::string | mName {""} |
| std::string | mDescription {""} |
| std::string | mPreconditionTooltip {""} |
| std::string | mExecuteTooltip {""} |
| double | mPreconditionTooltipTimestamp {-1.0} |
| double | mExecuteTooltipTimestamp {-1.0} |
| UtScript * | mOnInitScriptPtr {nullptr} |
| UtScript * | mNewExecuteScriptPtr {nullptr} |
| UtScript * | mNewFailScriptPtr {nullptr} |
| UtScript * | mPreconditionScriptPtr {nullptr} |
| UtScript * | mExecuteScriptPtr {nullptr} |
| UtColor | mColor |
| bool | mHasDefinedColor |
Constructor & Destructor Documentation
◆ WsfAdvancedBehaviorTreeSequenceNode() [1/2]
|
explicit |
References WsfAdvancedBehaviorTreeNode::mName, WsfObject::SetName(), WsfObject::SetType(), and WsfAdvancedBehaviorTreeCompositeNode::WsfAdvancedBehaviorTreeCompositeNode().
Referenced by Clone(), and operator=().
◆ WsfAdvancedBehaviorTreeSequenceNode() [2/2]
|
explicit |
Member Function Documentation
◆ Clone()
|
overridevirtual |
Clone this node.
Reimplemented from WsfAdvancedBehaviorTreeCompositeNode.
References WsfAdvancedBehaviorTreeSequenceNode().
◆ operator=()
|
delete |
References TickFunction(), and WsfAdvancedBehaviorTreeSequenceNode().
◆ TickFunction()
|
overridevirtual |
Tick forward and update the execution of this node, and its children.
Reimplemented from WsfAdvancedBehaviorTreeNode.
References BT::cDISABLED, BT::cIDLE, BT::cRUNNING, BT::cSUCCESS, WsfAdvancedBehaviorTreeCompositeNode::GetLastEnabledChild(), WsfAdvancedBehaviorTreeNode::GetTurnedOn(), WsfAdvancedBehaviorTreeCompositeNode::HaltChildren(), WsfAdvancedBehaviorTreeCompositeNode::mChildren, and WsfAdvancedBehaviorTreeNode::SetNodeStatus().
Referenced by operator=().
The documentation for this class was generated from the following files: