CSLUserDataList Class Reference

This class represents an XSI_UserDataList template. More...

#include <XSIUserDataList.h>

Inheritance diagram for CSLUserDataList:

CSLTemplate CSIBCNode List of all members.

Public Member Functions
  CSLUserDataList (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate)
virtual  ~CSLUserDataList ()
  Destructor.
ETemplateType  Type ()
SI_Error  Synchronize ()
CSLUserData *  AddUserData ()
SI_Error  RemoveUserData (SI_Int in_nIndex)
SI_Error  RemoveUserData (CSLUserData *in_pToRemove)
SI_Error  ClearUserDatas ()
CSLUserData *  ConnectUserData (CSLUserData *in_pToConnect)
CSLUserData **  GetUserDataList ()
SI_Int  GetUserDataCount ()
CSLUserData *  FindUserData (SI_Char *in_szUserDataName)

Detailed Description

This class represents an XSI_UserDataList template.

Defines a collection of user-defined data (see the XSI_UserDataList template reference).

See also:
CSLUserData

CSLCluster

Since:
dotXSI 3.6

Constructor & Destructor Documentation

CSLUserDataList ( CSLScene *  in_pScene,
CSLModel *  in_pModel,
CdotXSITemplate *  in_pTemplate  
)

Constructor

Parameters:
[in]  in_pScene  Parent scene
[in]  in_pModel  Parent model
[in]  in_pTemplate  Refered template

Member Function Documentation

ETemplateType Type (  )  [inline, virtual]

Returns the type of this template

Return values:
CSLTemplate::XSI_USER_DATA_LIST  The type of this template

Implements CSLTemplate.

SI_Error Synchronize (  )  [virtual]

Commits semantic layer data

Returns:
Whether or not commit was a success

Reimplemented from CSLTemplate.

CSLUserData* AddUserData (  ) 

Adds a user data to the user data list

Returns:
Pointer to the newly added user data

SI_Error RemoveUserData ( SI_Int  in_nIndex  ) 

Removes a user data from the user data list

Parameters:
[in]  in_nIndex  Index of the user data to remove
Returns:
Whether or not the user data could be removed

SI_Error RemoveUserData ( CSLUserData *  in_pToRemove  ) 

Removes a user data from the user data list

Parameters:
[in]  in_pToRemove  Pointer to the user data to remove
Returns:
Whether or not the user data could be removed

SI_Error ClearUserDatas (  ) 

Removes all connections points from the user data list

Returns:
Whether or not the list could be cleared

CSLUserData* ConnectUserData ( CSLUserData *  in_pToConnect  ) 

Adds a exisiting user data to the user data list

Parameters:
[in]  in_pToConnect  Pointer to the user data to add
Returns:
The added user data or null if it already exists in the list

CSLUserData** GetUserDataList (  ) 

Returns a pointer to the internally-stored UserData pointer list

Returns:
Pointer to the list

SI_Int GetUserDataCount (  ) 

Returns the total number of user datas

Returns:
Number of user datas

CSLUserData* FindUserData ( SI_Char *  in_szUserDataName  ) 

Searches for a given UserData

Parameters:
[in]  in_szUserDataName  Name of the user data to look for
Returns:
Pointer to the user data or null if it canot be found

Reimplemented from CSIBCNode.

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