The manager class for Block related stuff. More...

Collaboration diagram for Seci.Managers.BlockMgr:

Public Member Functions
delegate void	EnableLoggingChangedEventHandler (Boolean enabled)

Static Public Member Functions
static bool	BlockGroupExists (string name)

static List< String >	GetAllBlockValues (Boolean visibleOnly, Boolean includeSetpoint, Boolean includeGroup, Boolean includeWaitState)
	Get all the current block values, including any in the components. Format of String is "blockname: value units". More...

static BlockDictionary	GetBlocksClone ()
	Creates a new BlockDictionary containing all the blocks, including any which are in a component. More...

static String	GetBlockSetpoint (String block)
	Gets the set-point value of a specified block in the configuration or its components. More...

static String	GetBlockValue (String blockname)
	Gets the value of a specified block in the configuration or its components. More...

static String	GetFormattedBlockValue (String blockname, Boolean includeSetpoint, Boolean includeGroup, Boolean includeWaiting)
	Gets a formatted string of form "BlockName: value units". More...

static void	ReorderBlockGroups (List< string > neworder)

static Boolean	SetBlockRunControl (String blockname, Boolean enabled, Double low, Double high)
	Sets the run-control limits for a block, includes any blocks in components. This is the recommended method for changing all the run-control settings. More...

static void	SetBlocks (BlockDictionary blocks)
	This method set the blocks in SECI after they have been created or modified More...

static Boolean	ToggleRunContol (String blockname, Boolean enabled)
	Toggle whether run-control is enabled - uses limits set previously. More...

Properties
static BlockDictionary	Blocks `[get]`

static SerialisableList < BlockGroup >	Groups `[get, set]`

static Boolean	LogValuesEnabled `[get, set]`

Events
static EnableLoggingChangedEventHandler	OnEnableLoggingUpdated

Static Private Attributes
static BlockDictionary	_blocks = new BlockDictionary()
	The BlockDictionary that stores the block information. More...

static SerialisableList < Definitions.BlockGroup >	_groups = new SerialisableList<Definitions.BlockGroup>()

static Boolean	_logValuesEnabled = true

static DateTime	_timeWentOutOfRange = new DateTime()

Detailed Description

The manager class for Block related stuff.

Definition at line 11 of file BlockMgr.cs.

Member Function Documentation

static bool Seci.Managers.BlockMgr.BlockGroupExists ( string name )

inlinestatic

Definition at line 181 of file BlockMgr.cs.

Referenced by Seci.Managers.ComponentMgr.AddComponent().

delegate void Seci.Managers.BlockMgr.EnableLoggingChangedEventHandler ( Boolean enabled )

static List<String> Seci.Managers.BlockMgr.GetAllBlockValues	(	Boolean	visibleOnly,
		Boolean	includeSetpoint,
		Boolean	includeGroup,
		Boolean	includeWaitState
	)

inlinestatic

Get all the current block values, including any in the components. Format of String is "blockname: value units".

Parameters

visibleOnly	Whether to include only the blocks set to visible
includeSetpoint	Whether to add the setpoint to the string
includeGroup	Whether to include the group
includeWaitState	Whether to include the waiting state

Returns: String list containing the current values

Definition at line 92 of file BlockMgr.cs.

static BlockDictionary Seci.Managers.BlockMgr.GetBlocksClone ( )

inlinestatic

Creates a new BlockDictionary containing all the blocks, including any which are in a component.

Returns: A copy of the BlockDictionary

Definition at line 59 of file BlockMgr.cs.

References Seci.BlockDictionary.Clone().

Here is the call graph for this function:

static String Seci.Managers.BlockMgr.GetBlockSetpoint ( String block )

inlinestatic

Gets the set-point value of a specified block in the configuration or its components.

Parameters

block The name of the block

Returns: String setpoint value, no units

Definition at line 139 of file BlockMgr.cs.

static String Seci.Managers.BlockMgr.GetBlockValue ( String blockname )

