IChannelContainer.h

Go to the documentation of this file.

/**********************************************************************
 *<
    CREATED BY: Oleg Bayborodin

    HISTORY: created 10-10-01

 *> Copyright (c) 2001, All Rights Reserved.
 **********************************************************************/

#pragma once

#include "..\ifnpub.h"

// interface ID
#define CHANNELCONTAINER_INTERFACE Interface_ID(0x74f93c00, 0x1eb34600) 

#define GetChannelContainerInterface(obj) ((IChannelContainer*)obj->GetInterface(CHANNELCONTAINER_INTERFACE)) 


class IChannelContainer : public FPMixinInterface
{
public:

    // function IDs
    enum {  
//          kNumChannels,
//          kGetChannel,
            kGetPublicChannel,
            kGetPrivateChannel,
            kAddChannel
    };


    // Function Map for Function Publish System 
    //***********************************
    BEGIN_FUNCTION_MAP

//  FN_0(kNumChannels, TYPE_INT, NumChannels);
//  FN_1(kGetChannel, TYPE_IOBJECT, GetChannel, TYPE_INT);
    FN_2(kGetPublicChannel, TYPE_IOBJECT, GetPublicChannel, TYPE_INT, TYPE_INT);
    FN_4(kGetPrivateChannel, TYPE_IOBJECT, GetPrivateChannel, TYPE_INT, TYPE_INT, TYPE_OBJECT, TYPE_INODE);
    FN_1(kAddChannel, TYPE_bool, AddChannel, TYPE_IOBJECT);

    END_FUNCTION_MAP

    virtual Class_ID GetClassID() = 0;

    virtual int NumChannels() const = 0;

    virtual IObject*& GetChannel(int i) = 0;

    virtual IObject* GetChannel(Interface_ID id, Object* privateOwner=NULL, INode* creatorAction=NULL) = 0;

    // FnPub alternatives for the method above
    IObject* GetPublicChannel(int id_PartA, int id_PartB)
    { return GetChannel( Interface_ID(id_PartA, id_PartB), NULL); }

    IObject* GetPrivateChannel(int id_PartA, int id_PartB, Object* privateOwner, INode* creatorAction)
    { return GetChannel( Interface_ID(id_PartA, id_PartB), privateOwner, creatorAction); }

    virtual bool    AddChannel(IObject* channel) = 0;

    virtual IObject* EnsureChannel(Interface_ID& iChanID, Class_ID& channelClassID, 
                                    bool isWrapper, Interface_ID& wrappingReadID, Interface_ID& wrappingWriteID,
                                    bool isTransferable=TRUE, INode* creatorAction=NULL, Object* privateOwner=NULL,
                                    bool* initChannel=NULL) = 0;

    virtual BaseInterface* EnsureInterface(Interface_ID& iChanID, Class_ID& channelClassID, 
                                    bool isWrapper, Interface_ID& wrappingReadID, Interface_ID& wrappingWriteID,
                                    bool isTransferable=TRUE, INode* creatorAction=NULL, Object* privateOwner=NULL,
                                    bool* initChannel=NULL) = 0;

    virtual BaseInterface* GetPrivateInterface(Interface_ID id, Object* privateOwner) = 0;

    virtual int RemoveNonTransferableChannels(INode* nextParticleGroup=NULL) = 0;

    virtual IObject* Clone() = 0;

    virtual bool Copy(IObject* container) = 0;

    virtual IOResult Save(ISave* isave) const = 0;

    virtual IOResult Load(ILoad* iload) = 0;

    virtual int MemoryUsed() const = 0;

    FPInterfaceDesc* GetDesc() { return GetDescByID(CHANNELCONTAINER_INTERFACE); }

};