My Project
 All Classes Files Functions Variables Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | List of all members
gcp::matlab::MexParser Class Reference

Public Member Functions

 MexParser ()
 
 MexParser (const mxArray *)
 
void setTo (const mxArray *)
 
void setTo (const mxArray **)
 
virtual ~MexParser ()
 
bool isDouble ()
 
bool isLogical ()
 
bool isUchar ()
 
bool isUint ()
 
bool isString ()
 
bool isComplex ()
 
int getNumberOfDimensions ()
 
const int * getDimensions ()
 
int getDimension (unsigned iDim)
 
unsigned int getNumberOfElements ()
 
int getMaxDimension ()
 
bool isStruct ()
 
unsigned int getNumberOfFields ()
 
unsigned getNumberOfElements (mxArray *arr, std::string fieldName)
 
unsigned getNumberOfElements (const mxArray *arr, std::string fieldName)
 
unsigned getNumberOfElements (std::string fieldName)
 
const mxArray * getField (std::string fieldName)
 
bool fieldExists (std::string fieldName)
 
double * getFieldAsDouble (std::string fieldName)
 
double * getImagFieldAsDouble (std::string fieldName)
 
unsigned * getFieldAsUint (std::string fieldName)
 
unsigned char * getFieldAsUchar (std::string fieldName)
 
bool * getFieldAsLogical (std::string fieldName)
 
std::string getFieldAsString (std::string fieldName)
 
void printDimensions ()
 
double * getDoubleData ()
 
double getDoubleVal (unsigned i1, unsigned i2)
 
double getDoubleVal (unsigned i1, unsigned i2, unsigned i3)
 
float * getFloatData ()
 
bool * getLogicalData ()
 
unsigned char * getUcharData ()
 
unsigned * getUintData ()
 
unsigned int getUintVal (unsigned i1, unsigned i2)
 
unsigned int getUintVal (unsigned i1, unsigned i2, unsigned i3)
 
double * getImagDoubleData ()
 
std::string getString ()
 
bool operator== (MexParser &mp)
 
bool operator!= (MexParser &mp)
 

Static Public Member Functions

static bool isDouble (mxArray *arr)
 
static bool isDouble (const mxArray *arr)
 
static bool isLogical (mxArray *arr)
 
static bool isLogical (const mxArray *arr)
 
static bool isUchar (mxArray *arr)
 
static bool isUchar (const mxArray *arr)
 
static bool isUint (mxArray *arr)
 
static bool isUint (const mxArray *arr)
 
static bool isString (mxArray *arr)
 
static bool isString (const mxArray *arr)
 
static bool isComplex (mxArray *arr)
 
static bool isComplex (const mxArray *arr)
 
static int getNumberOfDimensions (mxArray *arr)
 
static int getNumberOfDimensions (const mxArray *arr)
 
static const int * getDimensions (mxArray *arr)
 
static const int * getDimensions (const mxArray *arr)
 
static int getDimension (mxArray *arr, unsigned iDim)
 
static int getDimension (const mxArray *arr, unsigned iDim)
 
static unsigned int getNumberOfElements (mxArray *arr)
 
static unsigned int getNumberOfElements (const mxArray *arr)
 
static bool isStruct (mxArray *arr)
 
static bool isStruct (const mxArray *arr)
 
static unsigned int getNumberOfFields (mxArray *arr)
 
static unsigned int getNumberOfFields (const mxArray *arr)
 
static const mxArray * getField (const mxArray *arr, std::string fieldName)
 
static bool fieldExists (const mxArray *arr, std::string fieldName)
 
static double * getFieldAsDouble (mxArray *arr, std::string fieldName)
 
static double * getFieldAsDouble (const mxArray *arr, std::string fieldName)
 
static double * getImagFieldAsDouble (mxArray *arr, std::string fieldName)
 
static double * getImagFieldAsDouble (const mxArray *arr, std::string fieldName)
 
static unsigned * getFieldAsUint (mxArray *arr, std::string fieldName)
 
