kome::objects::Variant Class Reference

class that treats data of various types More...

#include <Variant.h>

Collaboration diagram for kome::objects::Variant:

Classes
union	PrimitiveType

Public Types
enum	DataType {   UNKNOWN, BOOL, INTEGER, DOUBLE,   STRING, ARRAY, PAIR, SAMPLE_SET,   SAMPLE, SAMPLE_GETTER, SPECTRUM, DATA_SET,   DATA_GROUP_NODE, CHROMATOGRAM, XY_DATA, PEAKS,   PEAKS_2D, DRAWING_DATA, GRAPHICS, FONT,   PROGRESS, MOUSE_EVT, KEY_EVT, DATA_MAP,   SIZE_EVT, MOVE_EVT, WINDOW, SETTING_VALUES,   SCRIPT, FILE_READER, OTHER }

Public Member Functions
	Variant ()
	constructor
	Variant (const Variant &v)
	copy constructor More...
virtual	~Variant ()
	destructor
Variant &	operator= (const Variant &other)
	substitution operator More...
void	setString (const char *s)
	sets character string More...
char *	getString ()
	gets character string More...
Variant *	createArray (const unsigned int size)
	creates array More...
Variant *	getArray ()
	gets array More...
Variant *	getElement (const unsigned int index)
	gets element of the array More...
unsigned int	getArraySize ()
	gets array size More...

Public Attributes
DataType	type
union kome::objects::Variant::PrimitiveType	prim

Protected Member Functions
void	deleteArray ()
	deletes array

Protected Attributes
void *	arr

Detailed Description

class that treats data of various types

Definition at line 26 of file Variant.h.

Member Enumeration Documentation

enum kome::objects::Variant::DataType

data type

Definition at line 58 of file Variant.h.

                         {
                UNKNOWN,
                BOOL,
                INTEGER,
                DOUBLE,
                STRING,
                ARRAY,
                PAIR,
                SAMPLE_SET,
                SAMPLE,
                SAMPLE_GETTER,
                SPECTRUM,
                DATA_SET,
                DATA_GROUP_NODE,
                CHROMATOGRAM,
                XY_DATA,
                PEAKS,
                PEAKS_2D,
                DRAWING_DATA,
                GRAPHICS,
                FONT,
                PROGRESS,
                MOUSE_EVT,
                KEY_EVT,
                DATA_MAP,
                SIZE_EVT,
                MOVE_EVT,
                WINDOW,
                SETTING_VALUES,
                SCRIPT,
                FILE_READER,
                OTHER
            } DataType;

Constructor & Destructor Documentation

kome::objects::Variant::Variant

(

const Variant &

v

)

copy constructor

Parameters

[in]

v

variant object to copy

Definition at line 37 of file Variant.cpp.

                                     {
    // copy member
    prim = var.prim;
    type = var.type;
    arr = NULL;

    if( var.arr != NULL && var.prim.intVal > 0 ) {
        int size = var.prim.intVal;
        if( var.type == ARRAY ) {
            arr = new Variant[ size ];
            for( int i = 0; i < size; i++ ) {
                ( (Variant*)arr )[ i ] = ( (Variant*)var.arr )[ i ];
            }
        }
        else if( var.type == STRING ) {
            arr = new char[ size ];
            memcpy( arr, var.arr, size );
        }

        prim.intVal = size;
    }
}

Member Function Documentation

Variant * kome::objects::Variant::createArray

(

const unsigned int

size

)

creates array

Parameters

[in]

size

array size

Returns

new array

Definition at line 120 of file Variant.cpp.

                                                       {
    // delete old array
    deleteArray();

    // check parameter
    if( size == 0 ) {
        type = UNKNOWN;
        return NULL;
    }

    // type
    type = ARRAY;

    // set size
    prim.intVal = size;

    // create array
    arr = new Variant[ size ];

    return getArray();
}

Here is the call graph for this function:

Variant * kome::objects::Variant::getArray

(

)

gets array

Returns

the pointer to array

Definition at line 143 of file Variant.cpp.

                           {
    return (Variant*)arr;
}

unsigned int kome::objects::Variant::getArraySize

(

)

gets array size

Returns

array size

Definition at line 158 of file Variant.cpp.

                                   {
    // check the member
    if( arr == NULL ) {
        return 0;
    }

    return (unsigned int)prim.intVal;
}

Variant * kome::objects::Variant::getElement

(

const unsigned int

index

)

gets element of the array

Parameters

[in]

index

element index

Returns

element of the array (If index is illegal, this method returns NULL.)

Definition at line 148 of file Variant.cpp.

                                                       {
    // check parameter
    if( index >= (unsigned int)prim.intVal ) {
        return NULL;
    }

    return ( getArray() + index );
}

Here is the call graph for this function:

char * kome::objects::Variant::getString

(

)

gets character string

Returns

character string

Definition at line 115 of file Variant.cpp.

                         {
    return (char*)arr;
}

Variant & kome::objects::Variant::operator=

(

const Variant &

other

)

substitution operator

Parameters

[in]

other

source variant object

Returns

copied variant object

Definition at line 66 of file Variant.cpp.

                                                  {
    // copy member
    prim = other.prim;
    type = other.type;
    arr = NULL;

    if( other.arr != NULL && other.prim.intVal > 0 ) {
        int size = other.prim.intVal;
        if( other.type == ARRAY ) {
            arr = new Variant[ size ];
            for( int i = 0; i < size; i++ ) {
                ( (Variant*)arr )[ i ] = ( (Variant*)other.arr )[ i ];
            }
        }
        else if( other.type == STRING ) {
            arr = new char[ size ];
            memcpy( arr, other.arr, size );
        }

        prim.intVal = size;
    }

    return *this;
}

void kome::objects::Variant::setString

(

const char *

s

)

sets character string

Parameters

[in]

s

character string

Definition at line 92 of file Variant.cpp.

                                       {
    // delete old array
    deleteArray();

    // check parameter
    if( s == NULL ) {
        type = UNKNOWN;
        return;
    }

    // set type
    type = STRING;

    // create array
    int size = strlen( s ) + 1;
    arr = new char[ size ];
    prim.intVal = size;

    // copy
    memcpy( arr, s, size );
}

Here is the call graph for this function:

Member Data Documentation

void* kome::objects::Variant::arr

protected

array

Definition at line 105 of file Variant.h.

DataType kome::objects::Variant::type

data type

Definition at line 93 of file Variant.h.

---

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

• DataObjects/Variant.h
• DataObjects/Variant.cpp