Public Member Functions | Private Attributes | List of all members
hebi::Command::BoolField Class Referencefinal

A message field representable by a bool value. More...

#include <command.hpp>

Public Member Functions

 BoolField (HebiCommandPtr internal, HebiCommandBoolField field)
 
void clear ()
 Removes any currently set value for this field. More...
 
bool get () const
 If the field has a value, returns that value; otherwise, returns false. More...
 
bool has () const
 True if (and only if) the field has a value. More...
 
void set (bool value)
 Sets the field to a given value. More...
 

Private Attributes

HebiCommandBoolField const field_
 
HebiCommandPtr const internal_
 

Detailed Description

A message field representable by a bool value.

Definition at line 191 of file command.hpp.

Constructor & Destructor Documentation

hebi::Command::BoolField::BoolField ( HebiCommandPtr  internal,
HebiCommandBoolField  field 
)

Definition at line 136 of file command.cpp.

Member Function Documentation

void hebi::Command::BoolField::clear ( )

Removes any currently set value for this field.

Definition at line 162 of file command.cpp.

bool hebi::Command::BoolField::get ( ) const

If the field has a value, returns that value; otherwise, returns false.

Definition at line 146 of file command.cpp.

bool hebi::Command::BoolField::has ( ) const

True if (and only if) the field has a value.

Definition at line 141 of file command.cpp.

void hebi::Command::BoolField::set ( bool  value)

Sets the field to a given value.

Definition at line 156 of file command.cpp.

Member Data Documentation

HebiCommandBoolField const hebi::Command::BoolField::field_
private

Definition at line 209 of file command.hpp.

HebiCommandPtr const hebi::Command::BoolField::internal_
private

Definition at line 208 of file command.hpp.


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


hebiros
Author(s): Xavier Artache , Matthew Tesch
autogenerated on Thu Sep 3 2020 04:10:59