XLL+ Class Library

COper Methods

The methods of the COper class are listed here.

Construction

public methodCOperConstructs a COper object

Operations

public methodInitInitialise the OPER contents
public methodClearReclaim resources from OPER

Type inspection

public methodIsArrayDoes the OPER contain an array?
public methodIsDoubleDoes the OPER contain a double-precision floating point number?
public methodIsErrorDoes the OPER contain an error?
public methodIsBoolDoes the OPER contain a boolean?
public methodIsStringDoes the OPER contain a string?
public methodIsEmptyIs the OPER empty?
public methodIsMissingIs the OPER missing (i.e. omitted from the caller's argument list)?
public methodIsPresentIs the OPER neither missing nor empty?

Assignment operators

public methodoperator =Assigns a new value to the OPER, using a variety of input types

Output casting operators

public methodoperator doubleReturns a numeric value
public methodoperator CStringReturns a string value
public methodoperator BOOLReturns a boolean value
public methodoperator boolReturns a boolean value
public methodoperator []Returns an item from an array

Input functions

public methodFromDoubleAssigns an floating-point numeric value and data type to the OPER
public methodFromErrorAssigns an error value and data type to the OPER
public methodFromBoolAssigns a boolean value and data type to the OPER
public methodFromStringAssigns a string value and data type to the OPER
public methodFromDoubleArrayAssigns the OPER to be an array of double's, and copies values into the array

Output functions

public methodToDoubleRetrieves a numeric value from the OPER
public methodToStringReturns a string value
public methodToBoolReturns a boolean value
public methodToDoubleArrayCopies the contents of an OPER into a 'C' array of doubles or pointers to doubles
public methodReadValueReads a single value from an COper or a cell of an array COper

Optional input functions

public methodReadOptionalReads an optional argument from an OPER
public methodReadOptReads an optional argument from an OPER, optionally using a default for omitted arguments

Array functions

public methodGetWidthReturns the number of columns in an array
public methodGetHeightReturns the number of rows in an array
public methodGetDimsGets the number of rows and columns in an array
public methodGetCountReturns the number of cells in an array
public methodCellReturns a reference to an item in an array
public methodIsVectorReturns TRUE if the OPER contains 1 row and/or 1 column
public methodGetVectorCountReturns the number of cells in an array
public methodVectorCellReturns a reference to an item in a one-dimensional array
public methodAllocArrayAssigns the OPER to be an array, sets it to a size and allocates the memory to contain its items
public methodFreeArrayReleases the resources of an array's items

Matrix & vector functions

public methodReadVectorReads a row or a column from an array into a vector of numbers or strings
public methodReadColumnReads a column from an array into a vector of numbers or strings
public methodReadRowReads a row from an array into a vector of numbers or strings
public methodReadArrayIntoOrderedCollection1DReads a row or a column from an array into an ordered collection of numbers or strings
public methodReadArrayIntoSet1DReads a row or a column from an array into an indexed collection of numbers or strings
public methodReadMatrixReads data from a 2-dimensional array into a matrix of numbers or strings
public methodReadGroupItemReads a single value from an array into a number or string

Deprecated matrix & vector functions

public methodColToVectorReads a column from an array into a vector of numbers or strings
public methodRowToVectorReads a row from an array into a vector of numbers or strings
public methodToMatrixReads an array argument into a two-dimensional matrix of numbers or strings
public methodReadVectorItemReads a single value from an array into a number or string

Requirements

Header: xllplus.h

See Also

COper Class | xllplus.h | CXlOper object