/* 
 * PROJECT: NyARToolkitCS
 * --------------------------------------------------------------------------------
 * This work is based on the original ARToolKit developed by
 *   Hirokazu Kato
 *   Mark Billinghurst
 *   HITLab, University of Washington, Seattle
 * http://www.hitl.washington.edu/artoolkit/
 *
 * The NyARToolkitCS is C# edition ARToolKit class library.
 * Copyright (C)2008-2009 Ryo Iizuka
 *
 * This program 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.
 * 
 * This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
 * 
 * For further information please contact.
 *	http://nyatla.jp/nyatoolkit/
 *	<airmail(at)ebony.plala.or.jp> or <nyatla(at)nyatla.jp>
 * 
 */
using System;
using System.Collections.Generic;

namespace jp.nyatla.nyartoolkit.cs
{
    /**
     * NyARToolkitライブラリが生成するExceptionのクラスです。
     * このクラスは、NyARToolkitライブラリ内でのみ使用します。
     *
     */
    public class NyARException : Exception
    {

	    /**
	     * コンストラクタです。例外オブジェクトを生成します。
	     */
	    public NyARException()
            :base()
	    {
	    }
	    /**
	     * コンストラクタです。例外オブジェクト継承して、例外を生成します。
	     * @param e
	     * 継承する例外オブジェクト
	     */
        public NyARException(Exception e)
            : base()
	    {
	    }
	    /**
	     * コンストラクタです。メッセージを指定して、例外を生成します。
	     * @param m
	     */
        public NyARException(String m)
            : base(m)
	    {
	    }
	    /**
	     * ライブラリ開発者向けの関数です。メッセージを指定して、例外をスローします。
	     * この関数は、NyARToolkitの仕様外動作を補足するために使います。
	     * @param m
	     * @throws NyARException
	     */

	    public static void trap(String m)
	    {
		    throw new NyARException("トラップ:" + m);
	    }
	    /**
	     * ライブラリ開発者向けの関数です。"Not Implement!"メッセージを指定して、例外をスローします。
	     * この関数は、NyARToolkitの未実装部分に記述して使います。
	     * @throws NyARException
	     */
	    public static void notImplement()
        {
		    throw new NyARException("Not Implement!");
	    }
	    /**
	     * この関数は使用不能です。（別の関数を使用してください。）
	     * @throws NyARException
	     */
	    public static void unavailability()
	    {
		    throw new NyARException("unavailability!");
	    }
    }

}
