xsi_customoperator.h

Go to the documentation of this file.

//*****************************************************************************
//*****************************************************************************

#if (_MSC_VER > 1000) || defined(SGI_COMPILER)
#pragma once
#endif

#ifndef __XSICUSTOMOPERATOR_H__
#define __XSICUSTOMOPERATOR_H__

#include <xsi_operator.h>

namespace XSI {

class ParamDef;
class PortGroup;

//*****************************************************************************
//*****************************************************************************

class SICPPSDKDECL CustomOperator : public Operator
{
public:
    CustomOperator();

    ~CustomOperator();

    CustomOperator(const CRef& in_ref);

    CustomOperator(const CustomOperator& in_obj);

    bool IsA( siClassID in_ClassID) const;

    siClassID GetClassID() const;

    CustomOperator& operator=(const CustomOperator& in_obj);

    CustomOperator& operator=(const CRef& in_ref);

    CString GetFileName(void) const;

    CStatus PutFileName(const CString& in_str);

    CString GetLanguage(void) const;

    CString GetCode(void) const;

    CStatus PutCode(const CString& code);

    LONG GetDebug(void) const;

    CStatus PutDebug(LONG debug);

    bool GetAlwaysEvaluate(void) const;

    CStatus PutAlwaysEvaluate(bool val);

    CStatus AddParameter(
        const CRef& in_paramdef,
        Parameter&  io_parameter );

    CStatus RemoveParameter( const Parameter& in_param );

    CRef AddInputPort( const CRef& obj, const CString& name=CString(), LONG group=-1, LONG insertat=-1, LONG flags=0, CStatus* pst = 0 );

    CRef AddOutputPort( const CRef& obj, const CString& name=CString(), LONG group=-1, LONG insertat=-1, LONG flags=0, CStatus* pst = 0 );

    CRefArray AddIOPort( const CRef& obj, const CString& name=CString(), LONG group=-1, LONG insertat=-1, LONG flags=0, CStatus* pst = 0 );

    CRef AddPortGroup( const CString& name, LONG groupmin=1, LONG groupmax=1, const CString& filterid=CString(), const CString& pickprompt=CString(), LONG flags=0, CStatus* pst = 0 );

    CStatus Validate();

    CRef AddInputPortByClassID( siClassID in_TargetClassID,
                                const CString& in_strPortName=CString(),
                                LONG in_PortGroup=-1,
                                LONG in_InsertAt=0,
                                LONG in_flags=0 );

    CRef AddOutputPortByClassID(siClassID in_TargetClassID,
                                const CString& in_strPortName=CString(),
                                LONG in_PortGroup=-1,
                                LONG in_InsertAt=0,
                                LONG in_flags=0 );

    CRefArray AddIOPortByClassID(siClassID in_TargetClassID,
                                const CString& in_strPortName=CString(),
                                LONG in_PortGroup=-1,
                                LONG in_InsertAt=0,
                                LONG in_flags=0 );


    private:
    CustomOperator * operator&() const;
    CustomOperator * operator&();

};

};

#endif // __XSICUSTOMOPERATOR_H__