Visit Platform at http://www.platform.com

Main Page   Class Hierarchy   Compound List   Compound Members  

ResourceAttribute Class Reference

A resource attribute that the application wishes to publish to the system. More...

List of all members.


Public Types

enum  Scope { Instance = ATTR_SCOPE_INSTANCE, Host = ATTR_SCOPE_HOST }

Public Methods

 ResourceAttribute (const SoamChar *name)
 Constructs a ResourceAttribute object with the specified name.

 ResourceAttribute (const std::string &name)
 Constructs a ResourceAttribute object with the specified name.

virtual ~ResourceAttribute ()
 Destructor.

void setValue (const SoamDouble value) throw (SoamException)
 Sets the value associated with the resource attribute.

void setScope (const Scope scope) throw (SoamException)
 Sets the scope of the resource attribute.


Friends

class ServiceContext

Detailed Description

A resource attribute that the application wishes to publish to the system.

See also:
ServiceContext::publish(ResourceAttribute& attribute)


Member Enumeration Documentation

enum Scope
 

ResourceAttribute::Scope Enumeration indicating the scope of the ResourceAttribute being published.

Enumeration values:
Instance  Resource attributes published with "Instance" scope will be associated with the current service instance from which the resource attribute is being published. When scope is not explicitly specified for a resource attribute, "Instance" will be assumed.
Host  Resource attributes published with "Host" scope will be associated with the execution host.

Constructor & Destructor Documentation

ResourceAttribute const SoamChar *    name
 

Constructs a ResourceAttribute object with the specified name.

The attribute name should be the same as the name specified in a resource preference expression associated with the application's workload or the name specified in a definition. Maximum 256 characters.

Parameters:
name  [IN] - The name of the resource attribute.
Exceptions:
SoamException 

ResourceAttribute const std::string &    name
 

Constructs a ResourceAttribute object with the specified name.

The attribute name should be the same as the name specified in a resource preference expression associated with the application's workload or the name specified in a definition. Maximum 256 characters.

Parameters:
name  [IN] - The name of the resource attribute.
Exceptions:
SoamException 

virtual ~ResourceAttribute   [virtual]
 

Destructor.


Member Function Documentation

void setValue const SoamDouble    value throw (SoamException)
 

Sets the value associated with the resource attribute.

The value to be used by the system when evaluating the resource preference expression within the context of the resource and its attributes (i.e. service instance or host) Default value is 1.000000e+300.

Parameters:
value  [IN] - The value to be associated with the resource attribute.
Exceptions:
SoamException 

void setScope const Scope    scope throw (SoamException)
 

Sets the scope of the resource attribute.

Resource attributes can exist either at a service instance level or be generally available to any entity on a host. Use this method to set whether the attribute applies at the host or instance level. This value can be one of the values defined by ResourceAttribute::Scope values.

Parameters:
scope  [IN] - The scope of the attibute.
Exceptions:
SoamException 
See also:
ResourceAttribute::Scope


     
Date Modified: 11 Nov 2009
Platform Support: support@platform.com
Platform Information Development: doc@platform.com

Platform Computing. Accelerating Intelligence(TM).
Copyright © 2001-2009 Platform Computing Corporation. All rights reserved.