ComponentContext Class Reference
#include <ComponentContext.h>
List of all members.
Detailed Description
Defines the ComponentContext interface
Member Function Documentation
virtual commonj::sdo::DataFactoryPtr getDataFactory |
( |
|
) |
const [pure virtual] |
Used to get its an SDO DataFactory which can be used to create DataObjects for complex data types used by this component.
- Returns:
- An SDO DataFactory which has definitions for all complex data types used by a component
virtual commonj::sdo::DataObjectPtr getProperties |
( |
|
) |
const [pure virtual] |
Used to get a component's configured property values.
- Returns:
- An SDO from which all the properties defined in the componentType file can be retrieved.
virtual ServiceReferencePtr getSelfReference |
( |
const std::string & |
serviceName |
) |
const [pure virtual] |
Used to get a ServiceReference for a specific service for use with some callback APIs.
- Parameters:
-
- Returns:
- A ServiceReference for the named service provided by this component.
virtual ServiceProxyPtr getService |
( |
const std::string & |
referenceName |
) |
const [pure virtual] |
Used to get a service proxy implementing the interface defined for a Reference.
- Parameters:
-
| referenceName | Name of the Reference to get an interface object for |
- Returns:
- Pointer to a ServiceProxy implementing the interface of the Reference. This will be NULL if referenceName is not defined for the component.
- Exceptions:
-
virtual ServiceReferencePtr getServiceReference |
( |
const std::string & |
referenceName |
) |
const [pure virtual] |
Used to get a ServiceReference for a Reference.
- Parameters:
-
| referenceName | Name of the Reference to get an interface object for |
- Returns:
- ServiceReference for the Reference. This will be NULL if referenceName is not defined for the component.
- Exceptions:
-
virtual std::vector<ServiceReferencePtr> getServiceReferences |
( |
const std::string & |
referenceName |
) |
const [pure virtual] |
Used to to get a vector of ServiceReferences for a Reference.
- Parameters:
-
| referenceName | Name of the Reference to get an interface object for |
- Returns:
- vector of ServiceReferences for the Reference. This vector will be empty if referenceName is not defined for the component.
virtual std::vector<ServiceProxyPtr> getServices |
( |
const std::string & |
referenceName |
) |
const [pure virtual] |
Used to get a vector of service proxies implementing the interface defined for a Reference.
- Parameters:
-
| referenceName | Name of the Reference to get an interface object for |
- Returns:
- vector of pointers to ServiceProxy objects implementing the interface of the Reference. This vector will be empty if referenceName is not defined for the component.
virtual std::string getURI |
( |
|
) |
const [pure virtual] |
Returns the structural URI for this component
- Returns:
- Structural URI for the current component.
The documentation for this class was generated from the following file: