CdotXSIParams Class Reference

Container for an array of CdotXSIParam elements. More...

#include <dotXSIParams.h>

List of all members.

Public Member Functions
  CdotXSIParams ()
virtual  ~CdotXSIParams ()
SI_Int  GetCount ()
SI_Void  Add (CdotXSIParam *i_Param, SI_Int i_nPosition)
SI_Void  Item (SI_Int i_nPosition, CdotXSIParam **o_Param)
CdotXSIParam *  Item (SI_Int i_nPosition)
SI_Void  Remove (SI_Int i_nPosition)
SI_Void  Clear ()
SI_Bool  Find (CSIBCString *i_sParamName, CdotXSIParam **o_pParam)
CdotXSIParam *  Find (const SI_Char *in_szParamName)

Detailed Description

Container for an array of CdotXSIParam elements.

Constructor & Destructor Documentation

CdotXSIParams (  ) 

Constructor

virtual ~CdotXSIParams (  )  [virtual]

Destructor

Member Function Documentation

SI_Int GetCount (  ) 

Returns the number of elements

Returns:
the number of CdotXSIParam items in this collection

SI_Void Add ( CdotXSIParam *  i_Param,
SI_Int  i_nPosition  
)

Adds an element to this collection

Parameters:
[in]  i_Param  the CdotXSIParam to add to this collection
[in]  i_nPosition  the position to add this element at

SI_Void Item ( SI_Int  i_nPosition,
CdotXSIParam **  o_Param  
)

Stores a reference to the specified item in the collection

Parameters:
[in]  i_nPosition  position to get the item at
[out]  o_Param  a pointer containing the reference to the item

CdotXSIParam* Item ( SI_Int  i_nPosition  ) 

Returns the item at the specified position in the collection

Parameters:
[in]  i_nPosition  position to get the item at
Returns:
a pointer to the requested item

SI_Void Remove ( SI_Int  i_nPosition  ) 

Removes the specified element from the collection

Parameters:
[in]  i_nPosition  the position at which to remove the item

SI_Void Clear (  ) 

Clears the entire collection of all elements

SI_Bool Find ( CSIBCString *  i_sParamName,
CdotXSIParam **  o_pParam  
)

Finds an element in the collection by name

Parameters:
[in]  i_sParamName  the name of the parameter to find
[out]  o_pParam  a pointer containing the reference to the item
Returns:
whether the element has been found or not

CdotXSIParam* Find ( const SI_Char *  in_szParamName  ) 

Returns an element in the collection by name

Parameters:
[in]  in_szParamName  the name of the parameter to find
Returns:
a pointer to the requested item or NULL

The documentation for this class was generated from the following file: