CreateArgCmdStructSingle()

template<typename T >

static Id drama::sds::Id::CreateArgCmdStructSingle ( const T  value, 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 single value supplied to generate the first item in a typical DRAMA command argument structure.

This method provides a quick way of generating an argument structure with on item.

See also

ArgNew()

drama::sds::AddToArgCmdStruct()

Template Parameters

T	The type 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

value	The value to be inserted into the structure.
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 CreateArgStruct(), and drama::CreateRunDramaTask().