MockPlugin.Tasks.FlexibleArguments Class Reference

This task demonstrates how to use a custom type descriptor to implement a dynamic list of properties. The number of properties can be changed by setting the PropCount property. More...

Inheritance diagram for MockPlugin.Tasks.FlexibleArguments:

Collaboration diagram for MockPlugin.Tasks.FlexibleArguments:

Classes
class	MyMemberDescriptor
	Member descriptor "implementation" - the defaults are ok for us. More...
class	MyPropertyDescriptor
	Custom property descriptor, redirecting get/set into our mPropsValues dictionary. More...

Public Member Functions
void	PreValidate ()
	Called before the schedule construction is completed.
void	PostValidate ()
	Called after the schedule construction is completed.
void	Execute ()
	Do whatever you have to do with your parameters.
string	GetTaskAction ()
	Description of the tasks's action (for hints/time table)
	FlexibleArguments ()
override object	GetPropertyOwner (PropertyDescriptor pd)
	Must be overridden, else you'll get NullRefrences when trying to work with the descriptor.
override PropertyDescriptorCollection	GetProperties ()
override AttributeCollection	GetAttributes ()
Public Member Functions inherited from AxelSemrau.Chronos.Plugin.ITask

Properties
uint	PropCount [get, set]

Private Member Functions
string	GetArgList ()

Private Attributes
readonly Dictionary< string, object >	mPropsValues = new Dictionary<string, object>()
	Storage for fake property names and values.
PropertyDescriptorCollection	mPropDescColl
	Caches the list resulting from set_PropCount.
readonly List< PropertyDescriptor >	mProps = new List<PropertyDescriptor>()
readonly AttributeCollection	mAttrs
uint	mPropCount

Detailed Description

This task demonstrates how to use a custom type descriptor to implement a dynamic list of properties. The number of properties can be changed by setting the PropCount property.

Definition at line 17 of file MockDynamicProperties.cs.

Constructor & Destructor Documentation

FlexibleArguments()

MockPlugin.Tasks.FlexibleArguments.FlexibleArguments

(

)

Definition at line 66 of file MockDynamicProperties.cs.

        {
            // if we don't return this when asked, the ScheduleDiagramColor declaration above will not be seen by Chronos.
            mAttrs = TypeDescriptor.GetAttributes(this, noCustomTypeDesc: true);
            // Default descriptor for the only real property
            var reflProp = TypeDescriptor.GetProperties(this, noCustomTypeDesc: true).Find(nameof(PropCount), false);
            mProps.Add(reflProp);
            // Add some fake properties to start with
            // This one has a unit:
            mProps.Add(new MyPropertyDescriptor("SomeIntParam", typeof(int), "s"));
            var resProp = new MyPropertyDescriptor("SomeCalculationResult", typeof(int));
            resProp.AddAttribute(new ReadOnlyAttribute(true));
            mProps.Add(resProp);
            mProps.Add(new MyPropertyDescriptor("SomeStringParam", typeof(string)));
            mProps.Add(new MyPropertyDescriptor("SomeBoolParam", typeof(bool)));
            PropCount = (uint)mProps.Count;
        }

References MockPlugin.Tasks.FlexibleArguments.mAttrs, MockPlugin.Tasks.FlexibleArguments.mProps, and MockPlugin.Tasks.FlexibleArguments.PropCount.

Referenced by MockPlugin.Tasks.FlexibleArguments.MyPropertyDescriptor.GetValue(), and MockPlugin.Tasks.FlexibleArguments.MyPropertyDescriptor.SetValue().

Member Function Documentation

Execute()

void MockPlugin.Tasks.FlexibleArguments.Execute

(

)

Do whatever you have to do with your parameters.

Implements AxelSemrau.Chronos.Plugin.ITask.

Definition at line 31 of file MockDynamicProperties.cs.

        {
            // nothing
        }

GetArgList()

string MockPlugin.Tasks.FlexibleArguments.GetArgList ( )

private

Definition at line 36 of file MockDynamicProperties.cs.

        {
            var sb = new System.Text.StringBuilder();
            foreach (var key in mPropsValues.Keys)
            {
                sb.AppendFormat("{0}={1};", key, mPropsValues[key]);
            }
            if (sb.Length > 0)
            {
                sb.Length -= 1;
            }
            else
            {
                return "No properties";
            }
            return sb.ToString();
        }

References MockPlugin.Tasks.FlexibleArguments.mPropsValues.

Referenced by MockPlugin.Tasks.FlexibleArguments.GetTaskAction().

GetAttributes()

