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

Main Page   Class Hierarchy   Compound List   Compound Members  

ResourcePreference Class Reference

This object gives the developer the ability to be able to programmatically describe any preference for resources while their workload executes in the cluster. This preference can be associated with sessions or tasks. More...

List of all members.


Public Methods

 ResourcePreference ()
 Creates an empty resource preference that can be populated by resource attribute definitions.

 ResourcePreference (const SoamChar *expression)
 Gives a more complex interface for allowing the developer to construct a string representation of the preference. The expression cannot exceed a length of 2048 characters.

 ResourcePreference (const std::string &expression)
 Gives a more complex interface for allowing the developer to construct a string representation of the preference. The expression cannot exceed a length of 2048 characters.

virtual ~ResourcePreference ()
 Destructor.

void addDefinition (ResourceAttributeDefinition &definition) throw (SoamException)
 Allows a definition to be associated with a preference. When no explicit expression is specified, an expression will be built automatically by combining all definitions added to the preference.


Friends

class SessionCreationAttributes
class TaskSubmissionAttributes

Detailed Description

This object gives the developer the ability to be able to programmatically describe any preference for resources while their workload executes in the cluster. This preference can be associated with sessions or tasks.


Constructor & Destructor Documentation

ResourcePreference  
 

Creates an empty resource preference that can be populated by resource attribute definitions.

ResourcePreference const SoamChar *    expression
 

Gives a more complex interface for allowing the developer to construct a string representation of the preference. The expression cannot exceed a length of 2048 characters.

Note:
Refer to "Specifying Resource Preference for Sessions and Tasks" in the Cluster and Application Management guide or to the Data-aware Scheduling User Guide for more details on the preference expression syntax.
Parameters:
expression  [IN] - The preference expression to be used at evaluation time.

ResourcePreference const std::string &    expression
 

Gives a more complex interface for allowing the developer to construct a string representation of the preference. The expression cannot exceed a length of 2048 characters.

Note:
Refer to "Specifying Resource Preference for Sessions and Tasks" in the Cluster and Application Management guide or to the Data-aware Scheduling User Guide for more details on the preference expression syntax.
Parameters:
expression  [IN] - The preference expression to be used at evaluation time.

virtual ~ResourcePreference   [virtual]
 

Destructor.


Member Function Documentation

void addDefinition ResourceAttributeDefinition   definition throw (SoamException)
 

Allows a definition to be associated with a preference. When no explicit expression is specified, an expression will be built automatically by combining all definitions added to the preference.

For example : If you added definitions with aliases of "DatasetA" and "DatasetB", the resulting expression will be "DatasetA + DatasetB".

Note:
Once a user explicitly specifies an expression, adding definitions will have no effect on the expression.
Parameters:
definition  [IN] - The definition to be used within this preference when resolving the specified resource attribute
Exceptions:
SoamException 


     
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.