Class IloTupleSchema

Definition file: ilopl/ilotuplecollection.h

This class is used to declare an IloTupleSet schema.

Defines the type of the columns in the declared IloTupleSet schema.

Method Summary
`public void`	`end()`
`public IloInt`	`getColumnIndex(const char * name) const`
`public const char *`	`getColumnName(IloInt idx) const`
`public IloEnv`	`getEnv() const`
`public const char *`	`getName() const`
`public IloInt`	`getSize() const`
`public IloInt`	`getTotalColumnNumber() const`
`public`	`IloTupleSchema(IloTupleSchemaI const * impl=0)`
`public IloBool`	`isAnyCollection(IloInt index) const`
`public IloBool`	`isInt(IloIntArray path) const`
`public IloBool`	`isInt(IloInt index) const`
`public IloBool`	`isIntCollection(IloIntArray path) const`
`public IloBool`	`isIntCollection(IloInt index) const`
`public IloBool`	`isNum(IloIntArray path) const`
`public IloBool`	`isNum(IloInt index) const`
`public IloBool`	`isNumCollection(IloIntArray path) const`
`public IloBool`	`isNumCollection(IloInt index) const`
`public IloBool`	`isSymbol(IloIntArray path) const`
`public IloBool`	`isSymbol(IloInt index) const`
`public IloBool`	`isTuple(IloIntArray path) const`
`public IloBool`	`isTuple(IloInt index) const`

Method Detail

IloTupleSchema

public IloTupleSchema(IloTupleSchemaI const * impl=0)

Constructor from an implementation.

This member function deletes the invoking implementation. That is, it frees all the resources used by the invoking object. After a call to this member function, you can not use the invoking extractable object again.

getColumnIndex

public IloInt getColumnIndex(const char * name) const

This member function returns the index of a named column.

Parameters:

name	The name of the column you want to retrieve the index of.

Returns:

The index of the named column. Throws an exception if the column does not exist.

getColumnName

public const char * getColumnName(IloInt idx) const

Used to determine the definition of a column referenced by index idx.

Parameters:

idx	The index of the column you want to determine the name of.

Returns:

The column name of the index idx.

getEnv

public IloEnv getEnv() const

This member function returns the environment where the invoking array was created. The elements of the invoking array belong to the same environment.

Returns:

The environment of the invoking array.

getName

public const char * getName() const

This member function returns the name of the schema.

Returns:

The name of the schema.

getSize

public IloInt getSize() const

This member function is used to determine the size of the invoking array.

Returns:

An integer specifying the size of the invoking array. An empty array has size 0 (zero).

getTotalColumnNumber

public IloInt getTotalColumnNumber() const

This member function returns the number of columns of a schema.

Returns:

The total number of columns of the schema, including the columns of the subtuples.

isAnyCollection

public IloBool isAnyCollection(IloInt index) const

This member function is used to determine whether a column is a void/symbol collection column.

Parameters:

index

The index of the column you want to check.

Returns:

A Boolean value specifying whether the indexed column is a void/symbol collection column.

isInt

public IloBool isInt(IloIntArray path) const

This member function is used to determine whether a column is an integer column.

For this schema:

 <  int, int, S1, int >

where S1 is:

 < symbol, S2, symbol >

and S2 is:

 < int, float >

then isInt( [0] ) returns true, isInt( [2] ) returns false, isInt( [2, 1, 0] ) returns true, and isInt( [2, 1, 1] ) returns false.

Parameters:

path	The path to the column you want to check.

Returns:

A Boolean value specifying whether the indexed column is an integer column.

isInt

public IloBool isInt(IloInt index) const

This member function is used to determine whether a column contains integer values.

Parameters:

index

The index of the column you want to check.

Returns:

A Boolean value specifying whether the indexed column contains integer values.

isIntCollection

public IloBool isIntCollection(IloIntArray path) const

This member function is used to determine whether a column is an integer collection column.

See Also:

IloTupleSchema::isInt

Parameters:

path	The path to the column you want to check.

Returns:

A Boolean value specifying whether the indexed column is an integer collection column.

isIntCollection

public IloBool isIntCollection(IloInt index) const

This member function is used to determine whether a column is an integer collection column.

Parameters:

index

The index of the column you want to check.

Returns:

A Boolean value specifying whether the indexed column is an integer collection column.

isNum

public IloBool isNum(IloIntArray path) const

This member function is used to determine whether a column is a float column.

See Also:

IloTupleSchema::isInt

Parameters:

path	The path to the column you want to check.

Returns:

A Boolean value specifying whether the indexed column is a float column.

isNum

public IloBool isNum(IloInt index) const

This member function is used to determine whether a column contains float values.

Parameters:

index

The index of the column you want to check.

Returns:

A Boolean value specifying whether the indexed column contains float values.

isNumCollection

public IloBool isNumCollection(IloIntArray path) const

This member function is used to determine whether a column is a float collection column.

See Also:

IloTupleSchema::isInt

Parameters:

path	he path to the column you want to check.

Returns:

A Boolean value specifying whether the indexed column is a float collection column.

isNumCollection

public IloBool isNumCollection(IloInt index) const

This member function is used to determine whether a column is a float collection column.

Parameters:

index

The index of the column you want to check.

Returns:

A Boolean value specifying whether the indexed column is a float collection column.

isSymbol

public IloBool isSymbol(IloIntArray path) const

This member function is used to determine whether a column is a string column.

See Also:

IloTupleSchema::isInt

Parameters:

path	The path to the column you want to check.

Returns:

A Boolean value specifying whether the indexed column is a string column.

isSymbol

public IloBool isSymbol(IloInt index) const

This member function is used to determine whether a column contains string values.

Parameters:

index

The index of the column you want to check.

Returns:

A Boolean value specifying whether the indexed column contains string values.

isTuple

public IloBool isTuple(IloIntArray path) const

This member function is used to determine whether a column is a tuple column.

See Also:

IloTupleSchema::isInt

Parameters:

path	The path to the column you want to check.

Returns:

A Boolean value specifying whether the indexed column is a tuple column.

isTuple

public IloBool isTuple(IloInt index) const

This member function is used to determine whether the column index is a subtuple column.

Parameters:

index

The index of the column you want to check.

Returns:

A Boolean value specifying whether the indexed column is a subtuple column.