Index

basicSocket
componentProvider
componentServiceProvider
configureIdmListenerService
configureOdmListenerService
deserializeDeviceManagerRefs
deserializePort
deserializePorts
deserializeProperties
deserializeResourceRefs
deserializeWaveformSADRefs
deviceFactory
deviceFactory
deviceManagerFactory
deviceManagerProvider
deviceManagerServiceProvider
deviceProvider
deviceServiceProvider
domainFactory
domainProvider
domainServiceProvider
fileSystemServiceProvider
fromString
fromString
fromString
fromString
fromString
fromString
idmListenerServiceProvider
isIdmEvent
odmListenerServiceProvider
portServiceProvider
provideSystemBuilderConfig
redhawkServiceProvider
resolve
resolvePortDirection
resolvePortIDLNameSpace
resolvePortIDLType
serviceSelect
serviceSelect
serviceSelect
serviceSelect
serviceSelect
serviceSelect
serviceSelect
serviceSelect
subsystemMatches
waveformFactory
waveformProvider
waveformServiceProvider

src/sockets/base/basic-socket.ts

basicSocket

basicSocket(url: string, type?: typeReference)

This is a factory that returns websocket instances in the form of Subjects. The Subject subscribe and unsubscribe methods are bound to opening and closing the socket, respectively. When subscribing, map the output to the type you expect. Sometimes it's helpful to map this response into your own local subject or observable, behaving as the buffer abstraction for your design. Use next to send data back through the socket.

Parameters :

Name	Type	Optional	Description
url	`string`
type	`typeReference`	true

src/system-builder/providers/component.ts

componentProvider

componentProvider(token: any, waveform: any)

Returns a provider for a component mapped to the token and waveform provider specified.

Parameters :

Name	Type	Optional	Description
token	`any`		InjectionToken, string or class to represent this instance
waveform	`any`		The parent Waveform provider

deviceFactory

deviceFactory(http: typeReference, restPython: typeReference, waveform: typeReference)

Component(Service) Factory returns a new instance of the ComponentService.

Parameters :

Name	Type	Optional	Description
http	`typeReference`		The Http Service
restPython	`typeReference`		The RestPythonService
waveform	`typeReference`

src/component/component-service-provider.ts

componentServiceProvider

componentServiceProvider()

serviceSelect

serviceSelect(service: typeReference, http: typeReference, restPython: typeReference, waveform: typeReference)

This method instantiates a new instance for service if none is provided.

Parameters :

Name	Type	Optional	Description
service	`typeReference`		An existing instance of the service
http	`typeReference`		The HTTP service for server callbacks
restPython	`typeReference`		The REST Python service for URL serialization
waveform	`typeReference`

src/sockets/events/idm/idm-listener.service.ts

configureIdmListenerService

configureIdmListenerService(ecs: typeReference)

Provides an instantiation of the IDM Listener Service

Parameters :

Name	Type	Optional	Description
ecs	`typeReference`		An EventChannelService instance to utilize

idmListenerServiceProvider

idmListenerServiceProvider()

src/sockets/events/odm/odm-listener.service.ts

configureOdmListenerService

configureOdmListenerService(ecs: typeReference)

Provides an instantiation of the ODM Listener Service

Parameters :

Name	Type	Optional	Description
ecs	`typeReference`		An EventChannelService instance to utilize

odmListenerServiceProvider

odmListenerServiceProvider()

src/models/devicemanager/index.ts

deserializeDeviceManagerRefs

deserializeDeviceManagerRefs(inputs?: any)

Function for deserializing a list of device manager refs, typically used by the Domain.

Parameters :

Name	Type	Optional	Description
inputs	`any`	true

src/models/port/index.ts

deserializePort

deserializePort(input: any)

Deserializes a JSON object into a single port

Parameters :

Name	Type	Optional	Description
input	`any`		JSON Object representing a port

deserializePorts

deserializePorts(inputs?: any)

Deserializes a JSON object into a port listing.

Parameters :