inlinestatic

Gets the value of a specified block in the configuration or its components.

Parameters

blockname The name of the block

Returns: String value, no units

Definition at line 116 of file BlockMgr.cs.

static String Seci.Managers.BlockMgr.GetFormattedBlockValue	(	String	blockname,
		Boolean	includeSetpoint,
		Boolean	includeGroup,
		Boolean	includeWaiting
	)

inlinestatic

Gets a formatted string of form "BlockName: value units".

Parameters

blockname	The name of the block
includeSetpoint	Whether to add the setpoint to the string
includeGroup	Whether to include the group
includeWaiting	Whether to include the waiting state

Returns: Formatted string

Definition at line 129 of file BlockMgr.cs.

static void Seci.Managers.BlockMgr.ReorderBlockGroups ( List< string > neworder )

inlinestatic

Definition at line 194 of file BlockMgr.cs.

static Boolean Seci.Managers.BlockMgr.SetBlockRunControl	(	String	blockname,
		Boolean	enabled,
		Double	low,
		Double	high
	)

inlinestatic

Sets the run-control limits for a block, includes any blocks in components. This is the recommended method for changing all the run-control settings.

Parameters

blockname	The name of the block
enabled	Whether to enable run-control
low	The lower limit for run-control
high	The upper limit for run-control

Returns: Result

Definition at line 153 of file BlockMgr.cs.

static void Seci.Managers.BlockMgr.SetBlocks ( BlockDictionary blocks )

inlinestatic

This method set the blocks in SECI after they have been created or modified

Parameters

blocks The blocks to replace the existing set

Definition at line 45 of file BlockMgr.cs.

static Boolean Seci.Managers.BlockMgr.ToggleRunContol	(	String	blockname,
		Boolean	enabled
	)

inlinestatic

Toggle whether run-control is enabled - uses limits set previously.

Parameters

blockname	The name of the block
enabled	Whether to enable run-control

Returns: Result

Definition at line 170 of file BlockMgr.cs.

Member Data Documentation

BlockDictionary Seci.Managers.BlockMgr._blocks = new BlockDictionary()

staticprivate

The BlockDictionary that stores the block information.

Definition at line 16 of file BlockMgr.cs.

SerialisableList<Definitions.BlockGroup> Seci.Managers.BlockMgr._groups = new SerialisableList<Definitions.BlockGroup>()

staticprivate

Definition at line 17 of file BlockMgr.cs.

Boolean Seci.Managers.BlockMgr._logValuesEnabled = true

staticprivate

Definition at line 19 of file BlockMgr.cs.

DateTime Seci.Managers.BlockMgr._timeWentOutOfRange = new DateTime()

staticprivate

Definition at line 18 of file BlockMgr.cs.

Property Documentation

BlockDictionary Seci.Managers.BlockMgr.Blocks

staticget

Definition at line 21 of file BlockMgr.cs.

Referenced by Seci.Managers.AlertsMgr.GetAlertsCopyForSaving(), Seci.Managers.ConfigurationMgr.openConfig(), and Seci.Managers.ComponentMgr.RemoveComponent().

SerialisableList<BlockGroup> Seci.Managers.BlockMgr.Groups

staticgetset

Definition at line 22 of file BlockMgr.cs.

Boolean Seci.Managers.BlockMgr.LogValuesEnabled

staticgetset

Definition at line 27 of file BlockMgr.cs.

Event Documentation

EnableLoggingChangedEventHandler Seci.Managers.BlockMgr.OnEnableLoggingUpdated

static

Definition at line 25 of file BlockMgr.cs.

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

/isis2/instcontrol_temp/NewSECI/Sample_Environment_Control_Interface/Seci/Managers/BlockMgr.cs

Public Member Functions

Static Public Member Functions

Properties

Events

Static Private Attributes

Detailed Description

Member Function Documentation

Member Data Documentation

Property Documentation

Event Documentation