Public Member Functions

OpenGroup::arm40::Provisional::metric::IArmMetricFactory Interface Reference
[ARM 4.0 Metrics, ARM 4.0 Factories]

Provides methods to create instances of the classes in the OpenGroup.arm40.Provisional.metric package. More...

Inheritance diagram for OpenGroup::arm40::Provisional::metric::IArmMetricFactory:
OpenGroup::arm40::Provisional::transaction::IArmInterface

List of all members.

Public Member Functions

IArmMetricCounter32Definition newArmMetricCounter32Definition (IArmApplicationDefinition app, string name, string units, short usage, IArmID id)
 Creates a new metadata instance.
IArmMetricCounter64Definition newArmMetricCounter64Definition (IArmApplicationDefinition app, string name, string units, short usage, IArmID id)
 Creates a new metadata instance.
IArmMetricCounterFloat32Definition newArmMetricCounterFloat32Definition (IArmApplicationDefinition app, string name, string units, short usage, IArmID id)
 Creates a new metadata instance.
IArmMetricGauge32Definition newArmMetricGauge32Definition (IArmApplicationDefinition appDef, string name, string units, short usage, IArmID id)
 Creates a new metadata instance.
IArmMetricGauge64Definition newArmMetricGauge64Definition (IArmApplicationDefinition app, string name, string units, short usage, IArmID id)
 Creates a new metadata instance.
IArmMetricGaugeFloat32Definition newArmMetricGaugeFloat32Definition (IArmApplicationDefinition app, string name, string units, short usage, IArmID id)
 Creates a new metadata instance.
IArmMetricNumericId32Definition newArmMetricNumericId32Definition (IArmApplicationDefinition app, string name, string units, short usage, IArmID id)
 Creates a new metadata instance.
IArmMetricNumericId64Definition newArmMetricNumericId64Definition (IArmApplicationDefinition app, string name, string units, short usage, IArmID id)
 Creates a new metadata instance.
IArmMetricString32Definition newArmMetricString32Definition (IArmApplicationDefinition app, string name, string units, short usage, IArmID id)
 Creates a new metadata instance.
IArmMetricGroupDefinition newArmMetricGroupDefinition (IArmMetricDefinition[] definitions)
 Creates an ordered set of IArmMetricDefinition subclasses ready for binding to transaction definition objects.
IArmTransactionWithMetricsDefinition newArmTransactionWithMetricsDefinition (IArmApplicationDefinition app, string name, IArmIdentityPropertiesTransaction identityProperties, IArmMetricGroupDefinition definition, IArmID id)
 Creates an object that contains the metadata about a transaction.
IArmMetricCounter32 newArmMetricCounter32 (IArmMetricCounter32Definition definition)
 Creates a new metric instance.
IArmMetricCounter64 newArmMetricCounter64 (IArmMetricCounter64Definition definition)
 Creates a new metric instance.
IArmMetricCounterFloat32 newArmMetricCounterFloat32 (IArmMetricCounterFloat32Definition definition)
 Creates a new metric instance.
IArmMetricGauge32 newArmMetricGauge32 (IArmMetricGauge32Definition definition)
 Creates a new metric instance.
IArmMetricGauge64 newArmMetricGauge64 (IArmMetricGauge64Definition definition)
 Creates a new metric instance.
IArmMetricGaugeFloat32 newArmMetricGaugeFloat32 (IArmMetricGaugeFloat32Definition definition)
 Creates a new metric instance.
IArmMetricNumericId32 newArmMetricNumericId32 (IArmMetricNumericId32Definition definition)
 Creates a new metric instance.
IArmMetricNumericId64 newArmMetricNumericId64 (IArmMetricNumericId64Definition definition)
 Creates a new metric instance.
IArmMetricString32 newArmMetricString32 (IArmMetricString32Definition definition)
 Creates a new metric instance.
IArmMetricGroup newArmMetricGroup (IArmMetricGroupDefinition groupDefinition, IArmMetric[] metrics)
 --- other instances ---
IArmTranReportWithMetrics newArmTranReportWithMetrics (IArmApplication app, IArmTransactionWithMetricsDefinition definition, IArmMetricGroup group)
 Creates an object that represents an instance of a transaction with an IArmTranReport interface.
IArmTransactionWithMetrics newArmTransactionWithMetrics (IArmApplication app, IArmTransactionWithMetricsDefinition definition, IArmMetricGroup group)
 Creates an object that represents an instance of a transaction.
bool SetErrorCallback (IArmErrorCallback errorCallback)
 Registers an error callback for objects created through this factory.

Detailed Description

