Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

CSLEnvelopeList Class Reference

Describes the envelope list. More...

#include <EnvelopeList.h>

Inheritance diagram for CSLEnvelopeList::

CSLTemplate CSIBCNode List of all members.

Public Methods


Detailed Description

Describes the envelope list.


Constructor & Destructor Documentation

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

Constructor

Parameters:
in_pScene  Pointer to the scene containing the envelope
in_pModel  Pointer to the model containing the envelope
in_pTemplate  Pointer to the CdotXSITemplate containing the envelope
Returns:
an instance of CSLEnvelope

CSLEnvelopeList::~CSLEnvelopeList   [virtual]
 

Destructor


Member Function Documentation

CSLEnvelope * CSLEnvelopeList::AddEnvelope  
 

Add a new envelope to the list.

Returns:
CSLEnvelope* Pointer to the newly created envelope object.

SI_Error CSLEnvelopeList::ClearEnvelopes  
 

Remove all envelopes from the list.

Returns:
SI_Error Error code.

CSLEnvelope * CSLEnvelopeList::ConnectEnvelope CSLEnvelope   in_pNewEnvelope
 

Connects a new envelope

Parameters:
in_pNewEnvelope  the envelope to connect
Returns:
CSLEnvelope the connected envelope

CSLEnvelope ** CSLEnvelopeList::Envelopes  
 

Return an array of all envelopes in the list.

Returns:
CSLEnvelope** Array of pointers to envelope objects.

SI_Int CSLEnvelopeList::GetEnvelopeCount  
 

Return the number of envelopes in the list.

Returns:
SI_Int Number of envelopes.

SI_Error CSLEnvelopeList::RemoveEnvelope CSLEnvelope   in_pEnvelope
 

Remove a single envelope from the list.

Parameters:
in_pEnvelope  Pointer to the envelope to remove.
Returns:
SI_Error Error code.

SI_Error CSLEnvelopeList::RemoveEnvelope SI_Int    in_nIndex
 

Remove a single envelope from the list.

Parameters:
in_nIndex  Index of the envelope to remove.
Returns:
SI_Error Error code.

SI_Error CSLEnvelopeList::Synchronize   [virtual]
 

Synchronizes this envelope list instance with its IO layer representation

Returns:
SI_Error
Return values:
SI_SUCCESS  this function always returns SI_SUCCESS

Reimplemented from CSLTemplate.

virtual ETemplateType CSLEnvelopeList::Type   [inline, virtual]
 

Get the template type

Returns:
ETemplateType the template type of the envelope 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.