Public Member Functions | Private Member Functions | Private Attributes | List of all members
flexbe_core.behavior_library.BehaviorLibrary Class Reference
Inheritance diagram for flexbe_core.behavior_library.BehaviorLibrary:
Inheritance graph

Public Member Functions

def __init__ (self)
def count_behaviors (self)
def find_behavior (self, be_name)
def get_behavior (self, be_id)
def get_sourcecode_filepath (self, be_id, add_tmp=False)
def parse_packages (self)

Private Member Functions

def _add_behavior_manifests (self, path, pkg=None)

Private Attributes


Detailed Description

Provides access to all known behaviors.

Definition at line 10 of file

Constructor & Destructor Documentation

def flexbe_core.behavior_library.BehaviorLibrary.__init__ (   self)

Definition at line 15 of file

Member Function Documentation

def flexbe_core.behavior_library.BehaviorLibrary._add_behavior_manifests (   self,
  pkg = None 
Recursively add all behavior manifests in the given folder to the internal library.
If a package name is specified, only manifests referring to this package are added.

@type path: string
@param path: Path of the folder to be traversed.

@type pkg: string
@param pkg: Optional name of a package to only add manifests referring to this package.

Definition at line 30 of file

def flexbe_core.behavior_library.BehaviorLibrary.count_behaviors (   self)
Counts the available behaviors.

@return Number of behaviors.

Definition at line 103 of file

def flexbe_core.behavior_library.BehaviorLibrary.find_behavior (   self,
Searches for a behavior with the given name and returns it along with its ID.

@type be_name: string
@param be_name: Behavior ID to look up.

@return Tuple (be_id, be_entry) corresponding to the name or (None, None) if not found.

Definition at line 80 of file

def flexbe_core.behavior_library.BehaviorLibrary.get_behavior (   self,
Provides the library entry corresponding to the given ID.

@type be_id: int
@param be_id: Behavior ID to look up.

@return Corresponding library entry or None if not found.

Definition at line 64 of file

def flexbe_core.behavior_library.BehaviorLibrary.get_sourcecode_filepath (   self,
  add_tmp = False 
Constructs a file path to the source code of corresponding to the given ID.

@type be_id: int
@param be_id: Behavior ID to look up.

@type add_tmp: bool
@param add_tmp: Append "_tmp" to the file to consider a temporary version.

@return String containing the absolute path to the source code file.

Definition at line 111 of file

def flexbe_core.behavior_library.BehaviorLibrary.parse_packages (   self)
Parses all ROS packages to update the internal behavior library.

Definition at line 20 of file

Member Data Documentation


Definition at line 17 of file


Definition at line 16 of file

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

Author(s): Philipp Schillinger
autogenerated on Sun Dec 13 2020 04:01:39