// link the instance to a real YoctoAPI object
internal override void linkToHardware(string hwdName)
{
YHubPort hwd = YHubPort.FindHubPort(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(YHubPort hwd)
{
if (hwd == null)
{
return;
}
base.init(hwd);
InternalStuff.log("registering HubPort callback");
_func.registerValueCallback(valueChangeCallback);
}
// --- (end of YHubPort implementation)
// --- (HubPort functions)
/**
* <summary>
* Retrieves a Yocto-hub port 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 Yocto-hub port is online at the time
* it is invoked. The returned object is nevertheless valid.
* Use the method <c>YHubPort.isOnline()</c> to test if the Yocto-hub port is
* indeed online at a given time. In case of ambiguity when looking for
* a Yocto-hub port 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 Yocto-hub port
* </param>
* <returns>
* a <c>YHubPort</c> object allowing you to drive the Yocto-hub port.
* </returns>
*/
public static YHubPort FindHubPort(string func)
{
YHubPort res;
if (_HubPortCache.ContainsKey(func))
{
return((YHubPort)_HubPortCache[func]);
}
res = new YHubPort(func);
_HubPortCache.Add(func, res);
return(res);
}
/**
* <summary>
* Retrieves a Yocto-hub port 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 Yocto-hub port is online at the time
* it is invoked. The returned object is nevertheless valid.
* Use the method <c>YHubPort.isOnline()</c> to test if the Yocto-hub port is
* indeed online at a given time. In case of ambiguity when looking for
* a Yocto-hub port 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 Yocto-hub port
* </param>
* <returns>
* a <c>YHubPort</c> object allowing you to drive the Yocto-hub port.
* </returns>
*/
public static YHubPort FindHubPort(string func)
{
YHubPort obj;
obj = (YHubPort)YFunction._FindFromCache("HubPort", func);
if (obj == null)
{
obj = new YHubPort(func);
YFunction._AddToCache("HubPort", func, obj);
}
return(obj);
}
public static YHubPortProxy FindHubPort(string name)
{
// cases to handle:
// name ="" no matching unknwn
// name ="" unknown exists
// name != "" no matching unknown
// name !="" unknown exists
YHubPort func = null;
YHubPortProxy res = (YHubPortProxy)YFunctionProxy.FindSimilarUnknownFunction("YHubPortProxy");
if (name == "")
{
if (res != null)
{
return(res);
}
res = (YHubPortProxy)YFunctionProxy.FindSimilarKnownFunction("YHubPortProxy");
if (res != null)
{
return(res);
}
func = YHubPort.FirstHubPort();
if (func != null)
{
name = func.get_hardwareId();
if (func.get_userData() != null)
{
return((YHubPortProxy)func.get_userData());
}
}
}
else
{
func = YHubPort.FindHubPort(name);
if (func.get_userData() != null)
{
return((YHubPortProxy)func.get_userData());
}
}
if (res == null)
{
res = new YHubPortProxy(func, name);
}
if (func != null)
{
res.linkToHardware(name);
if (func.isOnline())
{
res.arrival();
}
}
return(res);
}
/**
* <summary>
* Enumerates all functions of type HubPort 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>YHubPort.FindHubPort</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>();
YHubPort it = YHubPort.FirstHubPort();
while (it != null)
{
res.Add(it.get_hardwareId());
it = it.nextHubPort();
}
return(res.ToArray());
}
public bool addSubdevice(string serial)
{
for (int i = 1; i <= 4; i++)
{
YHubPort p = YHubPort.FindHubPort(this._serial + ".hubPort" + i.ToString());
if (p.get_logicalName() == serial)
{
_subdevices.Add(serial);
return(true);
}
}
return(false);
}
// --- (end of YHubPort implementation)
// --- (HubPort functions)
/**
* <summary>
* Retrieves a Yocto-hub port 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 Yocto-hub port is online at the time
* it is invoked. The returned object is nevertheless valid.
* Use the method <c>YHubPort.isOnline()</c> to test if the Yocto-hub port is
* indeed online at a given time. In case of ambiguity when looking for
* a Yocto-hub port 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 Yocto-hub port
* </param>
* <returns>
* a <c>YHubPort</c> object allowing you to drive the Yocto-hub port.
* </returns>
*/
public static YHubPort FindHubPort(string func)
{
YHubPort res;
if (_HubPortCache.ContainsKey(func))
return (YHubPort)_HubPortCache[func];
res = new YHubPort(func);
_HubPortCache.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 = (YHubPort)hwd;
base.base_init(hwd, instantiationName);
}
//--- (end of YHubPort definitions)
//--- (YHubPort implementation)
internal YHubPortProxy(YHubPort hwd, string instantiationName) : base(hwd, instantiationName)
{
InternalStuff.log("HubPort " + instantiationName + " instantiation");
base_init(hwd, instantiationName);
}
/**
* <summary>
* Retrieves a Yocto-hub port 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 Yocto-hub port is online at the time
* it is invoked. The returned object is nevertheless valid.
* Use the method <c>YHubPort.isOnline()</c> to test if the Yocto-hub port is
* indeed online at a given time. In case of ambiguity when looking for
* a Yocto-hub port 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 Yocto-hub port
* </param>
* <returns>
* a <c>YHubPort</c> object allowing you to drive the Yocto-hub port.
* </returns>
*/
public static YHubPort FindHubPort(string func)
{
YHubPort obj;
obj = (YHubPort) YFunction._FindFromCache("HubPort", func);
if (obj == null) {
obj = new YHubPort(func);
YFunction._AddToCache("HubPort", func, obj);
}
return obj;
}