IrPort.java

/**
 * Copyright 2014 Comcast Cable Communications Management, LLC
 *
 * This file is part of CATS.
 *
 * CATS is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * CATS is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with CATS.  If not, see <http://www.gnu.org/licenses/>.
 */
package com.comcast.cats.service;

import com.comcast.cats.ir.commands.CatsCommand;
import com.comcast.cats.service.WebServiceReturn;

/**
 * Represents a port on the {@link IRDevice}
 * 
 * @author skurup00c
 * 
 */
public interface IrPort
{
    /**
     * Get the number of this port.
     * 
     * @return port number.
     */
    public int getPortNumber();

    /**
     * Get the IrDevice that this port belongs to.
     * 
     * @return
     */
    public IrDevice getIrDevice();

    /**
     * Send a CATSCommand to the device at this port.
     * 
     * @param command
     * @return
     */
    public WebServiceReturn sendCommand( CatsCommand command );
}