BncsFramework Members

<< Click to Display Table of Contents >>

Navigation:  Reference > BNCS.Core.DriverFramework Namespace > BncsFramework Class >

BncsFramework Members

The BncsFramework type exposes the following members.

 

Methods


Name

Description

Public method Static member

AddDatabase

Adds a database for a specific device ID.

Public method Static member

AddDatabases

Adds all databases for a specific device ID.

Public method Static member

AddManagedDeviceAdhocInstance

Adds a managed device ad-hoc instance with the specified parameters.

Public method Static member

AddManagedDeviceAdhocParameterBoolean

Adds a managed device adhoc parameter of type boolean.

Public method Static member

AddManagedDeviceAdhocParameterEnum

Adds a managed device ad-hoc parameter of type Enum to a specified BNCS instance.

Public method Static member

AddManagedDeviceAdhocParameterRange

Adds a managed device ad-hoc parameter range to a specified instance.

Public method Static member

AddManagedDeviceAdhocParameterString

Adds a managed device ad-hoc parameter string to a specified BNCS instance.

Public method Static member

AddManagedDeviceInstance

Adds a managed device instance to the system, registers it, and optionally its parameters.

Public method Static member

AddManagedInfodriver

Adds a managed infodriver for a specified device.

Public method Static member

AddMonitoredDeviceInstance

Adds a monitored device instance to the collection of BNCS instances.

Public method Static member

AddMonitoredInfodriver

Adds a monitored infodriver for a specified device.

Public method Static member

AddNmosDevice

Adds a new NMOS device to the system.

Public method Static member

ConfigLogging

Configures logging using NLog library

Public method Static member

DeleteManagedDeviceAdhocParameter

Deletes an ad-hoc parameter from a managed device instance.

Public method Static member

GetBncsInstanceFromNmosDevice

Gets the BNCS instance from nmos device.

Public method Static member

GetDatabase

Retrieves the specified database for the given device ID.

Public method Static member

GetDatabaseValue

Retrieves the value from a specified index in a database for a given device.

Public method Static member

GetHub<T>

Fetches a types signalR hub from the host services, returns null if it doesn't exist.

Public method Static member

GetInfodriver

Retrieves the BNCS Infodriver for the specified device ID.

Public method Static member

GetInfodriversRedundancyState

Retrieves the redundancy state of all infodrivers.

Public method Static member

GetInfodriverValue

Retrieves the value of a specific index from the infodriver for a given device.

Public method Static member

GetInstanceFromBncsDeviceIdandIndex

Retrieves an IBNCSInstance based on the provided device ID and index.

Public method Static member

GetInstanceFromNmosDeviceGuid

Retrieves an IBNCSInstance based on the provided device GUID.

Public method Static member

GetInstanceParameter(Guid)

Retrieves the instance parameter with the specified unique identifier.

Public method Static member

GetInstanceParameter(String, String, Boolean)

Retrieves an instance parameter based on the specified instance ID and parameter name.

Public method Static member

GetManagedInfodriver

Retrieves a managed infodriver for the specified device ID.

Public method Static member

GetManagedParametersByName

Retrieves an array of IBNCSInstanceParameter objects with the specified parameter name.

Public method Static member

GetMonitoredInfodriver

Retrieves a monitored infodriver for the specified device ID.

Public method Static member

GetMonitoredParametersByName

Retrieves an array of IBNCSInstanceParameter objects with the specified parameter name.

Public method Static member

GetNmosDeviceFromBncsInstance

Obtain the NMOS Device derived from a given BNCS Instance Name.

Public method Static member

GetParamFromSource

Retrieves an IBNCSInstanceParameter from a source identified by a GUID.

Public method Static member

GetSourceIdFromInstanceParameterUid

Retrieves the source ID from the instance parameter UID.

Public method Static member

GetVersionInfo

Retrieves version information for assemblies in the current AppDomain.

Public method Static member

