Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

StaticContainerServices Class Reference

#include <taskStaticContainerServices.h>

Inheritance diagram for StaticContainerServices:

Inheritance graph
[legend]
Collaboration diagram for StaticContainerServices:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 StaticContainerServices (const maci::Handle componentHandle, ACE_CString &name, PortableServer::POA_ptr poa, CORBA::ORB_ptr orb)
virtual ~StaticContainerServices ()
CORBA::Object * getCORBAComponent (const char *name)
CORBA::Object * getCORBAComponentNonSticky (const char *name)
CORBA::Object * getCORBADynamicComponent (maci::ComponentSpec compSpec, bool markAsDefault)
CORBA::Object * getCORBADefaultComponent (const char *idlType)
maci::ComponentInfo getComponentDescriptor (const char *componentName)
ACE_CString_Vector findComponents (const char *nameWilcard, const char *typeWildcard)
void releaseComponent (const char *name)
void releaseAllComponents ()
CDB::DAL_ptr getCDB ()
PortableServer::POA_var getOffShootPOA ()
ACS::OffShoot_ptr activateOffShoot (PortableServer::Servant cbServant)
void deactivateOffShoot (PortableServer::Servant cbServant)
PortableServer::POA_var createOffShootPOA ()
maci::ComponentStateManagergetComponentStateManager ()
virtual CORBA::Object * getCORBACollocatedComponent (maci::ComponentSpec, bool, const char *)

Private Attributes

CORBA::ORB_var orb_m
maci::Handle m_componentHandle
 Component handle.
maci::MACIComponentStateManager componentStateManager_m
 The component state manager.

Constructor & Destructor Documentation

StaticContainerServices::StaticContainerServices const maci::Handle  componentHandle,
ACE_CString &  name,
PortableServer::POA_ptr  poa,
CORBA::ORB_ptr  orb
 

Constructor

virtual StaticContainerServices::~StaticContainerServices  )  [inline, virtual]
 

Destructor


Member Function Documentation

ACS::OffShoot_ptr StaticContainerServices::activateOffShoot PortableServer::Servant  cbServant  )  [inline, virtual]
 

Activates a CORBA servant that implements the OffShoot interface.

Parameters:
cbServant the CORBA-generated servant, e.g. CBdoublePOA
Returns:
A reference to the OffShoot *

*

Implements maci::ContainerServices.

PortableServer::POA_var StaticContainerServices::createOffShootPOA  )  [inline, virtual]
 

Create the offshoot POA

Returns:
The newly created POA

Implements maci::ContainerServices.

void StaticContainerServices::deactivateOffShoot PortableServer::Servant  cbServant  )  [inline, virtual]
 

Deactivate the offshoot CORBA servant

Parameters:
cbServant the CORBA servant
Exceptions:
acsErrTypeContainerServices::OffShootDeactivationExImpl 
acsErrTypeContainerServices::OffShootPOAExImpl 

Implements maci::ContainerServices.

ACE_CString_Vector StaticContainerServices::findComponents const char *  nameWilcard,
const char *  typeWildcard
[inline, virtual]
 

Finds components by their instance name (curl) and/or by their type. Wildcards can be used for the curl and type. This method returns a possibly empty array of component curls; for each curl, you may use getComponent to obtain the reference.

Parameters:
nameWildcard (null is understood as "*")
typeWildcard (null is understood as "*")
Returns:
A vector of ACE_CString that contains the name of the component(s) that match the search. *

*

Implements maci::ContainerServices.

CDB::DAL_ptr StaticContainerServices::getCDB  )  [virtual]
 

Get a reference to the DAL object

Returns:
A reference to the DAL
Exceptions:
acsErrTypeContainerServices::CanNotGetCDBExImpl  *

*

Implements maci::ContainerServices.

maci::ComponentInfo StaticContainerServices::getComponentDescriptor const char *  componentName  )  [inline, virtual]
 

Gets the component info for the component

