Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

CSLFXOperatorConnection Class Reference

Representation of a connection in the FX Tree. More...

#include <FXNodeConnection.h>

List of all members.

Public Types

Public Methods


Detailed Description

Representation of a connection in the FX Tree.


Member Enumeration Documentation

enum CSLFXOperatorConnection::EConnectionType
 

Defines the various types of connection.

Enumeration values:
SI_NONE  not connected.
SI_FXOPERATOR  connected to an effect operator.


Constructor & Destructor Documentation

CSLFXOperatorConnection::CSLFXOperatorConnection CdotXSITemplate   in_pTemplate,
SI_Int    in_nValueIndex
 

Constructor

Parameters:
in_pTemplate  Parent Template
in_nValueIndex  Index
Returns:
an instance of CSLFCOperatorConnection


Member Function Documentation

CSLFXOperatorConnection::EConnectionType CSLFXOperatorConnection::GetConnectionType  
 

Gets the connection type

Returns:
EConnectionType Type of connection

CSLFXOperator * CSLFXOperatorConnection::GetFXOperator  
 

Gets the refered node

Returns:
CSLFXOperator Pointer to the refered node or null if none

SI_Char * CSLFXOperatorConnection::GetName  
 

Gets the name of the connection

Returns:
SI_Char Name of the connection

SI_Void CSLFXOperatorConnection::SetConnectionType CSLFXOperatorConnection::EConnectionType    in_Type
 

Sets the connection type

Parameters:
in_Type  New type of connection

SI_Void CSLFXOperatorConnection::SetFXOperator CSLFXOperator   in_pNode
 

Sets the refered node

Parameters:
in_pNode  Pointer to the refered node or null if none

SI_Void CSLFXOperatorConnection::SetName SI_Char *    in_szName
 

Sets the name of the connection

Parameters:
in_szName  The name of the connection

SI_Error CSLFXOperatorConnection::Synchronize  
 

Commits semantic layer data

Returns:
SI_Error Whether or not commit was a success


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.