static unsigned * getFieldAsUint (const mxArray *arr, std::string fieldName)
 
static unsigned char * getFieldAsUchar (mxArray *arr, std::string fieldName)
 
static unsigned char * getFieldAsUchar (const mxArray *arr, std::string fieldName)
 
static bool * getFieldAsLogical (mxArray *arr, std::string fieldName)
 
static bool * getFieldAsLogical (const mxArray *arr, std::string fieldName)
 
static std::string getFieldAsString (mxArray *arr, std::string fieldName)
 
static std::string getFieldAsString (const mxArray *arr, std::string fieldName)
 
static double * getDoubleData (mxArray *arr)
 
static double * getDoubleData (const mxArray *arr)
 
static float * getFloatData (mxArray *arr)
 
static float * getFloatData (const mxArray *arr)
 
static bool * getLogicalData (mxArray *arr)
 
static bool * getLogicalData (const mxArray *arr)
 
static unsigned char * getUcharData (mxArray *arr)
 
static unsigned char * getUcharData (const mxArray *arr)
 
static unsigned * getUintData (mxArray *arr)
 
static unsigned * getUintData (const mxArray *arr)
 
static double * getImagDoubleData (mxArray *arr)
 
static double * getImagDoubleData (const mxArray *arr)
 
static std::string getString (mxArray *arr)
 
static std::string getString (const mxArray *arr)
 
static bool dimensionsMatch (mxArray *arr1, mxArray *arr2)
 
static bool dimensionsMatch (const mxArray *arr1, const mxArray *arr2)
 

Constructor & Destructor Documentation

MexParser::MexParser ( )

Constructor.

MexParser::MexParser ( const mxArray *  arr)

....................................................................... Constructor.

MexParser::~MexParser ( )
virtual

Destructor.

....................................................................... Destructor.

Member Function Documentation

bool MexParser::dimensionsMatch ( mxArray *  arr1,
mxArray *  arr2 
)
static

....................................................................... Return true if the dimensions of two mxArrays match

int MexParser::getDimension ( unsigned  iDim)

....................................................................... Return the number of elements in a dimension

const int * MexParser::getDimensions ( mxArray *  arr)
static

....................................................................... Return the vector of dimensions for this array

double * MexParser::getDoubleData ( )

....................................................................... Get a pointer to double data

float * MexParser::getFloatData ( )

....................................................................... Get a pointer to float data

double * MexParser::getImagDoubleData ( )

....................................................................... Get a pointer to imaginary data, as a double array

bool * MexParser::getLogicalData ( )

....................................................................... Get a pointer to logical data

int MexParser::getNumberOfDimensions ( mxArray *  arr)
static

....................................................................... Return the dimensionality of an mxArray

unsigned int MexParser::getNumberOfElements ( )

....................................................................... Return the dimensionality of an mxArray

unsigned int MexParser::getNumberOfFields ( mxArray *  arr)
static

....................................................................... Return the dimensionality of an mxArray

unsigned int MexParser::getNumberOfFields ( )

....................................................................... Return the dimensionality of an mxArray

std::string MexParser::getString ( )

....................................................................... Get a pointer to string data

unsigned char * MexParser::getUcharData ( )

....................................................................... Get a pointer to unsigned data

unsigned * MexParser::getUintData ( )

....................................................................... Get a pointer to unsigned data

bool MexParser::isComplex ( )

....................................................................... Return if this object represents complex data

bool MexParser::isDouble ( )

....................................................................... Return if this object represents double data

bool MexParser::isLogical ( )

....................................................................... Return if this object represents unsigned data

bool MexParser::isString ( )

....................................................................... Return if this object represents string data

bool MexParser::isStruct ( const mxArray *  arr)
static

....................................................................... Return true if the array is a struct

bool MexParser::isUchar ( )

....................................................................... Return if this object represents unsigned data

bool MexParser::isUint ( )

....................................................................... Return if this object represents unsigned data

void MexParser::printDimensions ( )

....................................................................... Printe the dimensionality of this array

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