Click here to Skip to main content
15,884,893 members
Articles / Programming Languages / C#

A .NET State Machine Toolkit - Part I

Rate me:
Please Sign up or sign in to vote.
4.80/5 (69 votes)
29 Mar 2007CPOL18 min read 409.9K   2.5K   290  
An introduction to the .NET State Machine Toolkit.
/*
 * Created by: Leslie Sanford
 * 
 * Contact: jabberdabber@hotmail.com
 * 
 * Last modified: 10/13/2005
 */

using System;
using System.CodeDom;
using System.Collections;

namespace StateMachineToolkit
{
	/// <summary>
	/// Builds the fields belonging to the state machine.
	/// </summary>
    internal class FieldBuilder
	{
        #region FieldBuilder Members

        #region Fields

        // The state machine's states.
        private ICollection states;

        // The state machine's guards.
        private ICollection guards;

        // The state machine's actions.
        private ICollection actions;

        // The EventIDBuilder.
        private EventIDBuilder eventIDBuilder;

        // The list of built fields.
        private ArrayList fields = new ArrayList();

        #endregion

        #region Construction

        /// <summary>
        /// Initializes a new instance of the FieldBuilder class with the 
        /// specified state, guard, and action tables.
        /// </summary>
        /// <param name="state">
        /// The states from which to declare the State object fields.
        /// </param>
        /// <param name="events">
        /// The events from which to declare the event ID fields.
        /// </param>
        /// <param name="guard">
        /// The guards from which to declare the GuardHandler delegate fields.
        /// </param>
        /// <param name="action">
        /// The actions from which to declare the ActionHandler delegate fields.
        /// </param>
		public FieldBuilder(ICollection states, ICollection events, ICollection guards, 
            ICollection actions)
		{
            this.states = states;
            this.guards = guards;
            this.actions = actions;

            eventIDBuilder = new EventIDBuilder(events);
		}

        #endregion

        #region Methods

        /// <summary>
        /// Builds the fields.
        /// </summary>
        public void Build()
        {
            eventIDBuilder.Build();

            fields = new ArrayList(eventIDBuilder.Result);

            BuildFields(states, "Name", "state", typeof(State));
            BuildFields(guards, "Name", "guard", typeof(GuardHandler));
            BuildFields(actions, "Name", "action", typeof(ActionHandler));
        }

        // Does the actual field generation.
        private void BuildFields(ICollection collection, string columnName, 
            string fieldPrefix, Type fieldType)
        {
            CodeMemberField field;

            foreach(string name in collection)
            {
                field = new CodeMemberField(fieldType, fieldPrefix + name);
                fields.Add(field);
            }
        }

        #endregion

        #region Properties

        /// <summary>
        /// Gets the collection of built fields.
        /// </summary>
        public ICollection Result
        {
            get
            {
                return fields;
            }
        }

        #endregion

        #endregion
	}
}

By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.

If a file you wish to view isn't highlighted, and is a text file (not binary), please let us know and we'll add colourisation support for it.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)


Written By
United States United States
Aside from dabbling in BASIC on his old Atari 1040ST years ago, Leslie's programming experience didn't really begin until he discovered the Internet in the late 90s. There he found a treasure trove of information about two of his favorite interests: MIDI and sound synthesis.

After spending a good deal of time calculating formulas he found on the Internet for creating new sounds by hand, he decided that an easier way would be to program the computer to do the work for him. This led him to learn C. He discovered that beyond using programming as a tool for synthesizing sound, he loved programming in and of itself.

Eventually he taught himself C++ and C#, and along the way he immersed himself in the ideas of object oriented programming. Like many of us, he gotten bitten by the design patterns bug and a copy of GOF is never far from his hands.

Now his primary interest is in creating a complete MIDI toolkit using the C# language. He hopes to create something that will become an indispensable tool for those wanting to write MIDI applications for the .NET framework.

Besides programming, his other interests are photography and playing his Les Paul guitars.

Comments and Discussions