Asset Strip Config interface. More...

import"AssetStripConfig.idl";

Classes
struct	LEDColor
	The LED color in RGB format, 8 bit per channel. More...

struct	RackUnitSettings
	Settings for a single rack unit (LED state) More...

struct	StripSettings
	Settings for this Asset Strip. More...

Public Types
enum	ScanMode { SCANMODE_DISABLED, SCANMODE_BOTH }
	AssetStripConfig scan mode is active More...

enum	NumberingMode { TOP_DOWN, BOTTOM_UP }
	AssetStripConfig rack unit numbering mode More...

enum	Orientation { TOP_CONNECTOR, BOTTOM_CONNECTOR }
	AssetStripConfig orientation More...

enum	LEDOperationMode { LED_OPERATION_MANUAL, LED_OPERATION_AUTO }
	Operation mode for the LED of a single rack unit. More...

enum	LEDMode { LED_MODE_ON, LED_MODE_OFF, LED_MODE_BLINK_FAST, LED_MODE_BLINK_SLOW }
	Mode for the LED of a single rack unit. More...

Public Member Functions
StripSettings	getStripSettings ()
	Get the asset strip settings which are not rack unit specific. More...

int	setStripSettings (in StripSettings settings)
	Set the asset strip settings which are not rack unit specific. More...

int	getRackUnitSettings (in int rackUnitNumber, out RackUnitSettings settings)
	Get settings of a rack unit at once. More...

vector< RackUnitSettings >	getAllRackUnitSettings ()
	Get settings for all rack units. More...

int	setRackUnitSettings (in int rackUnitNumber, in RackUnitSettings settings)
	Set all settings of the specified rack unit at once. More...

int	setMultipleRackUnitSettings (in map< int, RackUnitSettings > settings)
	Set all settings of multiple rack units at once. More...

Public Attributes
valueobject	StripSettingsChangedEvent: event::UserEvent { StripSettings oldSettings
	Event: Asset strip settings were changed. More...

StripSettings	newSettings
	Settings after change.

valueobject	RackUnitSettingsChangedEvent: event::UserEvent { int rackUnitNumber
	Event: A rack unit's settings were changed. More...

RackUnitSettings	oldSettings
	Settings before change.

RackUnitSettings	newSettings
	Settings after change.

Detailed Description

Asset Strip Config interface.

Member Enumeration Documentation

enum assetmgrmodel::AssetStripConfig_1_0_1::LEDMode

Mode for the LED of a single rack unit.

Enumerator
LED_MODE_ON	LED on.
LED_MODE_OFF	LED off.
LED_MODE_BLINK_FAST	LED is blinking (fast)
LED_MODE_BLINK_SLOW	LED is blinking (slow)

enum assetmgrmodel::AssetStripConfig_1_0_1::LEDOperationMode

Operation mode for the LED of a single rack unit.

The LED may either be manually controlled or its color may be chosen automatically depending on whether an asset tag is connected or not. In automatic mode the LED is always on.

Enumerator
LED_OPERATION_MANUAL	LED color and mode is manually controlled.
LED_OPERATION_AUTO	LED color controlled automatically, LED always on.

enum assetmgrmodel::AssetStripConfig_1_0_1::NumberingMode

AssetStripConfig rack unit numbering mode

Indicates the way the rack unit numbers are defined. Basically this determines what number are 'written/printed' at a specific rack unit on the rack.

An additional numberingOffset may be specified in the settings if the numbering does not start at the default 1.

Enumerator
TOP_DOWN	numbering goes from top to bottom, top is the smallest number
BOTTOM_UP	numbering goes from bottom to top, bottom is the smallest number

enum assetmgrmodel::AssetStripConfig_1_0_1::Orientation

AssetStripConfig orientation

The asset strip may be mounted in a rack a) with its cable connector on top, growing top->bottom b) with its cable connector on bottom, growing bottom->top

This enumeration indicates the mounting option. It is detected automatically and writes to the setting are ignored.

Enumerator
TOP_CONNECTOR	cable connector on top, strip growing top->bottom
BOTTOM_CONNECTOR	cable connector on top, strip growing bottom->top

enum assetmgrmodel::AssetStripConfig_1_0_1::ScanMode

AssetStripConfig scan mode is active

This is a demonstration feature providing a 'running lights' kind of effect where not all LEDs are lit statically (depending on their mode) but only a few LED which change all the time.

Enumerator
SCANMODE_DISABLED	LED scanmode is disabled, all LEDs are lit up statically.
SCANMODE_BOTH	LED scanmode is enabled providing a 'running light' effect.

Member Function Documentation

vector<RackUnitSettings> assetmgrmodel::AssetStripConfig_1_0_1::getAllRackUnitSettings ( )

Get settings for all rack units.

Returns: Result: the rack unit settings

int assetmgrmodel::AssetStripConfig_1_0_1::getRackUnitSettings	(	in int	rackUnitNumber,
		out RackUnitSettings	settings
	)

Get settings of a rack unit at once.

Parameters

rackUnitNumber	rack unit to get the settings for, range 0..rackUnitCount-1
settings	settings for this rack unit

Returns: NO_ERROR on success; ERR_INVALID_PARAM rack unit count exceeded

StripSettings assetmgrmodel::AssetStripConfig_1_0_1::getStripSettings ( )

Get the asset strip settings which are not rack unit specific.

Returns: settings settings for this asset strip

int assetmgrmodel::AssetStripConfig_1_0_1::setMultipleRackUnitSettings ( in map< int, RackUnitSettings > settings )

Set all settings of multiple rack units at once.

Parameters

settings map of rack units and their settings

Returns: NO_ERROR on success; ERR_INVALID_PARAM one or more of the settings is invalid (rack unit count exceeded or color/mode not supported, rack unit count and setting count differ...)

int assetmgrmodel::AssetStripConfig_1_0_1::setRackUnitSettings	(	in int	rackUnitNumber,
		in RackUnitSettings	settings
	)

Set all settings of the specified rack unit at once.

The addressed rack unit is part of the parameter

Parameters

rackUnitNumber	rack unit to set the settings for, range 0..rackUnitCount-1
settings	settings for this rack unit

Returns: NO_ERROR on success; ERR_INVALID_PARAM one or more of the settings is invalid

int assetmgrmodel::AssetStripConfig_1_0_1::setStripSettings ( in StripSettings settings )

Set the asset strip settings which are not rack unit specific.

Parameters

settings Settings for this asset strip

Returns: NO_ERROR on success; ERR_INVALID_PARAM one or more of the settings is invalid

Member Data Documentation

valueobject assetmgrmodel::AssetStripConfig_1_0_1::RackUnitSettingsChangedEvent

Event: A rack unit's settings were changed.

Affected rack unit position

valueobject assetmgrmodel::AssetStripConfig_1_0_1::StripSettingsChangedEvent

Event: Asset strip settings were changed.

Settings before change

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

pdu-json-rpc-api/idl/AssetStripConfig.idl

Classes

Public Types

Public Member Functions

Public Attributes

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Member Data Documentation