Name	Type	Optional	Description
inputs	`any`	true

src/models/property/property-set.ts

deserializeProperties

deserializeProperties(inputs: any)

Helper method to deserialize JSON properties into a REDHAWK PropertySet.

Parameters :

Name	Type	Optional	Description
inputs	`any`		A JSON Object that is a PropertySet

src/models/resource/index.ts

deserializeResourceRefs

deserializeResourceRefs(inputs: any)

Utility function for deserializing a list of resource refs.

Parameters :

Name	Type	Optional	Description
inputs	`any`

src/models/waveform/waveform-sad-refs.ts

deserializeWaveformSADRefs

deserializeWaveformSADRefs(inputs?: any)

Helper function to convert a JSON object into a list of Waveform SAD refs

Parameters :

Name	Type	Optional	Description
inputs	`any`	true

src/system-builder/providers/device.ts

deviceFactory

deviceFactory(http: typeReference, restPython: typeReference, deviceManager: typeReference)

Device(Service) Factory returns a new instance of the DeviceService.

Parameters :

Name	Type	Optional	Description
http	`typeReference`		The Http Service
restPython	`typeReference`		The RestPythonService
deviceManager	`typeReference`

deviceProvider

deviceProvider(token: any, deviceManager: any)

Returns a provider for a device mapped to the token and device manager provider specified.

Parameters :

Name	Type	Optional	Description
token	`any`		InjectionToken, string or class to represent this instance
deviceManager	`any`		The parent DeviceManager provider

src/system-builder/providers/device-manager.ts

deviceManagerFactory

deviceManagerFactory(http: typeReference, restPython: typeReference, domain: typeReference)

DeviceManager(Service) Factory returns a new instance of the DeviceManagerService.

Parameters :

Name	Type	Optional	Description
http	`typeReference`		The Http Service
restPython	`typeReference`		The RestPythonService
domain	`typeReference`		The DomainService

deviceManagerProvider

deviceManagerProvider(token: any, domain: any)

Returns a provider for a device manager mapped to the token and domain provider specified.

Parameters :

Name	Type	Optional	Description
token	`any`		InjectionToken, string or class to represent this instance
domain	`any`		The parent Domain provider

src/devicemanager/device-manager-service-provider.ts

deviceManagerServiceProvider

deviceManagerServiceProvider()

serviceSelect

serviceSelect(service: typeReference, http: typeReference, restPython: typeReference, domain: typeReference)

This method instantiates a new instance for service if none is provided.

Parameters :

Name	Type	Optional	Description
service	`typeReference`		An existing instance of the service
http	`typeReference`		The HTTP service for server callbacks
restPython	`typeReference`		The REST Python service for URL serialization
domain	`typeReference`		The Domain service that has this DeviceManager in it

src/device/device-service-provider.ts

deviceServiceProvider

deviceServiceProvider()

serviceSelect

serviceSelect(service: typeReference, http: typeReference, restPython: typeReference, dm: typeReference)

This method instantiates a new instance for service if none is provided.

Parameters :

Name	Type	Optional	Description
service	`typeReference`		An existing instance of the service
http	`typeReference`		The HTTP service for server callbacks
restPython	`typeReference`		The REST Python service for URL serialization
dm	`typeReference`		The DeviceManager service that has this Device in it

src/system-builder/providers/domain.ts

domainFactory

domainFactory(http: typeReference, restPython: typeReference, redhawk: typeReference, odm: typeReference)

Domain(Service) Factory returns a new instance of the DomainService.

Parameters :

Name	Type	Optional	Description
http	`typeReference`		The Http Service
restPython	`typeReference`		The RestPythonService
redhawk	`typeReference`		The REDHAWK Service
odm	`typeReference`		The ODM Listener Service

domainProvider

domainProvider(token: any)

Returns a provider for a domain service mapped to the token specified.

Parameters :

Name	Type	Optional	Description
token	`any`		InjectionToken, string or class to represent this instance

src/domain/domain-service-provider.ts

