AddLinearItem Method

WRAPPER_API bool AddLinearItem(const BmgChar *name, bool optional = false)

 

Description

The AddLinearItem method adds a new LinearValue parameter to the ParameterCollection.  The method takes two arguments, the first of which gives the name of the parameter.  The second argument is optional, and it indicates if the parameter is an optional or a required parameter.  The method returns a boolean value indicating the success of the operation.  The value of the added parameter is an LinearValue that represents 0 meters.  This value can be set with the set_LinearItem method.

 

Example

void ParameterCollection_AddLinearItem()

{

GEOCALCPBW_NAMESPACE::ParameterCollection pc;

 

BmgChar * linearParName = L"LinearParameter";

GEOCALCPBW_NAMESPACE::LinearValue linearVal;

pc.AddLinearItem(linearParName);

pc.set_LinearItem(linearParName, linearVal);

GEOCALCPBW_NAMESPACE::LinearValue * lv = pc.get_LinearItem(linearParName);

delete lv;

}