LibraryLink Utilities  3.0.1
Modern C++ wrapper over LibraryLink and WSTP
LLU::WS::Missing Struct Reference

Description

Special type of a Function which corresponds to the Missing expression when exchanged with the Kernel via WSStream.

+ Inheritance diagram for LLU::WS::Missing:
+ Collaboration diagram for LLU::WS::Missing:

#include <Utilities.h>

Public Member Functions

 Missing ()
 Default constructor - sets "Missing" to be the head of expression with no arguments. More...
 
 Missing (std::string r)
 Create a WSStream-compatible structure that corresponds to a Missing expression with given "reason". More...
 
const std::string & why () const
 Get the first argument of the expression which is the reason for the data's being missing. More...
 
int getArgc () const
 Get argument count. More...
 
void setArgc (int newArgc)
 Set argument count. More...
 
const std::string & getHead () const
 Get Symbol name/head. More...
 
void setHead (std::string h)
 Set Symbol name/head. More...
 

Constructor & Destructor Documentation

◆ Missing() [1/2]

LLU::WS::Missing::Missing ( )
inline

Default constructor - sets "Missing" to be the head of expression with no arguments.

◆ Missing() [2/2]

LLU::WS::Missing::Missing ( std::string  r)
inlineexplicit

Create a WSStream-compatible structure that corresponds to a Missing expression with given "reason".

Parameters
r- reason for the Missing

Member Function Documentation

◆ getArgc()

int LLU::WS::Function::getArgc ( ) const
inherited

Get argument count.

Returns
number of arguments this function takes

◆ getHead()

const std::string & LLU::WS::Symbol::getHead ( ) const
inherited

Get Symbol name/head.

Returns
head

◆ setArgc()

void LLU::WS::Function::setArgc ( int  newArgc)
inherited

Set argument count.

Parameters
newArgc- new value for argument count

◆ setHead()

void LLU::WS::Symbol::setHead ( std::string  h)
inherited

Set Symbol name/head.

Parameters
h- new head for the Symbol

◆ why()

const std::string& LLU::WS::Missing::why ( ) const
inline

Get the first argument of the expression which is the reason for the data's being missing.

Returns
the reason, typically "NotApplicable", "Unknown", "NotAvailable", "Nonexistent", etc.
See also
https://reference.wolfram.com/language/ref/Missing.html