Init(DefaultOptions, String, String, String, String, String, String, Nullable<Assembly>, Nullable<String>[], String)

Initializes the BNCS Driver with the specified parameters.

Public method Static member

Init(String[], UInt32, UInt32, Boolean, String, String, String, String, String, String, String, Boolean, Boolean, Boolean, Boolean, Nullable<Assembly>, Nullable<String>[], String, Boolean, String, UInt32, Boolean)

Initializes the BNCS framework with the specified configuration parameters.

Public method Static member

NmosUpdate

Sends an updated NMOS Object to the registry.

Public method Static member

RegisterParameterCallback

Registers a parameter callback for the specified IBNCSInstanceParameter.

Public method Static member

SetActiveState

Sets the active state of the object and registers or deregisters based on the state change.

Public method Static member

SetDatabaseValue

Sets a value in the specified database for a given device.

Public method Static member

SetDeviceCommsState(Enums.DeviceCommsStates, Boolean)

Sets the communication state of a device and invokes an event when the state changes.

Public method Static member

SetDeviceCommsState(Enums.DeviceCommsStates, UInt32, Boolean)

Sets the communication state of a device and invokes an event when the state changes.

Public method Static member

SetInfodriversRedundancyState

Sets the redundancy state for all managed InfoDrivers.

Public method Static member

SetInfodriverValue

Sets the value of an infodriver for a specific device and index.

Public method Static member

SetParameterValue

Sets the value of a specified instance parameter and publishes a change notification.

Public method Static member

Shutdown

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

 

Properties


Name

Description

Public property Static member

Active

Gets a value indicating whether this BncsFramework is active.

Public property Static member

BncsClient

Gets or sets the IBNCSClient instance used for communication with the BncsClient.

Public property Static member

BncsCompatibilityVersion

Gets the BNCS compatibility version.

Public property Static member

BncsConnectionState

BNCS Connection State

Public property Static member

BNCSMainInstance

Gets or sets the MainInstance property.

Public property Static member

BNCSMainInstanceDeviceId

Gets or sets the MainInstance DeviceId property (zero if not set).

Public property Static member

ConnectApiAddress

Retrieve the IS-05 connect API URL.

Public property Static member

DeviceCommsState

Gets or sets the current state of device communications.

Public property Static member

DeviceCommsStats

Gets the device communication statistics.

Public property Static member

DriverName

Gets or sets the name of the driver.

Public property Static member

DriverState

Represents the current state of the BncsDriver.

Public property Static member

EventApiAddress

Retrieve the IS-07 event API URL.

Public property Static member

InstanceTag

Gets the instance tag.

Public property Static member

ManufacturerTag

Gets the manufacturer tag.

Public property Static member

NodeDescription

Gets the node description.

Public property Static member

NodeLabel

Gets the node label.

Public property Static member

ProductTag

Gets the product tag.

 

Events


Name

Description

Public event Static member

OnBncsConnect

Event that is raised each time BNCS connects.

Public event Static member

OnBncsDisconnect

Event that is raised each time BNCS disconnects connects.

Public event Static member

OnBncsInitComplete

Event that is raised the first time BNCS connects & initializes.

Public event Static member

OnDatabaseChange

Event that is raised when a change occurs in the BNCSDatabase.

Public event Static member

OnDeviceCommsStateChange

Event that is triggered when the device communication state changes.

Public event Static member

OnDriverStatusChange

Event that is raised when the driver status changes.

Public event Static member

OnManagedInfodriverChange

Event that is raised when a managed infodriver change occurs.

Public event Static member

OnManagedParameterChange

Event that is raised when a managed parameter changes.

Public event Static member

OnMonitoredInfodriverChange

Event that is raised when a monitored infodriver change occurs.

Public event Static member

OnMonitoredParameterChange

Event that is raised when a monitored parameter changes.

 

See Also


BncsFramework Class

BNCS.Core.DriverFramework Namespace