DSIColumnsView Class Reference

An IColumns which wraps another IColumns object to give a view to a subset of its columns. More...

Inherits Simba::DSI::IColumns.

List of all members.

Public Member Functions

 DSIColumnsView (const DSIColumnsView &in_other)
 Copy Constructor.
 DSIColumnsView (const std::vector< simba_uint16 > &in_mapping, AutoPtr< IColumns > in_columns)
 Owning Constructor.
 DSIColumnsView (const std::vector< simba_uint16 > &in_mapping, IColumns &in_columns)
 Constructor.
virtual Simba::DSI::IColumnGetColumn (simba_uint16 in_columnNum) const
 Returns a reference to the desired table column.
virtual simba_uint16 GetColumnCount () const
 Returns the column count.
virtual void LogColumns (ILogger *in_log) const
 Logs all of the columns.

Detailed Description

An IColumns which wraps another IColumns object to give a view to a subset of its columns.


Constructor & Destructor Documentation

DSIColumnsView ( const std::vector< simba_uint16 > &  in_mapping,
IColumns in_columns 
)

Constructor.

MAINTENANCE NOTE: This object does not take ownership of the IColumns, it creates a shim to the data. It should only be used when you are sure that the underlying IColumns object will outlive this shim.

Parameters:
in_mapping The mapping to use. GetColumn(i) on this object maps to GetColumn(in_mapping[i]) on in_columns.
in_columns The columns to create a view of. (NOT OWN)
DSIColumnsView ( const std::vector< simba_uint16 > &  in_mapping,
AutoPtr< IColumns in_columns 
)

Owning Constructor.

Parameters:
in_mapping The mapping to use. GetColumn(i) on this object maps to GetColumn(in_mapping[i]) on in_columns.
in_columns The columns to create a view of. (OWN)
DSIColumnsView ( const DSIColumnsView in_other  ) 

Copy Constructor.

MAINTENANCE NOTE: This copy constructor does NOT do a deep copy, it merely creates another shim over the same data. Should only be used when you are sure the lifetime of the underlying IColumns will outlive the lifetime of this object.

Parameters:
in_other The DSIColumnsView object to copy.

Member Function Documentation

virtual Simba::DSI::IColumn* GetColumn ( simba_uint16  in_columnNum  )  const [virtual]

Returns a reference to the desired table column.

Parameters:
in_columnNum The number of the column to retrieve. Columns are indexed starting with 0.
Exceptions:
BadColumnException if a matching column is not found.
Returns:
The column for the given index. (NOT OWN)

Implements IColumns.

virtual simba_uint16 GetColumnCount (  )  const [virtual]

Returns the column count.

Returns:
The number of columns in this object.

Implements IColumns.

virtual void LogColumns ( ILogger in_log  )  const [virtual]

Logs all of the columns.

Parameters:
in_log The ILogger to use for logging. (NOT OWN)

Implements IColumns.


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

Generated on Wed May 17 14:21:15 2017 for SimbaEngine 10.1.3.1011 by simba