Class IloTupleBuffer

Definition file: ilopl/ilotuple.h

Creates a new tuple using the values of the different fields in the class.

The class IloTupleBuffer allows you to create a new tuple using the values of its different fields. This tuple by value can be used to populate a set of tuples, to update an array, or to make an index search.

A tuple by value is a list of <value, path> where path is the column path

See Also:

IloTupleSet, IloTupleMap

Method Summary
`public void`	`clear()`
`public IloInt`	`commit()`
`public void`	`display(ostream & outs) const`
`public void`	`end()`
`public void`	`setAnyCollectionValue(IloIntArray path, IloAnyCollection value)`
`public void`	`setAnyCollectionValue(const char * col, IloAnyCollection value)`
`public void`	`setAnyCollectionValue(IloInt columnIndex, IloAnyCollection value)`
`public void`	`setAnyValue(const char * col, IloAny value)`
`public void`	`setAnyValue(IloInt columnIndex, IloAny value)`
`public void`	`setIntCollectionValue(IloIntArray path, IloIntCollection value)`
`public void`	`setIntCollectionValue(const char * col, IloIntCollection value)`
`public void`	`setIntCollectionValue(IloInt columnIndex, IloIntCollection value)`
`public void`	`setIntMapValue(IloIntArray path, IloIntMap value)`
`public void`	`setIntMapValue(const char * col, IloIntMap value)`
`public void`	`setIntMapValue(IloInt columnIndex, IloIntMap value)`
`public void`	`setIntValue(IloIntArray path, IloInt value)`
`public void`	`setIntValue(const char * col, IloInt value)`
`public void`	`setIntValue(IloInt columnIndex, IloInt value)`
`public void`	`setNumCollectionValue(IloIntArray path, IloNumCollection value)`
`public void`	`setNumCollectionValue(const char * col, IloNumCollection value)`
`public void`	`setNumCollectionValue(IloInt columnIndex, IloNumCollection value)`
`public void`	`setNumMapValue(IloIntArray path, IloNumMap value)`
`public void`	`setNumMapValue(const char * col, IloNumMap value)`
`public void`	`setNumMapValue(IloInt columnIndex, IloNumMap value)`
`public void`	`setNumValue(IloIntArray path, IloNum value)`
`public void`	`setNumValue(const char * col, IloNum value)`
`public void`	`setNumValue(IloInt columnIndex, IloNum value)`
`public void`	`setSymbolValue(IloIntArray path, IloSymbol value)`
`public void`	`setSymbolValue(IloIntArray path, const char * value)`
`public void`	`setSymbolValue(const char * col, IloSymbol value)`
`public void`	`setSymbolValue(const char * col, const char * value)`
`public void`	`setSymbolValue(IloInt columnIndex, IloSymbol value)`
`public void`	`setSymbolValue(IloInt columnIndex, const char * value)`
`public void`	`setTupleValue(IloIntArray path, IloTuple value)`
`public void`	`setTupleValue(const char * col, IloTuple value)`
`public void`	`setTupleValue(IloInt columnIndex, IloTuple value)`

Inherited Methods from `IloTuple`
display, end, getAnyCollectionValue, getAnyCollectionValue, getAnyCollectionValue, getAnyValue, getCollection, getEnv, getIndex, getIntCollectionValue, getIntCollectionValue, getIntCollectionValue, getIntMapValue, getIntMapValue, getIntMapValue, getIntSetValue, getIntSetValue, getIntSetValue, getIntValue, getIntValue, getIntValue, getNumCollectionValue, getNumCollectionValue, getNumCollectionValue, getNumMapValue, getNumMapValue, getNumMapValue, getNumSetValue, getNumSetValue, getNumSetValue, getNumValue, getNumValue, getNumValue, getSchema, getStringValue, getStringValue, getStringValue, getSymbolSetValue, getSymbolSetValue, getSymbolSetValue, getSymbolValue, getSymbolValue, getSymbolValue, makeTupleBuffer, makeTupleValue, makeTupleValue, makeTupleValue, setCollection, setIndex

Inherited Methods from IloTuple

display, end, getAnyCollectionValue, getAnyCollectionValue, getAnyCollectionValue, getAnyValue, getCollection, getEnv, getIndex, getIntCollectionValue, getIntCollectionValue, getIntCollectionValue, getIntMapValue, getIntMapValue, getIntMapValue, getIntSetValue, getIntSetValue, getIntSetValue, getIntValue, getIntValue, getIntValue, getNumCollectionValue, getNumCollectionValue, getNumCollectionValue, getNumMapValue, getNumMapValue, getNumMapValue, getNumSetValue, getNumSetValue, getNumSetValue, getNumValue, getNumValue, getNumValue, getSchema, getStringValue, getStringValue, getStringValue, getSymbolSetValue, getSymbolSetValue, getSymbolSetValue, getSymbolValue, getSymbolValue, getSymbolValue, makeTupleBuffer, makeTupleValue, makeTupleValue, makeTupleValue, setCollection, setIndex

