xsi_operator.h

Go to the documentation of this file.

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

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

#ifndef __XSIOPERATOR_H__
#define __XSIOPERATOR_H__

#include <xsi_projectitem.h>

namespace XSI {

class Port;

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

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

    ~Operator();

    Operator(const CRef& in_ref);

    Operator(const Operator& in_obj);

    bool IsA( siClassID in_ClassID) const;

    siClassID GetClassID() const;

    Operator& operator=(const Operator& in_obj);

    Operator& operator=(const CRef& in_ref);

    Port GetPort
    (
        const CString& in_portname,
        const CString& in_groupname,
        LONG in_instance = 0
    ) const;

    Port GetPortAt
    (
        LONG in_port,
        LONG in_group = 0,
        LONG in_instance = 0
    ) const;

    CRefArray GetInputPorts() const;

    CRefArray GetOutputPorts() const;

    LONG GetNumPortGroups() const;

    LONG GetNumPortsInGroup(LONG in_index) const;

    LONG GetNumInstancesInGroup(LONG in_index) const;

    bool GetMute(void) const;

    CStatus PutMute(bool in_mute);

    CStatus Disconnect(bool in_force);

    CStatus Connect(siConstructionMode in_mode = siConstructionModeDefault);

    CStatus Connect(const CRef& in_obj,siConstructionMode in_mode = siConstructionModeDefault);

    CStatus Connect(const CRefArray& in_objs, siConstructionMode in_mode = siConstructionModeDefault);

    CStatus Connect(const CString& in_objs,siConstructionMode in_mode = siConstructionModeDefault);

    CRefArray GetPortGroups() const;

    bool IsConnected() const;

    bool SupportsBranchGroup(LONG group = -1, LONG port = -1 ) const;

    CStatus ConnectToGroup( LONG in_Group, CRef & in_obj, LONG & out_Instance );

    CStatus DisconnectGroup( LONG in_Group, LONG in_Instance, bool in_Force = false );

    CValue GetInputValue(   LONG in_port,
                            LONG in_group = 0,
                            LONG in_instance = 0 ) const;

    CValue GetInputValue(   const CString&  in_port,
                            const CString&  in_group = CString(),
                            LONG            in_instance = 0 ) const;

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

};

};

#endif // __XSIOPERATOR_H__