Csound and CsoundAC API  5.17
Public Member Functions | Private Attributes
CsoundMYFLTArray Class Reference

CsoundMYFLTArray() More...

#include <cs_glue.hpp>

Public Member Functions

void Clear ()
 Clears the array pointer, and releases any memory that was allocated by calling the constructor with a positive number of elements.
 CsoundMYFLTArray ()
 CsoundMYFLTArray (int n)
MYFLT ** GetPtr ()
 Returns a MYFLT** pointer for use with csoundGetChannelPtr().
MYFLTGetPtr (int ndx)
 Returns the address of the element at index 'ndx' (counting from zero) as a MYFLT* pointer, or NULL if there is no array.
const char * GetStringValue ()
 Returns a string from the array (note: only do this with a pointer returned by csoundGetChannelPtr()), or NULL if there is no array.
double GetValue (int ndx)
 Returns the floating point value at index 'ndx' (counting from zero).
void GetValues (MYFLT *dst, int ndx, int n)
 Copies 'n' values from the array to 'dst', starting at index 'ndx' (counting from zero).
void SetPtr (MYFLT *ptr)
 Sets the array pointer to a MYFLT* value returned by a Csound API function (e.g.
void SetStringValue (const char *s, int maxLen)
 Stores a string in the array (note: only do this with a pointer returned by csoundGetChannelPtr()), optionally limiting the length to maxLen - 1 characters.
void SetValue (int ndx, double value)
 Stores a floating point value at index 'ndx' (counting from zero).
void SetValues (int ndx, double v0, double v1)
 Sets two floating point values starting at index 'ndx' (counting from zero).
void SetValues (int ndx, double v0, double v1, double v2)
 Sets three floating point values starting at index 'ndx' (counting from zero).
void SetValues (int ndx, double v0, double v1, double v2, double v3)
 Sets four floating point values starting at index 'ndx' (counting from zero).
void SetValues (int ndx, double v0, double v1, double v2, double v3, double v4)
 Sets five floating point values starting at index 'ndx' (counting from zero).
void SetValues (int ndx, double v0, double v1, double v2, double v3, double v4, double v5)
 Sets six floating point values starting at index 'ndx' (counting from zero).
void SetValues (int ndx, double v0, double v1, double v2, double v3, double v4, double v5, double v6)
 Sets seven floating point values starting at index 'ndx' (counting from zero).
void SetValues (int ndx, double v0, double v1, double v2, double v3, double v4, double v5, double v6, double v7)
 Sets eight floating point values starting at index 'ndx' (counting from zero).
void SetValues (int ndx, double v0, double v1, double v2, double v3, double v4, double v5, double v6, double v7, double v8)
 Sets nine floating point values starting at index 'ndx' (counting from zero).
void SetValues (int ndx, double v0, double v1, double v2, double v3, double v4, double v5, double v6, double v7, double v8, double v9)
 Sets ten floating point values starting at index 'ndx' (counting from zero).
void SetValues (int ndx, int n, const MYFLT *src)
 Copies 'n' values to the array from a source pointer, starting at index 'ndx' (counting from zero).
 ~CsoundMYFLTArray ()

Private Attributes

MYFLTp
void * pp

Detailed Description

CsoundMYFLTArray()

Creates a pointer for use with csoundGetChannelPtr(), csoundGetOutputBuffer(), or other functions that return a pointer to an array of floating point values.

CsoundMYFLTArray(int cnt)

Allocates an array of 'cnt' floating point values, for use with Csound API functions that take a MYFLT* pointer.

Constructor & Destructor Documentation

CsoundMYFLTArray::CsoundMYFLTArray ( )
CsoundMYFLTArray::CsoundMYFLTArray ( int  n)
CsoundMYFLTArray::~CsoundMYFLTArray ( )

Member Function Documentation

void CsoundMYFLTArray::Clear ( )

Clears the array pointer, and releases any memory that was allocated by calling the constructor with a positive number of elements.

MYFLT** CsoundMYFLTArray::GetPtr ( )
inline

Returns a MYFLT** pointer for use with csoundGetChannelPtr().

MYFLT* CsoundMYFLTArray::GetPtr ( int  ndx)
inline

Returns the address of the element at index 'ndx' (counting from zero) as a MYFLT* pointer, or NULL if there is no array.

Does not check if 'ndx' is valid.

References MYFLT.

const char* CsoundMYFLTArray::GetStringValue ( )

Returns a string from the array (note: only do this with a pointer returned by csoundGetChannelPtr()), or NULL if there is no array.

double CsoundMYFLTArray::GetValue ( int  ndx)
inline

Returns the floating point value at index 'ndx' (counting from zero).

No error checking is done, the array is assumed to exist and the index is assumed to be valid.

void CsoundMYFLTArray::GetValues ( MYFLT dst,
int  ndx,
int  n 
)
inline

Copies 'n' values from the array to 'dst', starting at index 'ndx' (counting from zero).

No error checking is done.

void CsoundMYFLTArray::SetPtr ( MYFLT ptr)
inline

Sets the array pointer to a MYFLT* value returned by a Csound API function (e.g.

csoundGetSpin() or csoundGetSpout()).

void CsoundMYFLTArray::SetStringValue ( const char *  s,
int  maxLen 
)

Stores a string in the array (note: only do this with a pointer returned by csoundGetChannelPtr()), optionally limiting the length to maxLen - 1 characters.

void CsoundMYFLTArray::SetValue ( int  ndx,
double  value 
)
inline

Stores a floating point value at index 'ndx' (counting from zero).

No error checking is done, the array is assumed to exist and the index is assumed to be valid.

References MYFLT.

void CsoundMYFLTArray::SetValues ( int  ndx,
double  v0,
double  v1 
)
inline

Sets two floating point values starting at index 'ndx' (counting from zero).

No error checking is done, the array is assumed to exist and the index is assumed to be valid.

References MYFLT.

void CsoundMYFLTArray::SetValues ( int  ndx,
double  v0,
double  v1,
double  v2 
)
inline

Sets three floating point values starting at index 'ndx' (counting from zero).

No error checking is done, the array is assumed to exist and the index is assumed to be valid.

References MYFLT.

void CsoundMYFLTArray::SetValues ( int  ndx,
double  v0,
double  v1,
double  v2,
double  v3 
)
inline

Sets four floating point values starting at index 'ndx' (counting from zero).

No error checking is done, the array is assumed to exist and the index is assumed to be valid.

References MYFLT.

void CsoundMYFLTArray::SetValues ( int  ndx,
double  v0,
double  v1,
double  v2,
double  v3,
double  v4 
)
inline

Sets five floating point values starting at index 'ndx' (counting from zero).

No error checking is done, the array is assumed to exist and the index is assumed to be valid.

References MYFLT.

void CsoundMYFLTArray::SetValues ( int  ndx,
double  v0,
double  v1,
double  v2,
double  v3,
double  v4,
double  v5 
)
inline

Sets six floating point values starting at index 'ndx' (counting from zero).

No error checking is done, the array is assumed to exist and the index is assumed to be valid.

References MYFLT.

void CsoundMYFLTArray::SetValues ( int  ndx,
double  v0,
double  v1,
double  v2,
double  v3,
double  v4,
double  v5,
double  v6 
)
inline

Sets seven floating point values starting at index 'ndx' (counting from zero).

No error checking is done, the array is assumed to exist and the index is assumed to be valid.

References MYFLT.

void CsoundMYFLTArray::SetValues ( int  ndx,
double  v0,
double  v1,
double  v2,
double  v3,
double  v4,
double  v5,
double  v6,
double  v7 
)
inline

Sets eight floating point values starting at index 'ndx' (counting from zero).

No error checking is done, the array is assumed to exist and the index is assumed to be valid.

References MYFLT.

void CsoundMYFLTArray::SetValues ( int  ndx,
double  v0,
double  v1,
double  v2,
double  v3,
double  v4,
double  v5,
double  v6,
double  v7,
double  v8 
)
inline

Sets nine floating point values starting at index 'ndx' (counting from zero).

No error checking is done, the array is assumed to exist and the index is assumed to be valid.

References MYFLT.

void CsoundMYFLTArray::SetValues ( int  ndx,
double  v0,
double  v1,
double  v2,
double  v3,
double  v4,
double  v5,
double  v6,
double  v7,
double  v8,
double  v9 
)
inline

Sets ten floating point values starting at index 'ndx' (counting from zero).

No error checking is done, the array is assumed to exist and the index is assumed to be valid.

References MYFLT.

void CsoundMYFLTArray::SetValues ( int  ndx,
int  n,
const MYFLT src 
)
inline

Copies 'n' values to the array from a source pointer, starting at index 'ndx' (counting from zero).

No error checking is done.

Field Documentation

MYFLT* CsoundMYFLTArray::p
private
void* CsoundMYFLTArray::pp
private