mycq::QueueSchema Class Reference

Makes or represents columns of a queue schema. More...

#include <QueueSchema.h>

List of all members.

Public Member Functions

virtual void addBoolean (string columnName)=0
 Add a new BOOLEAN type column. See: ColumnType
virtual void addByte (string columnName)=0
 Add a new BYTE type column. See: ColumnType
virtual void addShort (string columnName)=0
 Add a new SHORT type column. See: ColumnType
virtual void addUShort (string columnName)=0
 Add a new USHORT type column. See: ColumnType
virtual void addInt (string columnName)=0
 Add a new INT type column. See: ColumnType
virtual void addLong (string columnName)=0
 Add a new LONG type column. See: ColumnType
virtual void addFloat (string columnName)=0
 Add a new FLOAT type column. See: ColumnType
virtual void addDouble (string columnName)=0
 Add a new DOUBLE type column. See: ColumnType
virtual void addDate (string columnName)=0
 Add a new DATE type column. See: ColumnType
virtual void addTime (string columnName)=0
 Add a new TIME type column. See: ColumnType
virtual void addDateTime (string columnName)=0
 Add a new DATETIME type column. See: ColumnType
virtual void addString (string columnName, int size)=0
 Add a new STRING type column. See: ColumnType
virtual void addVarString (string columnName)=0
 Add a new VAR_STRING type column. See: ColumnType
virtual void addBinary (string columnName, int size)=0
 Add a new BINARY type column. See: ColumnType
virtual void addVarBinary (string columnName)=0
 Add a new VAR_BINARY type column. See: ColumnType
virtual vector< Column > getColumns ()=0
 Get the column list a queue schema.
virtual void clear ()=0
 Clear all the columns in a queue schema.
virtual int getMessageSize ()=0
 Get the message size. It is a total size of columns of a queue schema.

Detailed Description

Makes or represents columns of a queue schema.

Member Function Documentation

virtual void mycq::QueueSchema::addBinary ( string  columnName,
int  size 
) [pure virtual]

Add a new BINARY type column. See: ColumnType

Parameters:
columnName A column name that will be created in a queue schema. A column name is a combination of alphabets and numerics which starts with alphabet character. (size:= under 64).
size An integer greater than zero that will be the size of BINARY type column.
Exceptions:
MyCQException An error occurred. check error code.
virtual void mycq::QueueSchema::addBoolean ( string  columnName  )  [pure virtual]

Add a new BOOLEAN type column. See: ColumnType

Parameters:
columnName A column name that will be created in a queue schema. A column name is a combination of alphabets and numerics which starts with alphabet character. (size:= under 64).
Exceptions:
MyCQException An error occurred. check error code.
virtual void mycq::QueueSchema::addByte ( string  columnName  )  [pure virtual]

Add a new BYTE type column. See: ColumnType

Parameters:
columnName A column name that will be created in a queue schema. A column name is a combination of alphabets and numerics which starts with alphabet character. (size:= under 64).
Exceptions:
MyCQException An error occurred. check error code.
virtual void mycq::QueueSchema::addDate ( string  columnName  )  [pure virtual]

Add a new DATE type column. See: ColumnType

Parameters:
columnName A column name that will be created in a queue schema. A column name is a combination of alphabets and numerics which starts with alphabet character. (size:= under 64).
Exceptions:
MyCQException An error occurred. check error code.
virtual void mycq::QueueSchema::addDateTime ( string  columnName  )  [pure virtual]

Add a new DATETIME type column. See: ColumnType

Parameters:
columnName A column name that will be created in a queue schema. A column name is a combination of alphabets and numerics which starts with alphabet character. (size:= under 64).
Exceptions:
MyCQException An error occurred. check error code.
virtual void mycq::QueueSchema::addDouble ( string  columnName  )  [pure virtual]

Add a new DOUBLE type column. See: ColumnType

