TAO_Policy_Set Class Reference

The policy manager implementation. More...

#include <Policy_Set.h>

Collaboration diagram for TAO_Policy_Set:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 TAO_Policy_Set (TAO_Policy_Scope scope)
 TAO_Policy_Set (const TAO_Policy_Set &rhs)
 ~TAO_Policy_Set (void)
 Destructor.
void copy_from (TAO_Policy_Set *source ACE_ENV_ARG_DECL)
void set_policy_overrides (const CORBA::PolicyList &policies, CORBA::SetOverrideType set_add ACE_ENV_ARG_DECL)
CORBA::PolicyListget_policy_overrides (const CORBA::PolicyTypeSeq &types ACE_ENV_ARG_DECL)
CORBA::Policy_ptr get_policy (CORBA::PolicyType policy ACE_ENV_ARG_DECL)
 Obtain a single policy.
CORBA::Policy_ptr get_cached_const_policy (TAO_Cached_Policy_Type type) const
 Obtain a cached policy for speedy lookups.
CORBA::Policy_ptr get_cached_policy (TAO_Cached_Policy_Type type ACE_ENV_ARG_DECL)
 Obtain a single cached policy.
void set_policy (const CORBA::Policy_ptr policy ACE_ENV_ARG_DECL)
 Utility method to set a single policy.
CORBA::Policyget_policy_by_index (CORBA::ULong index)
CORBA::ULong num_policies (void) const

Private Member Functions

TAO_Policy_Set operator= (const TAO_Policy_Set &)
void cleanup_i (ACE_ENV_SINGLE_ARG_DECL)
CORBA::Boolean compatible_scope (TAO_Policy_Scope policy_scope) const
 Utility method to determine if a policy's scope is compatible with ours.

Private Attributes

CORBA::PolicyList policy_list_
 Policies set for this Policy_Manager.
CORBA::Policycached_policies_ [TAO_CACHED_POLICY_MAX_CACHED]
 List of caches.
TAO_Policy_Scope scope_
 Scope associated to the Policy Manager Impl.

Detailed Description

The policy manager implementation.

This class is used to implement both the CORBA::PolicyManager and the CORBA::PolicyCurrent interfaces.


Constructor & Destructor Documentation

ACE_INLINE TAO_Policy_Set::TAO_Policy_Set TAO_Policy_Scope  scope  ) 
 

Creates a TAO_Policy_Set that has a given scope. The scope is used to determinate whether or not a given policy can be set for the given Policy Manager Implementation.

TAO_Policy_Set::TAO_Policy_Set const TAO_Policy_Set rhs  ) 
 

TAO_Policy_Set::~TAO_Policy_Set void   ) 
 

Destructor.


Member Function Documentation

void TAO_Policy_Set::cleanup_i ACE_ENV_SINGLE_ARG_DECL   )  [private]
 

Remove and destroy all the policy objects owned by this policy manager.

ACE_INLINE CORBA::Boolean TAO_Policy_Set::compatible_scope TAO_Policy_Scope  policy_scope  )  const [private]
 

Utility method to determine if a policy's scope is compatible with ours.

void TAO_Policy_Set::copy_from TAO_Policy_Set *source  ACE_ENV_ARG_DECL  ) 
 

Copy the state from source, it uses the copy() operator to obtain independent copies of all the policies.

CORBA::Policy_ptr TAO_Policy_Set::get_cached_const_policy TAO_Cached_Policy_Type  type  )  const
 

Obtain a cached policy for speedy lookups.

This method just returns a const reference to the policy to avoid obtaining a lock to increment the reference count. As such, it can only be used for single threaded cases or cases where the policies cannot be removed such as at the object and thread level scopes. This method is most likely not appropriate for accessing policies at the ORB level scope in any situation.

CORBA::Policy_ptr TAO_Policy_Set::get_cached_policy TAO_Cached_Policy_Type type  ACE_ENV_ARG_DECL  ) 
 

Obtain a single cached policy.

CORBA::Policy_ptr TAO_Policy_Set::get_policy CORBA::PolicyType policy  ACE_ENV_ARG_DECL  ) 
 

Obtain a single policy.

ACE_INLINE CORBA::Policy * TAO_Policy_Set::get_policy_by_index CORBA::ULong  index  ) 
 

Returns the policy at the specified index. CORBA::Policy::_nil () is returned if the policy doesn't exist.

CORBA::PolicyList * TAO_Policy_Set::get_policy_overrides const CORBA::PolicyTypeSeq &types  ACE_ENV_ARG_DECL  ) 
 

Get the values (if any) for the policies in types, if types is an empty list the method returns *all* the current policies.

ACE_INLINE CORBA::ULong TAO_Policy_Set::num_policies void   )  const
 

TAO_Policy_Set TAO_Policy_Set::operator= const TAO_Policy_Set  )  [private]
 

void TAO_Policy_Set::set_policy const CORBA::Policy_ptr policy  ACE_ENV_ARG_DECL  ) 
 

Utility method to set a single policy.

void TAO_Policy_Set::set_policy_overrides const CORBA::PolicyList policies,
CORBA::SetOverrideType set_add  ACE_ENV_ARG_DECL
 

Modify the list of policies to include policies. If set_add is CORBA::SET_OVERRIDE then we replace all the old policies. If it is CORBA::ADD_OVERRIDE we simply add the policies in policies. No attempt is made to validate the policies for consistency.


Member Data Documentation

CORBA::Policy* TAO_Policy_Set::cached_policies_[TAO_CACHED_POLICY_MAX_CACHED] [private]
 

List of caches.

CORBA::PolicyList TAO_Policy_Set::policy_list_ [private]
 

Policies set for this Policy_Manager.

TAO_Policy_Scope TAO_Policy_Set::scope_ [private]
 

Scope associated to the Policy Manager Impl.


The documentation for this class was generated from the following files:
Generated on Wed Nov 23 16:03:44 2005 for TAO by  doxygen 1.4.5