CreateArgCmdStruct() [2/2]

template<typename T >

static Id drama::sds::Id::CreateArgCmdStruct ( const std::initializer_list< T > &  values, const std::string &  name = "ArgStructure"  )

inlinestatic

Factory constructor which creates a new "Arg" style SDS structure in the DRAMA Command style.

This static factory drama::sds::Id constructor creates a new top level SDS item of type SDS_STRUCT. This style of structure is commonly used for action arguments within DRAMA.

It then uses the values supplied in the values argument to create a typical DRAMA command argument structure.

Version which allows the values to be supplied in an initializer list. There is also an overload which allows values to be supplied in a container.

See also

ArgNew()

drama::sds::AddToArgCmdStruct()

Template Parameters

T	The type of the values within the initializer list must be acceptable to the drama::sds::Id::Put() with name methods, e.g. bool, char, short, unsigned short, INT32, UINT32, INT64, UINT64, float and double. Also the string representation std::string.

Parameters

values	The values to be inserted into the structure as an initialiser list. Items must be compatible e.g. don't mix types.
name	The name for the structure. The default is what is normally supplied by the ArgNew() function, but any name acceptable to SDS can be specified.

Returns

An Id providing a reference to the structure.

References CreateArgCmdStruct(), and drama::CreateRunDramaTask().