An error callback method can be registered for objects created with this factory (see SetErrorCallback(IArmErrorCallback) For additional details about error handling philosophy see the description in OpenGroup.arm40.Provisional.transaction.IArmTransactionFactory

Semantics of the factory methods are provided in the description of the individual methods below.

IArmMetricFactory is instantiated using a class loader. The actual name of the factory implementation class is obtained from the system property whose name is provided in the IArmMetricFactoryConstants.propertyKey constant.

Member Function Documentation

IArmMetricCounter32 OpenGroup::arm40::Provisional::metric::IArmMetricFactory::newArmMetricCounter32 ( IArmMetricCounter32Definition  definition  ) 
Parameters:
definition the metadata describing this metric.
Returns:
a new metric instance.
IArmMetricCounter32Definition OpenGroup::arm40::Provisional::metric::IArmMetricFactory::newArmMetricCounter32Definition ( IArmApplicationDefinition  app,
string  name,
string  units,
short  usage,
IArmID  id 
)
Parameters:
app metadata about the containing application.
name name for this definition.
units units descrioption, or null.
usage One of IArmMetricDefinitionConstants.METRIC_USE_GENERAL IArmMetricDefinitionConstants.METRIC_USE_TRAN_SIZE IArmMetricDefinitionConstants.METRIC_USE_TRAN_STATUS or an application-specific negative value.
id ID provided by the application for this metric definition, or null.
Returns:
a new metadata instance for this definition.

IArmMetricDefinition

IArmMetricCounter64 OpenGroup::arm40::Provisional::metric::IArmMetricFactory::newArmMetricCounter64 ( IArmMetricCounter64Definition  definition  ) 
Parameters:
definition the metadata describing this metric.
Returns:
a new metric instance.
IArmMetricCounter64Definition OpenGroup::arm40::Provisional::metric::IArmMetricFactory::newArmMetricCounter64Definition ( IArmApplicationDefinition  app,
string  name,
string  units,
short  usage,
IArmID  id 
)
Parameters:
app metadata about the containing application.
name name for this definition.
units units description, or null.
usage One of IArmMetricDefinitionConstants.METRIC_USE_GENERAL IArmMetricDefinitionConstants.METRIC_USE_TRAN_SIZE IArmMetricDefinitionConstants.METRIC_USE_TRAN_STATUS or an application-specific negative value.
id ID provided by the application for this metric definition, or null.
Returns:
a new metadata instance for this definition.
IArmMetricCounterFloat32 OpenGroup::arm40::Provisional::metric::IArmMetricFactory::newArmMetricCounterFloat32 ( IArmMetricCounterFloat32Definition  definition  ) 
Parameters:
definition the metadata describing this metric.
Returns:
a new metric instance.
IArmMetricCounterFloat32Definition OpenGroup::arm40::Provisional::metric::IArmMetricFactory::newArmMetricCounterFloat32Definition ( IArmApplicationDefinition  app,
string  name,
string  units,
short  usage,
IArmID  id 
)
Parameters:
app metadata about the containing application.
name name for this definition.
units units descrioption, or null.
usage One of IArmMetricDefinitionConstants.METRIC_USE_GENERAL IArmMetricDefinitionConstants.METRIC_USE_TRAN_SIZE IArmMetricDefinitionConstants.METRIC_USE_TRAN_STATUS or an application-specific negative value.
id ID provided by the application for this metric definition, or null.
Returns:
a new metadata instance for this definition.
IArmMetricGauge32 OpenGroup::arm40::Provisional::metric::IArmMetricFactory::newArmMetricGauge32 ( IArmMetricGauge32Definition  definition  ) 
Parameters:
definition the metadata describing this metric.
Returns:
a new metric instance.
IArmMetricGauge32Definition OpenGroup::arm40::Provisional::metric::IArmMetricFactory::newArmMetricGauge32Definition ( IArmApplicationDefinition  appDef,
string  name,
string  units,
short  usage,
IArmID  id 
)
Parameters:
appDef metadata about the containing application.
name name for this definition.
units units description, or null.
usage One of IArmMetricDefinitionConstants.METRIC_USE_GENERAL IArmMetricDefinitionConstants.METRIC_USE_TRAN_SIZE IArmMetricDefinitionConstants.METRIC_USE_TRAN_STATUS or an application-specific negative value.
id ID provided by the application for this metric definition, or null.
Returns:
a new metadata instance for this definition.
IArmMetricGauge64 OpenGroup::arm40::Provisional::metric::IArmMetricFactory::newArmMetricGauge64 ( IArmMetricGauge64Definition  definition  ) 
Parameters:
definition the metadata describing this metric.
Returns:
a new metric instance.
IArmMetricGauge64Definition OpenGroup::arm40::Provisional::metric::IArmMetricFactory::newArmMetricGauge64Definition ( IArmApplicationDefinition  app,
string  name,
string  units,
short  usage,
IArmID  id 
)
Parameters:
app metadata about the containing application.
name name for this definition.
units units descrioption, or null.
usage One of IArmMetricDefinitionConstants.METRIC_USE_GENERAL IArmMetricDefinitionConstants.METRIC_USE_TRAN_SIZE IArmMetricDefinitionConstants.METRIC_USE_TRAN_STATUS or an application-specific negative value.
id ID provided by the application for this metric definition, or null.
Returns:
a new metadata instance for this definition.
IArmMetricGaugeFloat32 OpenGroup::arm40::Provisional::metric::IArmMetricFactory::newArmMetricGaugeFloat32 ( IArmMetricGaugeFloat32Definition  definition  ) 
Parameters:
definition the metadata describing this metric.
Returns:
a new metric instance.
IArmMetricGaugeFloat32Definition OpenGroup::arm40::Provisional::metric::IArmMetricFactory::newArmMetricGaugeFloat32Definition ( IArmApplicationDefinition  app,
string  name,
string  units,
short  usage,
IArmID  id 
)
Parameters:
app metadata about the containing application.
name name for this definition.
units units descrioption, or null.
usage One of IArmMetricDefinitionConstants.METRIC_USE_GENERAL IArmMetricDefinitionConstants.METRIC_USE_TRAN_SIZE IArmMetricDefinitionConstants.METRIC_USE_TRAN_STATUS or an application-specific negative value.
id ID provided by the application for this metric definition, or null.
Returns:
a new metadata instance for this definition.
IArmMetricGroup OpenGroup::arm40::Provisional::metric::IArmMetricFactory::newArmMetricGroup ( IArmMetricGroupDefinition  groupDefinition,
IArmMetric[]  metrics 
)

Creates an ordered set of IArmMetric subclasses ready for binding to transaction objects.

Parameters:
groupDefinition metadata object describing the metrics provided through the metrics parameter.
metrics an array of IArmMetric objects.

The ordering in the array is important. The array can have up to seven elements and is position-sensitive. To remain consistent with ARM 2.0, any IArmMetric subclass except IArmMetricString32 can be assigned to elements 0:5 and only IArmMetricString32 can be assigned to element 6. The IArmMetricDefinition objects associated with each IArmMetric object must have the exact same values as the IArmMetricDefinition objects associated with the IArmMetricGroupDefinition object (they will often be the same objects, though this is not mandatory).

Any element can be null. If the input array has fewer than seven elements, the rest of the elements are assigned a value of null. The array can be sparsely populated. For example, there can be a non-null IArmMetric reference in element 0 and 6, and null references in elements 1:5.

Returns:
a new metric group instance.
IArmMetricGroupDefinition OpenGroup::arm40::Provisional::metric::IArmMetricFactory::newArmMetricGroupDefinition ( IArmMetricDefinition[]  definitions  ) 
Parameters:
definitions An array of IArmMetricDefinition objects.

The ordering in the array is important. The array can have up to seven elements and is position-sensitive. To remain consistent with ARM 2.0, any IArmMetricDefinition subclass except IArmMetricString32Definition can be assigned to elements 0:5 and only IArmMetricString32Definition can be assigned to element 6.

Any element can be null. If the input array has fewer than seven elements, the rest of the elements are assigned a value of null. The array can be sparsely populated. For example, there can be a non-null IArmMetricDefinition reference in element 0 and 6, and null references in elements 1:5.

Returns:
a new metadata instance for the metric definition group.
IArmMetricNumericId32 OpenGroup::arm40::Provisional::metric::IArmMetricFactory::newArmMetricNumericId32 ( IArmMetricNumericId32Definition  definition  ) 
Parameters:
definition the metadata describing this metric.
Returns:
a new metric instance.
IArmMetricNumericId32Definition OpenGroup::arm40::Provisional::metric::IArmMetricFactory::newArmMetricNumericId32Definition ( IArmApplicationDefinition  app,
string  name,
string  units,
short  usage,
IArmID  id 
)
Parameters:
app metadata about the containing application.
name name for this definition.
units units description, or null.
usage One of IArmMetricDefinitionConstants.METRIC_USE_GENERAL IArmMetricDefinitionConstants.METRIC_USE_TRAN_SIZE IArmMetricDefinitionConstants.METRIC_USE_TRAN_STATUS or an application-specific negative value.
id ID provided by the application for this metric definition, or null.
Returns:
a new metadata instance for this definition.
IArmMetricNumericId64 OpenGroup::arm40::Provisional::metric::IArmMetricFactory::newArmMetricNumericId64 ( IArmMetricNumericId64Definition  definition  ) 
Parameters:
definition the metadata describing this metric.
Returns:
a new metric instance.
IArmMetricNumericId64Definition OpenGroup::arm40::Provisional::metric::IArmMetricFactory::newArmMetricNumericId64Definition ( IArmApplicationDefinition  app,
string  name,
string  units,
short  usage,
IArmID  id 
)
Parameters:
app metadata about the containing application.
name name for this definition.
units units description, or null.
usage One of IArmMetricDefinitionConstants.METRIC_USE_GENERAL IArmMetricDefinitionConstants.METRIC_USE_TRAN_SIZE IArmMetricDefinitionConstants.METRIC_USE_TRAN_STATUS or an application-specific negative value.
id ID provided by the application for this metric definition, or null.
Returns:
a new metadata instance for this definition.
IArmMetricString32 OpenGroup::arm40::Provisional::metric::IArmMetricFactory::newArmMetricString32 ( IArmMetricString32Definition  definition  ) 
Parameters:
definition the metadata describing this metric.
Returns:
a new metric instance.
IArmMetricString32Definition OpenGroup::arm40::Provisional::metric::IArmMetricFactory::newArmMetricString32Definition ( IArmApplicationDefinition  app,
string  name,
string  units,
short  usage,
IArmID  id 
)
Parameters:
app metadata about the containing application.
name name for this definition.
units units description, or null.
usage One of IArmMetricDefinitionConstants.METRIC_USE_GENERAL IArmMetricDefinitionConstants.METRIC_USE_TRAN_SIZE IArmMetricDefinitionConstants.METRIC_USE_TRAN_STATUS or an application-specific negative value.
id ID provided by the application for this metric definition, or null.
Returns:
a new metadata instance for this definition.
IArmTranReportWithMetrics OpenGroup::arm40::Provisional::metric::IArmMetricFactory::newArmTranReportWithMetrics ( IArmApplication  app,
IArmTransactionWithMetricsDefinition  definition,
IArmMetricGroup  group 
)
Parameters:
app instance of the containing application (scope).
definition metadata about the transaction.
group metrics binding object.

If the metric group reference is null, the resulting IArmTranReportWithMetrics has no metrics, so it would have no more functions than an ArmTranReport object, except to return null to the IArmTranReportWithMetrics.MetricGroup method.

Returns:
a new transaction instance associated with metrics.
IArmTransactionWithMetrics OpenGroup::arm40::Provisional::metric::IArmMetricFactory::newArmTransactionWithMetrics ( IArmApplication  app,
IArmTransactionWithMetricsDefinition  definition,
IArmMetricGroup  group 
)
Parameters:
app instance of the containing application (scope).
definition metadata about the transaction.
group metrics binding object.

If the metric group reference is null, the resulting IArmTranReportWithMetrics has no metrics, so it would have no more functions than an IArmTranReport object, except to return null to the IArmTranReportWithMetrics.MetricGroup method.

Returns:
a new transaction instance associated with metrics.
IArmTransactionWithMetricsDefinition OpenGroup::arm40::Provisional::metric::IArmMetricFactory::newArmTransactionWithMetricsDefinition ( IArmApplicationDefinition  app,
string  name,
IArmIdentityPropertiesTransaction  identityProperties,
IArmMetricGroupDefinition  definition,
IArmID  id 
)

Details about the metadata are found in the OpenGroup.arm40.Provisional.transaction.IArmTransactionDefinition section. In addition, a binding to a set of metadata about metrics is added via an IArmMetricGroupDefinition object.

Parameters:
app metadata about the containing application.
name name for this definition.
identityProperties an initialized set of identity properties.
definition the metric definitions to be used with this transaction.
id ID provided by the application for this transaction definition, or null.
Returns:
a new metadata instance for a transaction associated with metrics.
bool OpenGroup::arm40::Provisional::metric::IArmMetricFactory::SetErrorCallback ( IArmErrorCallback  errorCallback  ) 

See the error handling philosophy comment in the description of OpenGroup.arm40.Provisional.transaction.IArmTransactionFactory

Parameters:
errorCallback an application object implementing the IArmErrorCallback interface.
Returns:
true if registration is accepted.

OpenGroup.arm40.Provisional.transaction.IArmTransactionFactory.SetErrorCallback

The documentation for this interface was generated from the following file:
  • opengroup/arm40/provisional/metric/IArmMetricFactory.cs
MyARM
Documentation generated on Thu May 24 2018 22:24:16. © 2018 by MyARM GmbH