CreateChildArray() [1/2]

template<class ContainerType >

Id drama::sds::Id::CreateChildArray ( const std::string &  name, const SdsCodeType  code, const ContainerType &  dims, const std::string &  extra = ""  ) const

inline

Factory constructor method Constructor which creates a new child item which is an multi-dimensional array.

This non-static factory sds::Id constructor creates a new SDS array item which is a child of this SDS item.

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

Warning

Some compilers will try to use this overload of this method when the 4th argument (dims) is NOT a container, the intent would be to invoke the other overload where that argument is an unsigned int item (single dimensional version). The solution is to ensure the argument is cast explicitly to "unsigned". A static assertion should trigger when this problem occurs.

See also

SdsNew()

Parameters

name	The name for the new SDS item.
code	The SDS code for the new item.
dims	A container giving each dimension. A maximum of 7 dimensions are supported
extra	The extra data, if any. Defaults to none.

Template Parameters

ContainerType

A container with a size() method and which can be used to initialize a vector of unsigned long.

Returns

An Id providing a reference to the array.

References drama::CreateRunDramaTask(), and DramaTHROW_F.

Referenced by drama::ArrayParameter< SDS_T >::ArrayParameter(), ArrayCreateAndAccess(), and ArrayCreateAndAccess().