Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

CSLUserDataList Class Reference

#include <XSIUserDataList.h>

Inheritance diagram for CSLUserDataList::

CSLTemplate CSIBCNode List of all members.

Public Methods


Detailed Description

Class CSLUserDataList

Defines a collection of XSI user-defined data

Note:
This template was introduced in dotXSI Version 3.6
See also:
CSLUserData , CSLCluster


Constructor & Destructor Documentation

CSLUserDataList::CSLUserDataList CSLScene   in_pScene,
CSLModel   in_pModel,
CdotXSITemplate   in_pTemplate
 

Constructor

Parameters:
in_pScene  Parent scene
in_pModel  Parent model
in_pTemplate  Refered template


Member Function Documentation

CSLUserData * CSLUserDataList::AddUserData  
 

Adds a user data to the user data list

Returns:
CSLUserData Pointer to the newly added user data

SI_Error CSLUserDataList::ClearUserDatas  
 

Removes all connections points from the user data list

Returns:
SI_Error Whether or not the list could be cleared

CSLUserData * CSLUserDataList::ConnectUserData CSLUserData   in_pNewUserData
 

Adds a exisiting user data to the user data list

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

CSLUserData * CSLUserDataList::FindUserData SI_Char *    in_szUserDataName
 

Searches for a given UserData

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

Reimplemented from CSIBCNode.

SI_Int CSLUserDataList::GetUserDataCount  
 

Gets the total number of user datas

Returns:
SI_Int Number of user datas

CSLUserData ** CSLUserDataList::GetUserDataList  
 

Gets a pointer to the internally-stored UserData pointer list

Returns:
CSLUserData Pointer to the list

SI_Error CSLUserDataList::RemoveUserData CSLUserData   in_pToRemove
 

Removes a user data from the user data list

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

SI_Error CSLUserDataList::RemoveUserData SI_Int    in_nIndex
 

Removes a user data from the user data list

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

SI_Error CSLUserDataList::Synchronize   [virtual]
 

Commits semantic layer data

Returns:
SI_Error Whether or not commit was a success

Reimplemented from CSLTemplate.

ETemplateType CSLUserDataList::Type   [inline, virtual]
 

Gets the type of this template

Returns:
ETemplateType The type of this template: XSI_USER_DATA_LIST

Reimplemented from CSLTemplate.


The documentation for this class was generated from the following files: © Copyright 2001-2003 Avid Technology, Inc. All rights reserved.

© Copyright 2001-2003 Avid Technology, Inc. All rights reserved.