override AttributeCollection MockPlugin.Tasks.FlexibleArguments.GetAttributes

(

)

GetProperties()

override PropertyDescriptorCollection MockPlugin.Tasks.FlexibleArguments.GetProperties

(

)

Definition at line 176 of file MockDynamicProperties.cs.

        {
            return mPropDescColl;
        }

References MockPlugin.Tasks.FlexibleArguments.mPropDescColl.

GetPropertyOwner()

override object MockPlugin.Tasks.FlexibleArguments.GetPropertyOwner

(

PropertyDescriptor

pd

)

Must be overridden, else you'll get NullRefrences when trying to work with the descriptor.

Parameters

pd

Returns

Definition at line 166 of file MockDynamicProperties.cs.

        {
            return mProps.Contains(pd) ? this : null;
        }

References MockPlugin.Tasks.FlexibleArguments.mProps.

GetTaskAction()

string MockPlugin.Tasks.FlexibleArguments.GetTaskAction

(

)

Description of the tasks's action (for hints/time table)

Implements AxelSemrau.Chronos.Plugin.ITask.

Definition at line 54 of file MockDynamicProperties.cs.

        {
            return GetArgList();
        }

References MockPlugin.Tasks.FlexibleArguments.GetArgList().

PostValidate()

void MockPlugin.Tasks.FlexibleArguments.PostValidate

(

)

Called after the schedule construction is completed.

Implements AxelSemrau.Chronos.Plugin.ITask.

Definition at line 26 of file MockDynamicProperties.cs.

        {
            // nothing
        }

PreValidate()

void MockPlugin.Tasks.FlexibleArguments.PreValidate

(

)

Called before the schedule construction is completed.

Implements AxelSemrau.Chronos.Plugin.ITask.

Definition at line 21 of file MockDynamicProperties.cs.

        {
            // nothing
        }

Member Data Documentation

mAttrs

readonly AttributeCollection MockPlugin.Tasks.FlexibleArguments.mAttrs

private

Definition at line 186 of file MockDynamicProperties.cs.

Referenced by MockPlugin.Tasks.FlexibleArguments.FlexibleArguments().

mPropCount

uint MockPlugin.Tasks.FlexibleArguments.mPropCount

private

Definition at line 187 of file MockDynamicProperties.cs.

mPropDescColl

PropertyDescriptorCollection MockPlugin.Tasks.FlexibleArguments.mPropDescColl

private

Caches the list resulting from set_PropCount.

Definition at line 174 of file MockDynamicProperties.cs.

Referenced by MockPlugin.Tasks.FlexibleArguments.GetProperties().

mProps

readonly List<PropertyDescriptor> MockPlugin.Tasks.FlexibleArguments.mProps = new List<PropertyDescriptor>()

private

Definition at line 185 of file MockDynamicProperties.cs.

Referenced by MockPlugin.Tasks.FlexibleArguments.FlexibleArguments(), and MockPlugin.Tasks.FlexibleArguments.GetPropertyOwner().

mPropsValues

readonly Dictionary<string, object> MockPlugin.Tasks.FlexibleArguments.mPropsValues = new Dictionary<string, object>()

private

Storage for fake property names and values.

Definition at line 64 of file MockDynamicProperties.cs.

Referenced by MockPlugin.Tasks.FlexibleArguments.GetArgList(), MockPlugin.Tasks.FlexibleArguments.MyPropertyDescriptor.GetValue(), and MockPlugin.Tasks.FlexibleArguments.MyPropertyDescriptor.SetValue().

Property Documentation

PropCount

uint MockPlugin.Tasks.FlexibleArguments.PropCount

getset

Definition at line 190 of file MockDynamicProperties.cs.

        {
            get => mPropCount;
            set
            {
                var oldCount = mPropCount;
                // fill up to whatever the user wants, but do not let him hide PropCount
                mPropCount = Math.Max(1, value);
                if (oldCount != mPropCount)
                {
                    for (int i = mProps.Count; i < mPropCount; ++i)
                    {
                        mProps.Add(new MyPropertyDescriptor($"FakeProp{i}", typeof(string)));
                    }
                    // when the number is decreased, we just present a part of our internal list
                    mPropDescColl = new PropertyDescriptorCollection(mProps.Take((int)mPropCount).ToArray());
 
                    // the list of dynamic properties has just changed, 
                    // alert the reflection manager so the time table can access the new properties
                    TypeDescriptor.Refresh(this);
                }
            }
        }

Referenced by MockPlugin.Tasks.FlexibleArguments.FlexibleArguments().

---

The documentation for this class was generated from the following file:

• MockDynamicProperties.cs