domainServiceProvider

domainServiceProvider()

serviceSelect

serviceSelect(service: typeReference, http: typeReference, restPython: typeReference, rh: typeReference, odm: typeReference)

This method instantiates a new instance for service if none is provided.

Parameters :

Name	Type	Optional	Description
service	`typeReference`		An existing instance of the service
http	`typeReference`		The HTTP service for server callbacks
restPython	`typeReference`		The REST Python service for URL serialization
rh	`typeReference`		The REDHAWK service that has this Domain in it
odm	`typeReference`		The ODM Listener services for the ODM Event Channel

src/filesystem/file-system-service-provider.ts

fileSystemServiceProvider

fileSystemServiceProvider()

serviceSelect

serviceSelect(service: typeReference, http: typeReference, restPython: typeReference, domainService: typeReference)

This method instantiates a new instance for service if none is provided.

Parameters :

Name	Type	Optional	Description
service	`typeReference`		An existing instance of the service
http	`typeReference`		The HTTP service for server callbacks
restPython	`typeReference`		The REST Python service for URL serialization
domainService	`typeReference`		The Domain service that has this FileSystem in it

src/models/events/odm/resource-state-change-event.ts

fromString

fromString(state: string)

Parameters :

Name	Type	Optional	Description
state	`string`

src/models/events/idm/administrative-state-event.ts

fromString

fromString(category: string)

Internal helper function for converting to the enumeration value.

Parameters :

Name	Type	Optional	Description
category	`string`

src/models/events/odm/domain-management-object-removed-event.ts

fromString

fromString(category: string)

Parameters :

Name	Type	Optional	Description
category	`string`

src/models/events/idm/usage-state-event.ts

fromString

fromString(category: string)

Parameters :

Name	Type	Optional	Description
category	`string`

src/models/events/idm/operational-state-event.ts

fromString

fromString(category: string)

Parameters :

Name	Type	Optional	Description
category	`string`

src/models/events/idm/idm-event-deserialize.ts

fromString

fromString(category: string)

Helper function for converting StateChangeCategory to the enumeration

Parameters :

Name	Type	Optional	Description
category	`string`

src/models/events/idm/idm-event.ts

isIdmEvent

isIdmEvent(event: any)

Typeguard simply for interface parity between the ODM and IDM event interfaces. Yes, this is logically obvious at this time since all ODM events thus far in the API can inherit from OdmEvent.

Parameters :

Name	Type	Optional	Description
event	`any`

src/port/port-service-provider.ts

portServiceProvider

portServiceProvider()

serviceSelect

serviceSelect(service: typeReference, http: typeReference, restPython: typeReference, waveform: typeReference, device: typeReference, component: typeReference)

This method instantiates a new instance for service if none is provided.

Parameters :

Name	Type	Optional	Description
service	`typeReference`		An existing instance of the service
http	`typeReference`		The HTTP service for server callbacks
restPython	`typeReference`		The REST Python service for URL serialization
waveform	`typeReference`		The Waveform service that has this Port in it
device	`typeReference`		The Device service that has this Port in it
component	`typeReference`		The Component service that has this Port in it

src/system-builder/provide-system-builder-config.ts

provideSystemBuilderConfig

provideSystemBuilderConfig(config: typeReference)

Within the component or module where you will use the arSystemBuilder directive, use this function to build the set of providers for your subsystems.

Parameters :

Name	Type	Optional	Description
config	`typeReference`		The SystemBuilder configuration for your application.

src/redhawk/redhawk-service-provider.ts

redhawkServiceProvider

redhawkServiceProvider()

serviceSelect

serviceSelect(service: typeReference, http: typeReference, restPython: typeReference, rhls: typeReference)

Parameters :

Name	Type	Optional	Description
service	`typeReference`
http	`typeReference`
restPython	`typeReference`
rhls	`typeReference`

src/models/bulkio/bulkio-packet.ts

resolve

resolve(dataType: string)

Parameters :

Name	Type	Optional	Description
dataType	`string`

