svkAlgorithmPortMapper.h

Go to the documentation of this file.

/*
 *  Copyright © 2009-2014 The Regents of the University of California.
 *  All Rights Reserved.
 *
 *  Redistribution and use in source and binary forms, with or without 
 *  modification, are permitted provided that the following conditions are met:
 *  •   Redistributions of source code must retain the above copyright notice, 
 *      this list of conditions and the following disclaimer.
 *  •   Redistributions in binary form must reproduce the above copyright notice, 
 *      this list of conditions and the following disclaimer in the documentation 
 *      and/or other materials provided with the distribution.
 *  •   None of the names of any campus of the University of California, the name 
 *      "The Regents of the University of California," or the names of any of its 
 *      contributors may be used to endorse or promote products derived from this 
 *      software without specific prior written permission.
 *  
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
 *  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
 *  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
 *  IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
 *  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
 *  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
 *  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
 *  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 
 *  OF SUCH DAMAGE.
 */



/*
 *  $URL$
 *  $Rev$
 *  $Author$
 *  $Date$
 *
 *  Authors:
 *      Jason C. Crane, Ph.D.
 *      Beck Olson
 */


#ifndef SVK_ALGORITHM_PORT_MAPPER_H
#define SVK_ALGORITHM_PORT_MAPPER_H


#include <vtkObject.h>
#include <vtkObjectFactory.h>
#include <vtkInformation.h>

#include <svkImageData.h>
#include <svkMriImageData.h>
#include <svkImageAlgorithm.h>
#include <svkDcmHeader.h>
#include <svkUtils.h>
#include <svkDouble.h>
#include <svkString.h>
#include <svkInt.h>
#include <svkBool.h>
#include <svkXML.h>
#include <vtkAlgorithmOutput.h>
#include <svkImageReaderFactory.h>
#include <string>

namespace svk {


using namespace std;


class svkAlgorithmPortMapper : public vtkObject
{

    public:

        typedef enum {
            SVK_BOOL = 0,
            SVK_INT,
            SVK_DOUBLE ,
            SVK_STRING,
            SVK_IMAGE_DATA,
            SVK_MR_IMAGE_DATA,
            SVK_MRS_IMAGE_DATA,
            SVK_4D_IMAGE_DATA,
            SVK_XML
        } svkXMLDataType;

        struct svkInputPortInfo {
            string name;
            int    type;
            bool   required;
            bool   repeatable;
        };

        struct svkOutputPortInfo {
            string name;
            int type;
        };

        static svkAlgorithmPortMapper* New();
        vtkTypeMacro( svkAlgorithmPortMapper, vtkObject);

        void                     SetAlgorithm( vtkAlgorithm* algo );

        void                     InitializeOutputPort( int port, string name, int type );

        vtkAlgorithmOutput*      GetOutputPort( string name );

        vtkAlgorithmOutput*      GetOutputPort( int port );

        int                      GetNumberOfOutputPorts( );

        string                   GetXMLTagForOutputPort( int port );

        int                      FillOutputPortInformation( int port, vtkInformation* info );

        void                     InitializeInputPort( int port, string name, int type, bool required = true, bool repeatable = false );

        void                     SetInputConnection( int port, vtkAlgorithmOutput* output );

        int                      GetNumberOfInputPorts( );

        void                     SetInputPortsFromXML( vtkXMLDataElement* element );

        int                      FillInputPortInformation( int port, vtkInformation* info );

        void                     SetDoubleInputPortValue( int port, double value );
        svkDouble*               GetDoubleInputPortValue( int port, int connection = 0 );

        void                     SetIntInputPortValue( int port, int value );
        svkInt*                  GetIntInputPortValue( int port );

        void                     SetStringInputPortValue( int port, string value );
        svkString*               GetStringInputPortValue( int port);

        void                     SetBoolInputPortValueUsingString( int port, string value );
        void                     SetBoolInputPortValue( int port, bool value );
        svkBool*                 GetBoolInputPortValue( int port);

        void                     SetXMLInputPortValue( int port, vtkXMLDataElement* value );
        svkXML*                  GetXMLInputPortValue( int port);

        void                     SetMRImageInputPortValue( int port, string filename );

        svkMrsImageData*         GetMRSImageInputPortValue( int port, int connection = 0);

        void                     SetMRSImageInputPortValue( int port, string filename );

        svkImageData*            GetImageInputPortValue( int port, int connection = 0);

        svkMriImageData*         GetMRImageInputPortValue( int port, int connection = 0);

        string                   GetInputPortName( int port );

        string                   GetOutputPortName( int port );

        string                   GetXMLTagForInputPort( int port );

        string                   GetXMLTagForAlgorithm( );

        bool                     GetInputPortRequired( int port );

        bool                     GetInputPortRepeatable( int port );

        string                   GetXMLInputPortPrefix( );

        void                     SetXMLPortPrefix( string prefix );

        string                   GetXMLAlgorithmPrefix( );

        void                     SetXMLAlgorithmPrefix( string prefix );

        string                   GetXSD( );

        virtual vtkDataObject*   GetAlgorithmInputPort( int port, int index = 0 );

        virtual void             SetAlgorithmInputPort( int port, vtkDataObject* input );

        void                     PrintSelf( ostream &os, vtkIndent indent );

        static string    GetClassTypeFromDataType( int type );

        int              GetInputPortNumber( string name );

        int              GetInputPortType( int port );

    protected:

        svkAlgorithmPortMapper();
        ~svkAlgorithmPortMapper();

        string           portPrefix;

        string           algorithmPrefix;

        vector<svkInputPortInfo>   inputPorts;

        vector<svkOutputPortInfo>   outputPorts;



    private:

        void             SetInputPortFromXML( int port, vtkXMLDataElement* parameterElement );

        vtkAlgorithm*    algo;

};


}   //svk


#endif //SVK_ALGORITHM_PORT_MAPPER_H