ActionNode

Metropolis SDK ›› Classes ››
Parent Previous Next

namespace Dysr.Metropolis.SDK

{

   /// <summary>

   /// AcitonNode is the object that does the ActionNode's processing. Any custom action node plug-ins

   /// should inherit from this class and override the Process() method.

   /// </summary>

   [DataContract]

   [KnownType(typeof(NodeType))]

   public class ActionNode

   {

       /// <summary>

       /// Id of the action node.

       /// </summary>

       [DataMember]

       public int Id { get; set; }

       /// <summary>

       /// ActionScheduleId of the parent action schedule running the node.

       /// </summary>

       [DataMember]

       public int ActionScheduleId { get; set; }

       /// <summary>

       /// The process order assigned to this action node by the parent action schedule.

       /// </summary>

       [DataMember]

       public int ProcessOrder { get; set; }

       /// <summary>

       /// Short name for the action node. Named by the user.

       /// </summary>

       [DataMember]

       public string ShortName { get; set; }

       /// <summary>

       /// The workspace data passed between nodes. Each node performs an action and adjusts the NodeData to

       /// show the action's results. For example, the Disk Load action node

       /// will add any files found and loaded to the NodeData object.

       /// </summary>

       [DataMember]

       public NodeData NodeData { get; set; }

       /// <summary>

       /// The property settings for the action node. These are set by the user.

       /// </summary>

       [DataMember]

       public ActionNodeProperty[] ActionNodePropertyList { get; set; }

       /// <summary>

       /// The node type definition of the action node. For example, a Disk Load node type.

       /// </summary>

       [DataMember]

       public NodeType NodeType { get; set; }

       /// <summary>

       /// The schedule detail log id for logging the action node's process.

       /// </summary>

       public int ScheduleDetailLogId { get; set; }

       /// <summary>

       /// The assigned temporary path used by the action node. This is the temp path that should be used.

       /// </summary>

       public string TempPath { get; set; }

       /// <summary>

       /// This is the main method for an ActionNode. This gets called when Metropolis is ready to process

       /// the ActionNode. Data passed to the next ActionNode to be processed is contained in NodeData.

       /// </summary>

       public virtual void Process() { }

       /// <summary>

       /// Returns the first ActionNodeProperty object with a designated key. Throws an exception if a

       /// corresponding ActionNodeProperty was not found by keyName. Key names are defined in the action

       /// node's NoteType.NodeTypePropertyList collection.

       /// </summary>

       /// <param name="keyName">The KeyName of the property</param>

       /// <returns>ActionNodeProperty with corresponding KeyName</returns>

       public ActionNodeProperty GetActionNodePropertyByKey(string keyName)

   }

}

Created with the Personal Edition of HelpNDoc: Full-featured Help generator