class CCL::StructuredParameter

Overview

Helper class for structured parameters. More…

#include <params.h>

class StructuredParameter: public CCL::IStructuredParameter
{
public:
    // methods

    void addSubParameter (IParameter* p);
    void removeSubParameters ();
    virtual void CCL_API prepareStructure ();
    virtual void CCL_API cleanupStructure ();
    virtual int CCL_API countSubParameters () const;
    virtual IParameter*CCL_API getSubParameter (int index) const;
};

Inherited Members

public:
    // methods

    virtual tresult CCL_API queryInterface (UIDRef iid, void** ptr) = 0;
    virtual unsigned int CCL_API retain () = 0;
    virtual unsigned int CCL_API release () = 0;
    virtual void CCL_API prepareStructure () = 0;
    virtual void CCL_API cleanupStructure () = 0;
    virtual int CCL_API countSubParameters () const = 0;
    virtual IParameter*CCL_API getSubParameter (int index) const = 0;

Detailed Documentation

Helper class for structured parameters.

Methods

virtual void CCL_API prepareStructure ()

Set up parameter structure.

virtual void CCL_API cleanupStructure ()

Clean up parameter structure.

virtual int CCL_API countSubParameters () const

Get number of child parameters.

virtual IParameter*CCL_API getSubParameter (int index) const

Get child parameter at given index.