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

Description

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

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

#include <Utilities.h>

Public Member Functions

 List ()
 Default constructor - sets "List" to be the head of expression with no arguments. More...
 
 List (int argCount)
 Create a WSStream-compatible structure that corresponds to a List of given length. 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

◆ List() [1/2]

LLU::WS::List::List ( )
inline

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

◆ List() [2/2]

LLU::WS::List::List ( int  argCount)
inlineexplicit

Create a WSStream-compatible structure that corresponds to a List of given length.

Parameters
argCount- number of arguments for the List expression, i.e. length of the list

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