array

class array : public xobj

XSIL Array class.

Inheritance:

Public Methods
array(void): Default constructor.
array(const char *Name, const char* Type=0, const char* Unit=0): Default constructor.
~array(void): Destructor.
void Spew(Xwriter& xout) const: Write an XML array definition.
xobj* Clone(void) const: Clone an array definition object.
const char* getObjType(void) const: Get object type.
const char* getUnit(void) const: Get the units.
int getNDim(void) const: Get the number of array dimensions.
int getDim(int iDim) const: get the specified dimension.
int addDim(const char* Name, int nDim): Add a dimension.
int addDim(const dim& Dim): Add a dimension.
void setUnit(const char* Unit): set the array units.
void setStream(const Stream& istr): Add a stream to the array.
void setRemote(const char* File): Set a remote stream.
void FillData(int N, int* Data): Add a data stream.
void FillData(int N, float* Data): Add a data stream.
void FillData(int N, double* Data): Add a data stream.
void FillData(int N, std::string* Data): Add a data stream.
Stream& refStream(void): Reference initialization strem.
const Stream& refStream(void) const: Reference initialization strem.

Inherited from xobj:

Public Methods
const char* getName(void) const
const char* getType(void) const
const std::string& refName(void) const
const std::string& refType(void) const
void setName(const char* Name)
void setType(const char* Type)

Documentation

The array class contains data elements organized as an N-dimensional array of a single data type. The last dimension varies the most rapidly. The array class contains an xsil stream to initialize the array data.

Default constructor.

array(const char *Name, const char* Type=0, const char* Unit=0)

Default constructor.

Parameters:: Name - Pointer to the array name.
Type - Pointer to the array type.
Unit - Pointer to the array units.

~array(void)

void Spew(Xwriter& xout) const

Write the array definition to an XML file.

Parameters:: XML - writer object to receive the array definition.

xobj* Clone(void) const

Clone an array definition object.

Returns:: Pointer to te cloned object.

const char* getObjType(void) const

Get the object type.

Returns:: Pointer to the object type string.

const char* getUnit(void) const

Get the array units.

Returns:: poitner to the units string.

int getNDim(void) const

Get the number of array dimensions.

Returns:: Number of dimenstion defined for this array.

int getDim(int iDim) const

get the specified dimension.

Returns:: the iDimth dimension.
Parameters:: iDim - Dmension number to be interrogated.

int addDim(const char* Name, int nDim)

Add a dimension to the array.

Returns:: Dimension number.
Parameters:: Name - Dimension name
nDim - Size of added dimension.

int addDim(const dim& Dim)

Add a dimension to the array.

Returns:: Dimension number.
Parameters:: nDim - Dimension block.

void setUnit(const char* Unit)

set the array units.

Parameters:: Unit - Pointer to the units string.

void setStream(const Stream& istr)

Add a stream to the array.

Parameters:: Stream - object to be added to the array.

void setRemote(const char* File)

Set a remote stream.

Parameters:: File - Name of file containing remote data.

void FillData(int N, int* Data)

Add a local initialization stream with specified integer data.

Parameters:: N - Number of data words.
Data - Integer array containing data for the array.

void FillData(int N, float* Data)

Add a local initialization stream with specified float data.

Parameters:: N - Number of data words.
Data - Float array containing data for the array.

void FillData(int N, double* Data)

Add a local initialization stream with specified double data.

Parameters:: N - Number of data words.
Data - Double array containing data for the array.

void FillData(int N, std::string* Data)

Add a local initialization stream with specified string data.

Parameters:: N - Number of data words.
Data - String array containing data for the array.

Stream& refStream(void)

Get reference to an initialization stream.

Returns:: reference to the initialization stream.

const Stream& refStream(void) const

Get reference to an initialization stream.

Returns:: reference to the initialization stream.

This class has no child classes.

Author:: J. Zweizig
Version:: 1.1; Modified December 13, 1999

alphabetic index hierarchy of classes

generated by doc++