RobWorkProject  23.9.11-
Public Types | Public Member Functions | List of all members
Mathematica::Symbol Class Reference

A symbol primitive. More...

#include <Mathematica.hpp>

Inherits Mathematica::Expression.

Public Types

typedef rw::core::Ptr< SymbolPtr
 Smart pointer type.
 
- Public Types inherited from Mathematica::Expression
enum  Type {
  String , Integer , Real , Symbol ,
  Function , Array
}
 Type of expression. More...
 
typedef rw::core::Ptr< ExpressionPtr
 Smart pointer type.
 
typedef enum rwlibs::mathematica::Mathematica::Expression::Type Type
 Type of expression.
 

Public Member Functions

 Symbol (const Symbol &symbol)
 Copy constructor. More...
 
 Symbol (const char *value)
 Construct new symbol. More...
 
 Symbol (const std::string &name)
 Construct new symbol. More...
 
virtual ~Symbol ()
 Destructor.
 
Type getType () const
 Get the type of expression. More...
 
void out (std::ostream &stream) const
 Print to output stream. More...
 
virtual Expression::Ptr clone () const
 Make a copy of the expression. More...
 
const std::string getName () const
 Get the name of the symbol. More...
 

Additional Inherited Members

- Static Protected Member Functions inherited from Mathematica::Expression
template<typename Type >
static void toList (std::list< rw::core::Ptr< Type >> &)
 Helper function for extracting a list of arguments when given as a variable number of arguments. More...
 
template<typename Type , typename Exp , typename... T>
static void toList (std::list< rw::core::Ptr< Type >> &list, const Exp &r, T... t)
 Helper function for extracting a list of arguments when given as a variable number of arguments. More...
 

Detailed Description

A symbol primitive.

Constructor & Destructor Documentation

◆ Symbol() [1/3]

Symbol ( const Symbol symbol)
inline

Copy constructor.

Parameters
symbol[in] symbol to copy.

◆ Symbol() [2/3]

Symbol ( const char *  value)
inline

Construct new symbol.

Parameters
value[in] the name.

◆ Symbol() [3/3]

Symbol ( const std::string &  name)
inline

Construct new symbol.

Parameters
name[in] the name.

Member Function Documentation

◆ clone()

virtual Expression::Ptr clone ( ) const
inlinevirtual

Make a copy of the expression.

Returns
a new copy.

Implements Mathematica::Expression.

◆ getName()

const std::string getName ( ) const
inline

Get the name of the symbol.

Returns
the name.

◆ getType()

Type getType ( ) const
inlinevirtual

Get the type of expression.

Returns
the type.

Implements Mathematica::Expression.

◆ out()

void out ( std::ostream &  stream) const
inlinevirtual

Print to output stream.

Parameters
stream[in/out] the stream to print to.

Implements Mathematica::Expression.


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