AAO DRAMA/DRAMA2 C++ Interface
DRAMA C++11 and later interface

◆ Cell()

template<class ContainerType >
Id drama::sds::Id::Cell ( const ContainerType indicies,
bool  throwOnNotFound = true 
) const
inline

Factory constructor method Constructor that returns a cell of an existing id which must refer to an SDS array.

This non-static factory constructor is used to access a specified cell of an existing SDS structure array.

The object on which the method is invoked must reference an SDS Array (rather then an SDS structure or primitive). It must also be an internal item (rather then external).

Note that if working through a one dimensional structure array (incrementing the index), then you might find drama::sds::IdIterator provides a neater solution over a loop calling this method.

See also
SdsCell().
drama::sds::IdIterator
Parameters
indiciesAn container giving the indicies of the cell in question. A maximum of 7 dimensions are supported.
Template Parameters
ContainerTypeA container with a size() method and which can be used to initialize a vector of unsigned long.
Parameters
throwOnNotFoundIf true (default), will throw an exception if the an item of the index does not exist. Otherwise will return a null SDS item. Any other errors will cause an exception to be thrown regardless.
Returns
An Id providing a reference to the cell.

References drama::CreateRunDramaTask(), DramaTHROW, and DramaTHROW_S.

Referenced by drama::sds::IdIterator::operator*().