// link the instance to a real YoctoAPI object
internal override void linkToHardware(string hwdName)
{
YDualPower hwd = YDualPower.FindDualPower(hwdName);
// first redo base_init to update all _func pointers
base_init(hwd, hwdName);
// then setup Yocto-API pointers and callbacks
init(hwd);
}
// perform the 2nd stage setup that requires YoctoAPI object
protected void init(YDualPower hwd)
{
if (hwd == null)
{
return;
}
base.init(hwd);
InternalStuff.log("registering DualPower callback");
_func.registerValueCallback(valueChangeCallback);
}
/**
* <summary>
* Retrieves a dual power control for a given identifier.
* <para>
* The identifier can be specified using several formats:
* </para>
* <para>
* </para>
* <para>
* - FunctionLogicalName
* </para>
* <para>
* - ModuleSerialNumber.FunctionIdentifier
* </para>
* <para>
* - ModuleSerialNumber.FunctionLogicalName
* </para>
* <para>
* - ModuleLogicalName.FunctionIdentifier
* </para>
* <para>
* - ModuleLogicalName.FunctionLogicalName
* </para>
* <para>
* </para>
* <para>
* This function does not require that the power control is online at the time
* it is invoked. The returned object is nevertheless valid.
* Use the method <c>YDualPower.isOnline()</c> to test if the power control is
* indeed online at a given time. In case of ambiguity when looking for
* a dual power control by logical name, no error is notified: the first instance
* found is returned. The search is performed first by hardware name,
* then by logical name.
* </para>
* </summary>
* <param name="func">
* a string that uniquely characterizes the power control
* </param>
* <returns>
* a <c>YDualPower</c> object allowing you to drive the power control.
* </returns>
*/
public static YDualPower FindDualPower(string func)
{
YDualPower obj;
obj = (YDualPower)YFunction._FindFromCache("DualPower", func);
if (obj == null)
{
obj = new YDualPower(func);
YFunction._AddToCache("DualPower", func, obj);
}
return(obj);
}
// --- (end of YDualPower implementation)
// --- (DualPower functions)
/**
* <summary>
* Retrieves a dual power control for a given identifier.
* <para>
* The identifier can be specified using several formats:
* </para>
* <para>
* </para>
* <para>
* - FunctionLogicalName
* </para>
* <para>
* - ModuleSerialNumber.FunctionIdentifier
* </para>
* <para>
* - ModuleSerialNumber.FunctionLogicalName
* </para>
* <para>
* - ModuleLogicalName.FunctionIdentifier
* </para>
* <para>
* - ModuleLogicalName.FunctionLogicalName
* </para>
* <para>
* </para>
* <para>
* This function does not require that the power control is online at the time
* it is invoked. The returned object is nevertheless valid.
* Use the method <c>YDualPower.isOnline()</c> to test if the power control is
* indeed online at a given time. In case of ambiguity when looking for
* a dual power control by logical name, no error is notified: the first instance
* found is returned. The search is performed first by hardware name,
* then by logical name.
* </para>
* </summary>
* <param name="func">
* a string that uniquely characterizes the power control
* </param>
* <returns>
* a <c>YDualPower</c> object allowing you to drive the power control.
* </returns>
*/
public static YDualPower FindDualPower(string func)
{
YDualPower res;
if (_DualPowerCache.ContainsKey(func))
{
return((YDualPower)_DualPowerCache[func]);
}
res = new YDualPower(func);
_DualPowerCache.Add(func, res);
return(res);
}
public static YDualPowerProxy FindDualPower(string name)
{
// cases to handle:
// name ="" no matching unknwn
// name ="" unknown exists
// name != "" no matching unknown
// name !="" unknown exists
YDualPower func = null;
YDualPowerProxy res = (YDualPowerProxy)YFunctionProxy.FindSimilarUnknownFunction("YDualPowerProxy");
if (name == "")
{
if (res != null)
{
return(res);
}
res = (YDualPowerProxy)YFunctionProxy.FindSimilarKnownFunction("YDualPowerProxy");
if (res != null)
{
return(res);
}
func = YDualPower.FirstDualPower();
if (func != null)
{
name = func.get_hardwareId();
if (func.get_userData() != null)
{
return((YDualPowerProxy)func.get_userData());
}
}
}
else
{
func = YDualPower.FindDualPower(name);
if (func.get_userData() != null)
{
return((YDualPowerProxy)func.get_userData());
}
}
if (res == null)
{
res = new YDualPowerProxy(func, name);
}
if (func != null)
{
res.linkToHardware(name);
if (func.isOnline())
{
res.arrival();
}
}
return(res);
}
/**
* <summary>
* Enumerates all functions of type DualPower available on the devices
* currently reachable by the library, and returns their unique hardware ID.
* <para>
* Each of these IDs can be provided as argument to the method
* <c>YDualPower.FindDualPower</c> to obtain an object that can control the
* corresponding device.
* </para>
* </summary>
* <returns>
* an array of strings, each string containing the unique hardwareId
* of a device function currently connected.
* </returns>
*/
public static new string[] GetSimilarFunctions()
{
List <string> res = new List <string>();
YDualPower it = YDualPower.FirstDualPower();
while (it != null)
{
res.Add(it.get_hardwareId());
it = it.nextDualPower();
}
return(res.ToArray());
}
// --- (end of YDualPower implementation)
// --- (DualPower functions)
/**
* <summary>
* Retrieves a dual power control for a given identifier.
* <para>
* The identifier can be specified using several formats:
* </para>
* <para>
* </para>
* <para>
* - FunctionLogicalName
* </para>
* <para>
* - ModuleSerialNumber.FunctionIdentifier
* </para>
* <para>
* - ModuleSerialNumber.FunctionLogicalName
* </para>
* <para>
* - ModuleLogicalName.FunctionIdentifier
* </para>
* <para>
* - ModuleLogicalName.FunctionLogicalName
* </para>
* <para>
* </para>
* <para>
* This function does not require that the power control is online at the time
* it is invoked. The returned object is nevertheless valid.
* Use the method <c>YDualPower.isOnline()</c> to test if the power control is
* indeed online at a given time. In case of ambiguity when looking for
* a dual power control by logical name, no error is notified: the first instance
* found is returned. The search is performed first by hardware name,
* then by logical name.
* </para>
* </summary>
* <param name="func">
* a string that uniquely characterizes the power control
* </param>
* <returns>
* a <c>YDualPower</c> object allowing you to drive the power control.
* </returns>
*/
public static YDualPower FindDualPower(string func)
{
YDualPower res;
if (_DualPowerCache.ContainsKey(func))
return (YDualPower)_DualPowerCache[func];
res = new YDualPower(func);
_DualPowerCache.Add(func, res);
return res;
}
// perform the initial setup that may be done without a YoctoAPI object (hwd can be null)
internal override void base_init(YFunction hwd, string instantiationName)
{
_func = (YDualPower)hwd;
base.base_init(hwd, instantiationName);
}
//--- (end of YDualPower definitions)
//--- (YDualPower implementation)
internal YDualPowerProxy(YDualPower hwd, string instantiationName) : base(hwd, instantiationName)
{
InternalStuff.log("DualPower " + instantiationName + " instantiation");
base_init(hwd, instantiationName);
}
/**
* <summary>
* Retrieves a dual power control for a given identifier.
* <para>
* The identifier can be specified using several formats:
* </para>
* <para>
* </para>
* <para>
* - FunctionLogicalName
* </para>
* <para>
* - ModuleSerialNumber.FunctionIdentifier
* </para>
* <para>
* - ModuleSerialNumber.FunctionLogicalName
* </para>
* <para>
* - ModuleLogicalName.FunctionIdentifier
* </para>
* <para>
* - ModuleLogicalName.FunctionLogicalName
* </para>
* <para>
* </para>
* <para>
* This function does not require that the power control is online at the time
* it is invoked. The returned object is nevertheless valid.
* Use the method <c>YDualPower.isOnline()</c> to test if the power control is
* indeed online at a given time. In case of ambiguity when looking for
* a dual power control by logical name, no error is notified: the first instance
* found is returned. The search is performed first by hardware name,
* then by logical name.
* </para>
* </summary>
* <param name="func">
* a string that uniquely characterizes the power control
* </param>
* <returns>
* a <c>YDualPower</c> object allowing you to drive the power control.
* </returns>
*/
public static YDualPower FindDualPower(string func)
{
YDualPower obj;
obj = (YDualPower) YFunction._FindFromCache("DualPower", func);
if (obj == null) {
obj = new YDualPower(func);
YFunction._AddToCache("DualPower", func, obj);
}
return obj;
}
