Public Member Functions | Static Private Member Functions | Private Attributes | Friends | List of all members
gtsam::key_formatter Class Reference

#include <Key.h>

Public Member Functions

 key_formatter (KeyFormatter v)
 

Static Private Member Functions

static KeyFormatterget_property (std::ios_base &s)
 
static void *& property (std::ios_base &s)
 
static void set_property (std::ios_base &s, const KeyFormatter &f)
 

Private Attributes

KeyFormatter formatter_
 

Friends

GTSAM_EXPORT friend std::ostream & operator<< (std::ostream &, const key_formatter &)
 
GTSAM_EXPORT friend std::ostream & operator<< (std::ostream &, const StreamedKey &)
 

Detailed Description

Output stream manipulator that will format gtsam::Keys according to the given KeyFormatter, as long as Key values are wrapped in a gtsam::StreamedKey. LabeledSymbol and Symbol values do not have to be wrapped. usage: Key key = LabeledSymbol('x', 'A', 5); // cast to key type cout << key_formatter(MultiRobotKeyFormatter) << StreamedKey(key);

Definition at line 78 of file Key.h.

Constructor & Destructor Documentation

◆ key_formatter()

gtsam::key_formatter::key_formatter ( KeyFormatter  v)
inlineexplicit

Definition at line 80 of file Key.h.

Member Function Documentation

◆ get_property()

KeyFormatter * gtsam::key_formatter::get_property ( std::ios_base &  s)
staticprivate

Definition at line 108 of file Key.cpp.

◆ property()

void *& gtsam::key_formatter::property ( std::ios_base &  s)
staticprivate

Definition at line 95 of file Key.cpp.

◆ set_property()

void gtsam::key_formatter::set_property ( std::ios_base &  s,
const KeyFormatter f 
)
staticprivate

Definition at line 102 of file Key.cpp.

Friends And Related Function Documentation

◆ operator<< [1/2]

GTSAM_EXPORT friend std::ostream& operator<< ( std::ostream &  ,
const key_formatter  
)
friend

◆ operator<< [2/2]

GTSAM_EXPORT friend std::ostream& operator<< ( std::ostream &  ,
const StreamedKey  
)
friend

Member Data Documentation

◆ formatter_

KeyFormatter gtsam::key_formatter::formatter_
private

Definition at line 85 of file Key.h.


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


gtsam
Author(s):
autogenerated on Thu Jun 13 2024 03:17:21