Parameters:
columnName A column name that will be created in a queue schema. A column name is a combination of alphabets and numerics which starts with alphabet character. (size:= under 64).
Exceptions:
MyCQException An error occurred. check error code.
virtual void mycq::QueueSchema::addFloat ( string  columnName  )  [pure virtual]

Add a new FLOAT type column. See: ColumnType

Parameters:
columnName A column name that will be created in a queue schema. A column name is a combination of alphabets and numerics which starts with alphabet character. (size:= under 64).
Exceptions:
MyCQException An error occurred. check error code.
virtual void mycq::QueueSchema::addInt ( string  columnName  )  [pure virtual]

Add a new INT type column. See: ColumnType

Parameters:
columnName A column name that will be created in a queue schema. A column name is a combination of alphabets and numerics which starts with alphabet character. (size:= under 64).
Exceptions:
MyCQException An error occurred. check error code.
virtual void mycq::QueueSchema::addLong ( string  columnName  )  [pure virtual]

Add a new LONG type column. See: ColumnType

Parameters:
columnName A column name that will be created in a queue schema. A column name is a combination of alphabets and numerics which starts with alphabet character. (size:= under 64).
Exceptions:
MyCQException An error occurred. check error code.
virtual void mycq::QueueSchema::addShort ( string  columnName  )  [pure virtual]

Add a new SHORT type column. See: ColumnType

Parameters:
columnName A column name that will be created in a queue schema. A column name is a combination of alphabets and numerics which starts with alphabet character. (size:= under 64).
Exceptions:
MyCQException An error occurred. check error code.
virtual void mycq::QueueSchema::addString ( string  columnName,
int  size 
) [pure virtual]

Add a new STRING type column. See: ColumnType

Parameters:
columnName A column name that will be created in a queue schema. A column name is a combination of alphabets and numerics which starts with alphabet character. (size:= under 64).
size An integer greater than zero that will be the size of STRING type column.
Exceptions:
MyCQException An error occurred. check error code.
virtual void mycq::QueueSchema::addTime ( string  columnName  )  [pure virtual]

Add a new TIME type column. See: ColumnType

Parameters:
columnName A column name that will be created in a queue schema. A column name is a combination of alphabets and numerics which starts with alphabet character. (size:= under 64).
Exceptions:
MyCQException An error occurred. check error code.
virtual void mycq::QueueSchema::addUShort ( string  columnName  )  [pure virtual]

Add a new USHORT type column. See: ColumnType

Parameters:
columnName A column name that will be created in a queue schema. A column name is a combination of alphabets and numerics which starts with alphabet character. (size:= under 64).
Exceptions:
MyCQException An error occurred. check error code.
virtual void mycq::QueueSchema::addVarBinary ( string  columnName  )  [pure virtual]

Add a new VAR_BINARY type column. See: ColumnType

Parameters:
columnName A column name that will be created in a queue schema. A column name is a combination of alphabets and numerics which starts with alphabet character. (size:= under 64).
Exceptions:
MyCQException An error occurred. check error code.
virtual void mycq::QueueSchema::addVarString ( string  columnName  )  [pure virtual]

Add a new VAR_STRING type column. See: ColumnType

Parameters:
columnName A column name that will be created in a queue schema. A column name is a combination of alphabets and numerics which starts with alphabet character. (size:= under 64).
Exceptions:
MyCQException An error occurred. check error code.
virtual void mycq::QueueSchema::clear (  )  [pure virtual]

Clear all the columns in a queue schema.

virtual vector<Column> mycq::QueueSchema::getColumns (  )  [pure virtual]

Get the column list a queue schema.

Returns:
Column list.
virtual int mycq::QueueSchema::getMessageSize (  )  [pure virtual]

Get the message size. It is a total size of columns of a queue schema.

Returns:
An integer of a message size. It returns zero if there is no column or variable column(s) in a queue schema.
The documentation for this class was generated from the following file:
 All Classes Namespaces Functions Variables Enumerations Enumerator
MyCQ C++ User's Document. Copyright@MyCQ Inc., All Rights Reserved.