/*******************************************************************************
*   Copyright 2014 Analog Devices, Inc.
*
*   Licensed under the Apache License, Version 2.0 (the "License");
*   you may not use this file except in compliance with the License.
*   You may obtain a copy of the License at
*
*       http://www.apache.org/licenses/LICENSE-2.0
*
*   Unless required by applicable law or agreed to in writing, software
*   distributed under the License is distributed on an "AS IS" BASIS,
*   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*   See the License for the specific language governing permissions and
*   limitations under the License.
********************************************************************************/

package com.analog.lyric.dimple.model.core;

import com.analog.lyric.dimple.model.factors.Factor;
import com.analog.lyric.dimple.model.variables.Variable;

/**
 * Identifies type of {@link Node}.
 * <p>
 * @since 0.07
 * @author Christopher Barber
 */
public enum NodeType
{
	/**
	 * Node is a {@link Factor}.
	 */
	FACTOR,
	
	/**
	 * Node is a {@link FactorGraph}.
	 */
	GRAPH,
	
	/**
	 * Node is a {@link Variable}.
	 */
	VARIABLE;
	
	/*-------
	 * State
	 */
	
	/**
	 * Single-character representation of type.
	 * <p>
	 * This is simply the first character of the name ('F', 'G', or 'V').
	 * <p>
	 * @since 0.08
	 */
	public char character()
	{
		return name().charAt(0);
	}
}