Method Detail

clear

public void clear()

Clears the buffer.

commit

public IloInt commit()

Commits the values in the IloTupleSet; that is, adds a new line if the index of the buffer is -1, or sets a line with this content.

If you commit a new tuple, the index of the invoking tuple buffer is set to the value of the index of the created tuple in the tuple set. If you want to commit a new tuple again using the same instance of IloTupleBuffer you need to set its index back to -1, using the method IloTuple::setIndex.

Returns:

The index of the created line. -1 in case of error.

display

public void display(ostream & outs) const

Displays the content of the buffer (that is, the list of values and their paths).

end

public void end()

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

setAnyCollectionValue

public void setAnyCollectionValue(IloIntArray path, IloAnyCollection value)

Sets the void collection column path of the IloTupleSet with value. The IloTupleSet becomes the owner of the collection.

See Also:

IloTuple::getIntValue

Parameters:

path	The void collection column.
value	The `IloAnyCollection` value to be set.

setAnyCollectionValue

public void setAnyCollectionValue(const char * col, IloAnyCollection value)

Sets the void collection column named col of the IloTupleSet with value. The IloTupleSet becomes the owner of the collection.

Parameters:

col	The void collection column.
value	The `IloAnyCollection` value to be set.

setAnyCollectionValue

public void setAnyCollectionValue(IloInt columnIndex, IloAnyCollection value)

Sets the void-collection column columnIndex of the IloTupleSet with value. The IloTupleSet becomes the owner of the collection.

Parameters:

columnIndex	The column index.
value	The `IloAnyConnection` value to be set.

setAnyValue

public void setAnyValue(const char * col, IloAny value)

Sets the void column named col of the IloTupleSet with value.

Parameters:

col	The void column.
value	The `IloAny` value to be set.

setAnyValue

public void setAnyValue(IloInt columnIndex, IloAny value)

Sets the void column columnIndex of the IloTupleSet with value.

Parameters:

columnIndex	The column index.
value	The `IloAny` value to be set.

setIntCollectionValue

public void setIntCollectionValue(IloIntArray path, IloIntCollection value)

Sets the integer collection column path of the IloTupleSet with value. The IloTupleSet becomes the owner of the collection.

Parameters:

path	The integer collection column.
value	The `IloIntCollection` value to be set.

setIntCollectionValue

public void setIntCollectionValue(const char * col, IloIntCollection value)

Sets the integer collection column named col of the IloTupleSet with value. The IloTupleSet becomes the owner of the collection.

Parameters:

col	The integer collection column.
value	The `IloIntCollection` value to be set.

setIntCollectionValue

public void setIntCollectionValue(IloInt columnIndex, IloIntCollection value)

Sets the integer-collection column columnIndex of the IloTupleSet with value. The IloTupleSet becomes the owner of the collection.

Parameters:

columnIndex	The column index.
value	The `IloIntCollection` value to be set.

setIntMapValue

public void setIntMapValue(IloIntArray path, IloIntMap value)

Sets the integer array column path of the IloTupleSet with value. The IloTupleSet becomes the owner of the collection.

See Also:

IloTuple::getIntValue

Parameters:

path	The integer array column.
value	The `IloIntMap` value to be set.

setIntMapValue

public void setIntMapValue(const char * col, IloIntMap value)

Sets the integer array column named col of the IloTupleSet with value. The IloTupleSet becomes the owner of the collection.

Parameters:

col	The integer array column.
value	The `IloIntMap` value to be set.

setIntMapValue

public void setIntMapValue(IloInt columnIndex, IloIntMap value)

Sets the integer array column columnIndex of the IloTupleSet with value. The IloTupleSet becomes the owner of the collection.

Parameters:

columnIndex	The column index.
value	The `IloIntMap` value to be set.

setIntValue

public void setIntValue(IloIntArray path, IloInt value)

Sets the integer column path of the IloTupleSet with value.

See Also:

IloTuple::getIntValue

Parameters:

path	The integer column.
value	The `IloInt` value to be set.

setIntValue

public void setIntValue(const char * col, IloInt value)

Sets the integer column named col of the IloTupleSet with value.

Parameters:

col	The integer column.
value	The integer value to be set.

setIntValue

