XLKit  0.1.0
 All Classes Files Functions Typedefs Macros Groups
Classes | Public Member Functions | List of all members
xlkit::XLKIT_VERSION_NAME::xlOper4 Class Reference

C++ methods that operate on top of an XLOPER struct. More...

#include <xlOperand.hpp>

Inheritance diagram for xlkit::XLKIT_VERSION_NAME::xlOper4:

Classes

class  CellMatrixRef
 Proxy class into an operand's cell matrix (mutable) More...
 
class  ConstCellMatrixRef
 Proxy class into an operand's cell matrix (non-mutable) More...
 

Public Member Functions

 xlOper4 ()
 Default constructor, initializes as xltypeMissing.
 
 xlOper4 (const xlOper4 &other)
 
 xlOper4 (xlOper4 &&other)
 
 xlOper4 (double v)
 Construct a double precision floating point number.
 
 xlOper4 (int v)
 Construct an integer.
 
 xlOper4 (const std::string &v)
 Construct from an std::string.
 
 xlOper4 (const char *v)
 Construct from a C-style null-terminated string.
 
 xlOper4 (bool v)
 Construct a bool.
 
 xlOper4 (xlError num)
 Construct an error number (xlerrValue, xlerrNA, etc..) More...
 
 xlOper4 (int rows, int cols, xlOper4 *init_val=NULL)
 Construct a cell matrix of given size. More...
 
 xlOper4 (ConstCellMatrixRef cell_ref)
 Construct a copy of a cell matrix.
 
void reset ()
 Free allocated memory and reset to initial state (xltypeMissing)
 
xlOper4 & operator= (const xlOper4 &other)
 Assignment operator.
 
xlOper4 & operator= (xlOper4 &&other)
 Assignment move operator.
 
template<typename T >
T get () const
 
template<>
double get () const
 
template<>
int get () const
 
template<>
std::string get () const
 
template<>
bool get () const
 
template<>
xlError get () const
 
template<>
ConstCellMatrixRef get () const
 
CellMatrixRef setMatrix (int rows, int cols, xlOper4 *init_val=NULL)
 Make a matrix of the given size and return a ref to it. More...
 
int stringLength () const
 For a string, return its length.
 
int cellMatrixRows () const
 For a cell matrix, return its number of rows.
 
int cellMatrixCols () const
 For a cell matrix, return its number of columns.
 
bool isDouble () const
 Test operand type.
 
bool isInteger () const
 
bool isString () const
 
bool isBool () const
 
bool isError () const
 
bool isMissing () const
 
bool isCellMatrix () const
 
CellMatrixRef asCellMatrixRef ()
 Obtain cell matrix reference.
 
ConstCellMatrixRef asCellMatrixRef () const
 
void set (double v)
 Set a new value.
 
void set (int v)
 
void set (const std::string &v)
 
void set (const char *v)
 
void set (bool v)
 
void set (xlError num)
 
void set (ConstCellMatrixRef src)
 

Friends

class xlOper4::CellMatrixRef
 
class xlOper4::ConstCellMatrixRef
 

Detailed Description

C++ methods that operate on top of an XLOPER struct.

Note
xlOper4 must not contain any data so that its memory layout is identical to an XLOPER. The two direcly inherited members are the union val and the uint16_t xltype.

Constructor & Destructor Documentation

xlkit::XLKIT_VERSION_NAME::xlOper4::xlOper4 ( xlError  num)
inlineexplicit

Construct an error number (xlerrValue, xlerrNA, etc..)

Note
See xlcall.h
xlkit::XLKIT_VERSION_NAME::xlOper4::xlOper4 ( int  rows,
int  cols,
xlOper4 *  init_val = NULL 
)
inlineexplicit

Construct a cell matrix of given size.

Note
If init_val, is not given, it will be set to a matrix of of all xltypeMissing elements.

Member Function Documentation

CellMatrixRef xlkit::XLKIT_VERSION_NAME::xlOper4::setMatrix ( int  rows,
int  cols,
xlOper4 *  init_val = NULL 
)
inline

Make a matrix of the given size and return a ref to it.

Note
If init_val, is not given, all elements will be xltypeMissing.
The documentation for this class was generated from the following file: