Frequently Used Includes

This page provides an overview to quickly find what to include to use common types and commands. Dependencies need to be entered in the CMakeLists.txt

ArmarX Macros (Mainly for Logging and Exceptions)

Output macros: ARMARX_DEBUG, ARMARX_VERBOSE, ARMARX_INFO, ARMARX_WARNING, ARMARX_ERROR

• Include:

  #include <ArmarXCore/core/logging/Logging.h>

• Dependency:

  ArmarXCore

String macros: QUOTED, VAROUT

• Include:

  #include <ArmarXCore/core/util/StringHelpers.h>

• Dependency:

  ArmarXCore

Assertion macros: ARMARX_CHECK, ARMARX_CHECK_NOT_NULL, and others

• Include:

  #include <ArmarXCore/core/exceptions/local/ExpressionException.h>>

• Dependency:

  ArmarXCore

• For details, see the code file. This includes the further assertions ARMARX_CHECK_EXPRESSION (equal to ARMARX_CHECK), ARMARX_CHECK_BINARY_PREDICATE, ARMARX_CHECK_LESS, ARMARX_CHECK_LESS_EQUAL, ARMARX_CHECK_GREATER, ARMARX_CHECK_GREATER_EQUAL, ARMARX_CHECK_EQUAL, ARMARX_CHECK_NOT_EQUAL, ARMARX_CHECK_POSITIVE, ARMARX_CHECK_NONNEGATIVE, ARMARX_CHECK_FITS_SIZE, ARMARX_CHECK_CLOSE, ARMARX_CHECK_FINITE, ARMARX_CHECK_IS_NULL, ARMARX_CHECK_NULL, ARMARX_CHECK_EMPTY, ARMARX_CHECK_NOT_EMPTY, ARMARX_CHECK_MULTIPLE_OF, ARMARX_CHECK_NOT_MULTIPLE_OF, and ARMARX_CHECK_AND_THROW.

Basic Types

Time: armarx::DateTime (equal to armarx::core::time::DateTime)

• Include:

  #include <ArmarXCore/core/time/DateTime.h>

• Dependency:

  ArmarXCore

Duration: armarx::Duration (equal to armarx::core::time::Duration)

• Include:

  #include <ArmarXCore/core/time/Duration.h>

• Dependency:

  ArmarXCore

Package path: armarx::PackagePath

• Include:

  #include <ArmarXCore/core/PackagePath.h>

• Dependency:

  ArmarXCore

Proxies and Clients

Memory Name System: armarx::armem::client::MemoryNameSystem

• Include:

  #include <RobotAPI/libraries/armem/client/MemoryNameSystem.h>

• Dependency:

  armem

Auxiliary Functions

String manipulation

• Include:

  #include <SimoxUtility/algorithm/string/string_tools.h>

• Dependency:

  SimoxUtility  # but ArmarXCore is sufficient