Apac.Configuration.FormulaInputDescriptor Class Reference

This construct describes a single input to a measurment formula. More...

Inheritance diagram for Apac.Configuration.FormulaInputDescriptor:

Public Member Functions
	FormulaInputDescriptor (string name, string description, Type unitsType, uint minOccurs, uint maxOccurs)
	Initializes a new instance of the FormulaInputDescriptor class. More...
void	GetObjectData (SerializationInfo info, StreamingContext context)
	Populates a T:System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object. More...

Protected Member Functions
	FormulaInputDescriptor (SerializationInfo info, StreamingContext context)
	Initializes a new instance of the FormulaInputDescriptor class. More...

Properties
string	Name [get]
	Gets the name. More...
string	Description [get]
	Gets the description. More...
Type	UnitsType [get]
	Gets the type of the units. More...
uint	MinOccurs [get]
	Gets the minimum number of occurrances required as inputs. More...
uint	MaxOccurs [get]
	Gets the maximum number of occurrances required as inputs. A value less than MinOccurs indicates no upper limit. More...
bool	IsOptional [get]
	Gets a value indicating whether this instance is optional, which is determined based on MinOccurs being less than 1. More...
Monitoring.MeasurementUnit	Units [get]
	Gets the units designated by UnitsType. More...

Detailed Description

This construct describes a single input to a measurment formula.

Constructor & Destructor Documentation

FormulaInputDescriptor() [1/2]

Apac.Configuration.FormulaInputDescriptor.FormulaInputDescriptor ( SerializationInfo  info, StreamingContext  context  )

inlineprotected

Initializes a new instance of the FormulaInputDescriptor class.

Parameters

info	The info.
context	The context.

FormulaInputDescriptor() [2/2]

Apac.Configuration.FormulaInputDescriptor.FormulaInputDescriptor ( string  name, string  description, Type  unitsType, uint  minOccurs, uint  maxOccurs  )

inline

Initializes a new instance of the FormulaInputDescriptor class.

Parameters

name	The name.
description	The description.
unitsType	The of units.
minOccurs	The min occurs.
maxOccurs	The max occurs.

Member Function Documentation

GetObjectData()

void Apac.Configuration.FormulaInputDescriptor.GetObjectData ( SerializationInfo  info, StreamingContext  context  )

inline

Populates a T:System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.

Parameters

info	The T:System.Runtime.Serialization.SerializationInfo to populate with data.
context	The destination (see T:System.Runtime.Serialization.StreamingContext) for this serialization.

Exceptions

T:System.Security.SecurityException

The caller does not have the required permission.

Property Documentation

Description

string Apac.Configuration.FormulaInputDescriptor.Description

get

Gets the description.

IsOptional

bool Apac.Configuration.FormulaInputDescriptor.IsOptional

get

Gets a value indicating whether this instance is optional, which is determined based on MinOccurs being less than 1.

true if this instance is optional; otherwise, false.

MaxOccurs

uint Apac.Configuration.FormulaInputDescriptor.MaxOccurs

get

Gets the maximum number of occurrances required as inputs. A value less than MinOccurs indicates no upper limit.

MinOccurs

uint Apac.Configuration.FormulaInputDescriptor.MinOccurs

get

Gets the minimum number of occurrances required as inputs.

Name

string Apac.Configuration.FormulaInputDescriptor.Name

get

Gets the name.

Units

Monitoring.MeasurementUnit Apac.Configuration.FormulaInputDescriptor.Units

get

Gets the units designated by UnitsType.

UnitsType

Type Apac.Configuration.FormulaInputDescriptor.UnitsType

get

Gets the type of the units.

---

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

• /var/lib/jenkins/workspace/apac/APAC/APACCore/Configuration/FormulaInputDescriptor.cs