maci::MockContainerServices

NAME
SYNOPSIS
Constructor & Destructor Documentation
Member Function Documentation
Member Data Documentation
Author

NAME

maci::MockContainerServices −

SYNOPSIS

#include <mockContainerServicesImpl.h>

Inherits maci::ContainerServices.

Public Member Functions

MockContainerServices (ACE_CString &compName)

virtual ~MockContainerServices ()

CORBA::Object * getCORBAComponent (const char *)

CORBA::Object * getCORBAComponentNonSticky (const char *)

CORBA::Object * getCORBADynamicComponent (maci::ComponentSpec, bool)

CORBA::Object * getCORBACollocatedComponent (maci::ComponentSpec, bool, const char *)

CORBA::Object * getCORBADefaultComponent (const char *)

maci::ComponentInfo getComponentDescriptor (const char *)

ACE_CString_Vector findComponents (const char *, const char *)

void releaseComponent (const char *)

void releaseAllComponents ()

CDB::DAL * getCDB ()

PortableServer::POA_var getOffShootPOA ()

ACS::OffShoot * activateOffShoot (PortableServer::ServantBase *)

void deactivateOffShoot (PortableServer::ServantBase *)

PortableServer::POA_var createOffShootPOA ()

maci::ComponentStateManager * getComponentStateManager ()

template<class T > T * getComponent (const char *name)

acsalarm::AlarmSource * getAlarmSource ()

Private Attributes

ACE_Map_Manager< ACE_CString, MockComponent *,ACE_SYNCH_RW_MUTEX > * map

Constructor & Destructor Documentation

maci::MockContainerServices::MockContainerServices (ACE_CString & compName)

virtual maci::MockContainerServices::~MockContainerServices () [virtual]

Member Function Documentation

ACS::OffShoot* maci::MockContainerServices::activateOffShoot (PortableServer::ServantBase *)

PortableServer::POA_var maci::MockContainerServices::createOffShootPOA () [virtual] Create the offshoot POA

Returns:

The newly created POA

Implements maci::ContainerServices.

void maci::MockContainerServices::deactivateOffShoot (PortableServer::ServantBase *)

ACE_CString_Vector maci::MockContainerServices::findComponents (const char * nameWilcard, const char * typeWildcard) [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.

acsalarm::AlarmSource* maci::MockContainerServices::getAlarmSource () [virtual] Returns a pointer to the AlarmSource object used to send alarms in a smart way.

Returns:

the alarm source object owned by this Container Services

See also:

alma.ACS.ComponentStates

Implements maci::ContainerServices.

CDB::DAL* maci::MockContainerServices::getCDB () [virtual] Get a reference to the DAL object

Exceptions:

acsErrTypeContainerServices::CanNotGetCDBExImpl

Returns:

A reference to the DAL

Implements maci::ContainerServices.

template<class T > T * maci::MockContainerServices::getComponent (const char * name) Gets the specified component This method uses templates, so no cast to the request object is required

Parameters:

The name of the deployed component instance

Exceptions:

maciErrType::CannotGetComponentExImpl

Returns:

Reference to the component

Reimplemented from maci::ContainerServices.

References map.

maci::ComponentInfo maci::MockContainerServices::getComponentDescriptor (const char * componentName) [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* maci::MockContainerServices::getComponentStateManager () [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.

Returns:

the state manager

See also:

alma.ACS.ComponentStates

Implements maci::ContainerServices.

CORBA::Object* maci::MockContainerServices::getCORBACollocatedComponent (maci::ComponentSpec compSpec, bool markAsDefault, const char * targetComponent) [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* maci::MockContainerServices::getCORBAComponent (const char * name) [virtual] Gets the specified component as a Corba object.

Parameters:

The name of the deployed component instance

Exceptions:

maciErrType::CannotGetComponentExImpl

Returns:

Reference to the component

Implements maci::ContainerServices.

CORBA::Object* maci::MockContainerServices::getCORBAComponentNonSticky (const char * name) [virtual] Gets the specified component non sticky as a Corba object. for details about getting a component non sticky see get_component_non_sticky

Parameters:

The name of the deployed component instance

Exceptions:

maciErrType::CannotGetComponentExImpl

Returns:

Reference to the component

Implements maci::ContainerServices.

CORBA::Object* maci::MockContainerServices::getCORBADefaultComponent (const char * idlType) [virtual] Gets the default component specified by the IDL component type as a CORBA object.

Parameters:

idlType,: the idl type of the component to activate For example IDL:alma/PS/PowerSupply:1.0

Exceptions:

maciErrType::NoPermissionExImpl
maciErrType::NoDefaultComponentExImpl
maciErrType::CannotGetComponentExImpl

Returns:

The reference to the component

Implements maci::ContainerServices.

CORBA::Object* maci::MockContainerServices::getCORBADynamicComponent (maci::ComponentSpec compSpec, bool markAsDefault) [virtual] Gets a dynamic 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

Exceptions:

maciErrType::NoPermissionExImpl
maciErrType::IncompleteComponentSpecExImpl
maciErrType::InvalidComponentSpecExImpl
maciErrType::ComponentSpecIncompatibleWithActiveComponentExImpl
maciErrType::CannotGetComponentExImpl

Returns:

The reference to the component

Implements maci::ContainerServices.

PortableServer::POA_var maci::MockContainerServices::getOffShootPOA () [virtual] Get the OffShoot POA

Returns:

The offshoot POA

Implements maci::ContainerServices.

void maci::MockContainerServices::releaseAllComponents () [virtual] Release all the components

Returns:

void

Implements maci::ContainerServices.

void maci::MockContainerServices::releaseComponent (const char * name) [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

ACE_Map_Manager<ACE_CString, MockComponent* ,ACE_SYNCH_RW_MUTEX>* maci::MockContainerServices::map [private]

Referenced by getComponent().

Author

Generated automatically by Doxygen for ACS-2015.2 C++ API from the source code.