public void setIntValue(IloInt columnIndex, IloInt value)

Provides an integer value for the column index of the IloTupleSet.

Parameters:

columnIndex	The column index.
value	The integer value.

setNumCollectionValue

public void setNumCollectionValue(IloIntArray path, IloNumCollection value)

Sets the float collection column path of the IloTupleSet with value. The IloTupleSet becomes the owner of the collection.

See Also:

IloTuple::getIntValue

Parameters:

path	The float collection column.
value	The `IloNumCollection` value to be set.

setNumCollectionValue

public void setNumCollectionValue(const char * col, IloNumCollection value)

Sets the float collection column named col of the IloTupleSet with value. The IloTupleSet becomes the owner of the collection.

Parameters:

col	The float collection column.
value	The `IloNumCollection` value to be set.

setNumCollectionValue

public void setNumCollectionValue(IloInt columnIndex, IloNumCollection value)

Sets the float-collection column columnIndex of the IloTupleSet set with value. The IloTupleSet becomes the owner of the collection.

Parameters:

columnIndex	The column index.
value	The `IloNumCollection` value to be set.

setNumMapValue

public void setNumMapValue(IloIntArray path, IloNumMap value)

Sets the float array column path of the IloTupleSet with value. The IloTupleSet becomes the owner of the collection.

See Also:

IloTuple::getIntValue

Parameters:

path	The float array column.
value	The `IloNumMap` value to be set.

setNumMapValue

public void setNumMapValue(const char * col, IloNumMap value)

Sets the float array column named col of the IloTupleSet with value. The IloTupleSet becomes the owner of the collection.

Parameters:

col	The float array column.
value	The `IloNumMap` value to be set.

setNumMapValue

public void setNumMapValue(IloInt columnIndex, IloNumMap value)

Sets the float array column columnIndex of the IloTupleSet with value. The IloTupleSet becomes the owner of the collection.

Parameters:

columnIndex	The column index.
value	The `IloNumMap` value to be set.

setNumValue

public void setNumValue(IloIntArray path, IloNum value)

Sets the float column path of the IloTupleSet with value.

See Also:

IloTuple::getIntValue

Parameters:

path	The float column.
value	The float value.

setNumValue

public void setNumValue(const char * col, IloNum value)

Sets the float column named col of the IloTupleSet with value.

Parameters:

col	The float column.
value	The `IloNum` value to be set.

setNumValue

public void setNumValue(IloInt columnIndex, IloNum value)

Provides a floating-point value for the column index of the IloTupleSet.

Parameters:

columnIndex	The column index.
value	The float value.

setSymbolValue

public void setSymbolValue(IloIntArray path, IloSymbol value)

Sets the symbol column path of the IloTupleSet with value.

See Also:

IloTuple::getIntValue

Parameters:

path	The symbol column.
value	The `IloSymbol` value to be set.

setSymbolValue

public void setSymbolValue(IloIntArray path, const char * value)

Sets the symbol column path of the IloTupleSet with value.

See Also:

IloTuple::getIntValue

Parameters:

path	The symbol column.
value	The char* value to be set.

setSymbolValue

public void setSymbolValue(const char * col, IloSymbol value)

Sets the string column col of the IloTupleSet with value.

Parameters:

col	The string column.
value	The `IloTupleSet` value to be set.

setSymbolValue

public void setSymbolValue(const char * col, const char * value)

Sets the string column col of the IloTupleSet with value.

Parameters:

col	The string column.
value	The char* value to be set.

setSymbolValue

public void setSymbolValue(IloInt columnIndex, IloSymbol value)

Sets the string column columnIndex of the IloTupleSet with value.

Parameters:

columnIndex	The column index.
value	The `IloSymbol` value to be set.

setSymbolValue

public void setSymbolValue(IloInt columnIndex, const char * value)

Sets the string column columnIndex of the IloTupleSet with value.

Parameters:

columnIndex	The column index.
value	The char* value.

setTupleValue

public void setTupleValue(IloIntArray path, IloTuple value)

Sets the tuple column path of the IloTupleSet with value.

See Also:

IloTuple::getIntValue

Parameters:

path	The tuple column.
value	The `IloTuple` value to be set.

setTupleValue

public void setTupleValue(const char * col, IloTuple value)

Sets the sub-tuple col of the IloTupleSet with value.

Parameters:

col	The string column.
value	The `IloTuple` value to be set.

setTupleValue

public void setTupleValue(IloInt columnIndex, IloTuple value)

Sets the sub-tuple columnIndex of the IloTupleSet with value.

Parameters:

columnIndex	The column index.
value	The `IloTuple` value to be set.