Parameters:
componentName The name of the component
Exceptions:
acsErrTypeContainerServices::GettingCompInfoExImpl 
Returns:
The ComponentInfo struct of the component

Implements maci::ContainerServices.

maci::ComponentStateManager* StaticContainerServices::getComponentStateManager  )  [inline, virtual]
 

Returns a pointer to the ComponentStateManager through which the component and the container administrate the state of the component.

The component needs to access the ComponentStateManager if it wishes to change its state. If it doesn't, only the container will change the state based on the information it has available.

Exceptions:
maciErrType::IncompleteComponentSpecEx 
maciErrType::InvalidComponentSpecEx 
maciErrType::ComponentSpecIncompatibleWithActiveComponentEx 
maciErrType::CannotGetComponentEx 
Returns:
the state manager
See also:
alma.ACS.ComponentStates

Implements maci::ContainerServices.

virtual CORBA::Object* StaticContainerServices::getCORBACollocatedComponent maci::ComponentSpec  ,
bool  ,
const char * 
[inline, virtual]
 

Gets a collocated component as a Corba object.

Parameters:
compSpec The description of the component to activate
markAsDefault If true, the component becomes the default component for that IDL type
targetComponent name of the target component (where to activate component)
Exceptions:
maciErrType::NoPermissionExImpl 
maciErrType::IncompleteComponentSpecExImpl 
maciErrType::InvalidComponentSpecExImpl 
maciErrType::ComponentSpecIncompatibleWithActiveComponentExImpl 
maciErrType::CannotGetComponentExImpl 
Returns:
The reference to the component

Implements maci::ContainerServices.

CORBA::Object* StaticContainerServices::getCORBAComponent const char *  name  )  [inline, virtual]
 

Exceptions:
maciErrType::CannotGetComponentExImpl 

Implements maci::ContainerServices.

CORBA::Object* StaticContainerServices::getCORBAComponentNonSticky const char *  name  )  [inline, virtual]
 

Exceptions:
maciErrType::CannotGetComponentExImpl 

Implements maci::ContainerServices.

CORBA::Object* StaticContainerServices::getCORBADefaultComponent const char *  idlType  )  [inline, virtual]
 

Implementation of acsContainerServices::getCORBADefaultComponent(const char* name)

Exceptions:
maciErrType::NoDefaultComponentExImpl 
maciErrType::CannotGetComponentExImpl 

Implements maci::ContainerServices.

CORBA::Object* StaticContainerServices::getCORBADynamicComponent maci::ComponentSpec  compSpec,
bool  markAsDefault
[inline, virtual]
 

Implementation of acsContainerServices::getCORBADynamicComponent(const char* name)

Exceptions:
maciErrType::IncompleteComponentSpecExImpl 
maciErrType::InvalidComponentSpecExImpl 
maciErrType::ComponentSpecIncompatibleWithActiveComponentExImpl 
maciErrType::CannotGetComponentExImpl 

Implements maci::ContainerServices.

PortableServer::POA_var StaticContainerServices::getOffShootPOA  )  [inline, virtual]
 

Get the OffShoot POA

Returns:
The offshoot POA

Implements maci::ContainerServices.

void StaticContainerServices::releaseAllComponents  )  [inline, virtual]
 

Release all the components

Returns:
void

Implements maci::ContainerServices.

void StaticContainerServices::releaseComponent const char *  name  )  [inline, virtual]
 

Releases the specified component.

Parameters:
The name of the component instance to be released
Exceptions:
maciErrType::CannotReleaseComponentExImpl 
Returns:
void *

*

Implements maci::ContainerServices.


Member Data Documentation

maci::MACIComponentStateManager StaticContainerServices::componentStateManager_m [private]
 

The component state manager.

maci::Handle StaticContainerServices::m_componentHandle [private]
 

Component handle.

CORBA::ORB_var StaticContainerServices::orb_m [private]
 


The documentation for this class was generated from the following file:
Generated on Thu Apr 30 02:36:55 2009 for ACS C++ API by doxygen 1.3.8