Public Member Functions | Private Attributes | List of all members
BT::PortInfo Class Reference

#include <basic_types.h>

Inheritance diagram for BT::PortInfo:
Inheritance graph
[legend]

Public Member Functions

const AnydefaultValue () const
 
const std::string & defaultValueString () const
 
const std::string & description () const
 
PortDirection direction () const
 
 PortInfo (PortDirection direction, std::type_index type_info, StringConverter conv)
 
 PortInfo (PortDirection direction=PortDirection::INOUT)
 
template<typename T >
void setDefaultValue (const T &default_value)
 
void setDescription (StringView description)
 
- Public Member Functions inherited from BT::TypeInfo
const StringConverterconverter () const
 
bool isStronglyTyped () const
 
Any parseString (const char *str) const
 
Any parseString (const std::string &str) const
 
template<typename T >
Any parseString (const T &) const
 
const std::type_index & type () const
 
 TypeInfo ()
 
 TypeInfo (std::type_index type_info, StringConverter conv)
 
const std::string & typeName () const
 

Private Attributes

Any default_value_
 
std::string default_value_str_
 
std::string description_
 
PortDirection direction_
 

Additional Inherited Members

- Static Public Member Functions inherited from BT::TypeInfo
template<typename T >
static TypeInfo Create ()
 

Detailed Description

Definition at line 394 of file basic_types.h.

Constructor & Destructor Documentation

◆ PortInfo() [1/2]

BT::PortInfo::PortInfo ( PortDirection  direction = PortDirection::INOUT)
inline

Definition at line 397 of file basic_types.h.

◆ PortInfo() [2/2]

BT::PortInfo::PortInfo ( PortDirection  direction,
std::type_index  type_info,
StringConverter  conv 
)
inline

Definition at line 401 of file basic_types.h.

Member Function Documentation

◆ defaultValue()

const Any & BT::PortInfo::defaultValue ( ) const

Definition at line 412 of file basic_types.cpp.

◆ defaultValueString()

const std::string & BT::PortInfo::defaultValueString ( ) const

Definition at line 417 of file basic_types.cpp.

◆ description()

const std::string & BT::PortInfo::description ( ) const

Definition at line 407 of file basic_types.cpp.

◆ direction()

PortDirection BT::PortInfo::direction ( ) const

Definition at line 369 of file basic_types.cpp.

◆ setDefaultValue()

template<typename T >
void BT::PortInfo::setDefaultValue ( const T &  default_value)
inline

Definition at line 410 of file basic_types.h.

◆ setDescription()

void BT::PortInfo::setDescription ( StringView  description)

Definition at line 402 of file basic_types.cpp.

Member Data Documentation

◆ default_value_

Any BT::PortInfo::default_value_
private

Definition at line 430 of file basic_types.h.

◆ default_value_str_

std::string BT::PortInfo::default_value_str_
private

Definition at line 431 of file basic_types.h.

◆ description_

std::string BT::PortInfo::description_
private

Definition at line 429 of file basic_types.h.

◆ direction_

PortDirection BT::PortInfo::direction_
private

Definition at line 428 of file basic_types.h.


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


behaviortree_cpp_v4
Author(s): Davide Faconti
autogenerated on Fri Feb 28 2025 03:19:20