src/models/port/enums/port-direction.ts

resolvePortDirection

resolvePortDirection(val: string)

Convenience function for converting the string direction returned from the server to the enumeration.

Parameters :

Name	Type	Optional	Description
val	`string`		The string name of the port direction.

src/models/port/enums/port-idl-name-space.ts

resolvePortIDLNameSpace

resolvePortIDLNameSpace(val: string)

Function for converting a string name to the port IDL namespace enumeration.

Parameters :

Name	Type	Optional	Description
val	`string`		The value to resolve to the enumeration

src/models/port/enums/port-idl-types.ts

resolvePortIDLType

resolvePortIDLType(val: string)

Deserialization function for Port IDL types received from the server.

End users should not need this method as it's used by PortIDL to ensure the resulting enumeration maps to one of the above enumerations.

Parameters :

Name	Type	Optional	Description
val	`string`

src/waveform/waveform-service-provider.ts

serviceSelect

serviceSelect(service: typeReference, http: typeReference, restPython: typeReference, domain: typeReference)

This method instantiates a new instance for service if none is provided.

Parameters :

Name	Type	Optional	Description
service	`typeReference`		An existing instance of the service
http	`typeReference`		The HTTP service for server callbacks
restPython	`typeReference`		The REST Python service for URL serialization
domain	`typeReference`

waveformServiceProvider

waveformServiceProvider()

src/system-builder/system-builder.directive.ts

subsystemMatches

subsystemMatches(id: string, name: string, subsys: typeReference)

Checks the subsystem config to see if the ID and name are considered a match.

Parameters :

Name	Type	Optional	Description
id	`string`		ID to test against
name	`string`		Name to test against
subsys	`typeReference`		Subsystem configuration to check

src/system-builder/providers/waveform.ts

waveformFactory

waveformFactory(http: typeReference, restPython: typeReference, domain: typeReference)

DeviceManager(Service) Factory returns a new instance of the DeviceManagerService.

Parameters :

Name	Type	Optional	Description
http	`typeReference`		The Http Service
restPython	`typeReference`		The RestPythonService
domain	`typeReference`		The DomainService

waveformProvider

waveformProvider(token: any, domain: any)

Returns a provider for a waveform mapped to the token and domain provider specified.

Parameters :

Name	Type	Optional	Description
token	`any`		InjectionToken, string or class to represent this instance
domain	`any`		The parent Domain provider

Index

src/sockets/base/basic-socket.ts

src/system-builder/providers/component.ts

src/component/component-service-provider.ts

src/sockets/events/idm/idm-listener.service.ts

src/sockets/events/odm/odm-listener.service.ts

src/models/devicemanager/index.ts

src/models/port/index.ts

src/models/property/property-set.ts

src/models/resource/index.ts

src/models/waveform/waveform-sad-refs.ts

src/system-builder/providers/device.ts

src/system-builder/providers/device-manager.ts

src/devicemanager/device-manager-service-provider.ts

src/device/device-service-provider.ts

src/system-builder/providers/domain.ts

src/domain/domain-service-provider.ts

src/filesystem/file-system-service-provider.ts

src/models/events/odm/resource-state-change-event.ts

src/models/events/idm/administrative-state-event.ts

src/models/events/odm/domain-management-object-removed-event.ts

src/models/events/idm/usage-state-event.ts

src/models/events/idm/operational-state-event.ts

src/models/events/idm/idm-event-deserialize.ts

src/models/events/idm/idm-event.ts

src/port/port-service-provider.ts

src/system-builder/provide-system-builder-config.ts

src/redhawk/redhawk-service-provider.ts

src/models/bulkio/bulkio-packet.ts

src/models/port/enums/port-direction.ts

src/models/port/enums/port-idl-name-space.ts

src/models/port/enums/port-idl-types.ts

src/waveform/waveform-service-provider.ts

src/system-builder/system-builder.directive.ts

src/system-builder/providers/waveform.ts

results matching ""

No results matching ""