Python wrapper for a python defined command type More...

Inheritance diagram for QuantConnect.Python.CommandPythonWrapper:

Public Member Functions
	CommandPythonWrapper (PyObject type, string data=null)
	Constructor for initialising the CommandPythonWrapper class with wrapped PyObject object More...

bool?	Run (IAlgorithm algorithm)
	Run this command using the target algorithm More...

Public Member Functions inherited from QuantConnect.Python.BasePythonWrapper< Command >
	BasePythonWrapper (bool validateInterface=true)
	Creates a new instance of the BasePythonWrapper<TInterface> class More...

	BasePythonWrapper (PyObject instance, bool validateInterface=true)
	Creates a new instance of the BasePythonWrapper<TInterface> class with the specified instance More...

void	SetPythonInstance (PyObject instance)
	Sets the python instance More...

T	GetProperty< T > (string propertyName)
	Gets the Python instance property with the specified name More...

PyObject	GetProperty (string propertyName)
	Gets the Python instance property with the specified name More...

void	SetProperty (string propertyName, object value)
	Sets the Python instance property with the specified name More...

dynamic	GetEvent (string name)
	Gets the Python instance event with the specified name More...

bool	HasAttr (string name)
	Determines whether the Python instance has the specified attribute More...

PyObject	GetMethod (string methodName)
	Gets the Python instances method with the specified name and caches it More...

T	InvokeMethod< T > (string methodName, params object[] args)
	Invokes the specified method with the specified arguments More...

PyObject	InvokeMethod (string methodName, params object[] args)
	Invokes the specified method with the specified arguments More...

void	InvokeVoidMethod (string methodName, params object[] args)
	Invokes the specified method with the specified arguments without returning a value More...

IEnumerable< T >	InvokeMethodAndEnumerate< T > (string methodName, params object[] args)
	Invokes the specified method with the specified arguments and iterates over the returned values More...

Dictionary< TKey, TValue >	InvokeMethodAndGetDictionary< TKey, TValue > (string methodName, params object[] args)
	Invokes the specified method with the specified arguments and iterates over the returned values More...

T	InvokeMethodWithOutParameters< T > (string methodName, Type[] outParametersTypes, out object[] outParameters, params object[] args)
	Invokes the specified method with the specified arguments and out parameters More...

T	InvokeMethodAndWrapResult< T > (string methodName, Func< PyObject, T > wrapResult, params object[] args)
	Invokes the specified method with the specified arguments and wraps the result by calling the given function if the result is not a C# object More...

virtual bool	Equals (BasePythonWrapper< TInterface > other)
	Determines whether the specified instance wraps the same Python object reference as this instance, which would indicate that they are equal. More...

override bool	Equals (object obj)
	Determines whether the specified object is an instance of BasePythonWrapper<TInterface> and wraps the same Python object reference as this instance, which would indicate that they are equal. More...

override int	GetHashCode ()
	Gets the hash code for the current instance More...

Static Public Member Functions
static string	Serialize (PyObject command)
	Helper method to serialize a command instance More...

Additional Inherited Members
Protected Attributes inherited from QuantConnect.Python.BasePythonWrapper< Command >
PyObject	Instance
	Gets the underlying python instance More...

Detailed Description

Python wrapper for a python defined command type

Definition at line 28 of file CommandPythonWrapper.cs.

Constructor & Destructor Documentation

◆ CommandPythonWrapper()

QuantConnect.Python.CommandPythonWrapper.CommandPythonWrapper	(	PyObject	type,
		string	data = `null`
	)

Constructor for initialising the CommandPythonWrapper class with wrapped PyObject object

Parameters

type	Python command type
data	Command data

Definition at line 37 of file CommandPythonWrapper.cs.

Here is the call graph for this function:

Member Function Documentation

◆ Run()

bool? QuantConnect.Python.CommandPythonWrapper.Run ( IAlgorithm algorithm )

Run this command using the target algorithm

Parameters

algorithm The algorithm instance

Returns: True if success, false otherwise. Returning null will disable command feedback

Definition at line 75 of file CommandPythonWrapper.cs.

Here is the call graph for this function:

◆ Serialize()

static string QuantConnect.Python.CommandPythonWrapper.Serialize ( PyObject command )

static

Helper method to serialize a command instance

Definition at line 85 of file CommandPythonWrapper.cs.

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

Common/Python/CommandPythonWrapper.cs

Public Member Functions