Main Page | Namespace List | Class Hierarchy | Class List | File List | Namespace Members | Class Members | File Members

RTM::RtcNaming Class Reference

CORBA Naming Service access helper class. More...

#include <RtcNaming.h>

List of all members.

Public Member Functions

 RtcNaming ()
 A constructor of RtcNaming class.

 RtcNaming (CORBA::ORB_ptr orb)
 A constructor of RtcNaming class.

 ~RtcNaming ()
 A destructor of RtcNaming class.

bool initNaming (const CORBA::ORB_ptr orb)
 Initialize RtcNaming object.

CosNaming::NamingContextExt_var createContext (CosNaming::NamingContextExt_var context, const std::string &id, const std::string &kind)
 Create naming context.

bool createHostContext (const std::string &id)
 Create host context.

bool createManagerContext (const std::string &id)
 Create manager context.

bool createCategoryContext (const std::string &category)
 Create category context.

bool createModuleContext (const std::string &module, const std::string &category)
 Create module context.

bool bindObject (CosNaming::NamingContextExt_var context, const std::string &id, const std::string &kind, CORBA::Object_ptr obj)
 Bind object to a context.

bool bindObjectByFullPath (const std::string &path, CORBA::Object_ptr obj)
 Bind object to a context specified full path string.

bool bindComponent (const std::string &component, const std::string &module, const std::string &category, CORBA::Object_ptr obj)
 Bind component to a context.

bool bindManager (const std::string &id, CORBA::Object_ptr obj)
 Bind manager to a context.

bool destroyHostContext ()
 Destroy host context.

bool destroyManagerContext ()
 Destroy manager context.

bool destroyCategoryContext (const std::string &id)
 Destroy manager context.

bool destroyModuleContext (const std::string &module, const std::string &category)
 Destroy manager context.

bool unbindObject (CosNaming::NamingContextExt_var context, const std::string &id, const std::string &kind)
 Unbind object to a context.

bool unbindObjectByFullPath (const std::string &path)
 Unbind object to a context specified full path string.

bool unbindLocalComponent (const std::string category, const std::string module, const std::string instance)
 Unbind component object.

bool findHostContext (const std::string &id_seq, ContextList &context)
 Find host context.

bool findCategoryContext (const std::string &id_seq, ContextList &context)
 Find category context.

bool findModuleContext (const std::string &id_seq, ContextList &context)
 Find module context.

bool findManagerContext (const std::string &id_seq, ContextList &context)
 Find manager context.

bool findManager (std::string &id, ObjectList &objects)
 Find and get manager object reference.

bool findComponents (const std::string &id_seq, ObjectList &objects)
 Find and get component object reference.


Protected Member Functions

bool destroyRecursive (CosNaming::NamingContextExt_var context)
 Destroy naming context recursive.

void findObjectsRecursive (CosNaming::NamingContextExt_ptr context, const std::string &path, ObjectList &obj)
 Find object reference recursive.

void findContextRecursive (CosNaming::NamingContextExt_var context, const std::string &path, ContextList &context_list)
 Find naming context recursive.

void bindObjectRecursive (CosNaming::NamingContextExt_var context, const std::string &path, CORBA::Object_ptr obj)
 Bind context/object recursive.


Detailed Description

CORBA Naming Service access helper class.


Constructor & Destructor Documentation

RTM::RtcNaming::RtcNaming  )  [inline]
 

A constructor of RtcNaming class.

RTM::RtcNaming::RtcNaming CORBA::ORB_ptr  orb  )  [inline]
 

A constructor of RtcNaming class.

RTM::RtcNaming::~RtcNaming  ) 
 

A destructor of RtcNaming class.


Member Function Documentation

bool RTM::RtcNaming::bindComponent const std::string &  component,
const std::string &  module,
const std::string &  category,
CORBA::Object_ptr  obj
 

Bind component to a context.

Bind object to specified naming context

Parameters:
id object ID
category A category bind to the obobject
obj Component object pointer to be bound

bool RTM::RtcNaming::bindManager const std::string &  id,
CORBA::Object_ptr  obj
 

Bind manager to a context.

Bind manager object to specified naming context

Parameters:
id Manager's name as a object id
obj Manager's object pointer

bool RTM::RtcNaming::bindObject CosNaming::NamingContextExt_var  context,
const std::string &  id,
const std::string &  kind,
CORBA::Object_ptr  obj
 

Bind object to a context.

Bind object to specified naming context

Parameters:
context A context to be bound the object
id object ID
kind object KIND
obj Object pointer to be bound

bool RTM::RtcNaming::bindObjectByFullPath const std::string &  path,
CORBA::Object_ptr  obj
 

Bind object to a context specified full path string.

Bind object to specified full path string.

Parameters:
path A full path string to be bound a object.
obj Object reference to be bound

void RTM::RtcNaming::bindObjectRecursive CosNaming::NamingContextExt_var  context,
const std::string &  path,
CORBA::Object_ptr  obj
[protected]
 

Bind context/object recursive.

Parameters:
context Starting point naming context
path Binding path name
obj Object reference to be bound

bool RTM::RtcNaming::createCategoryContext const std::string &  category  ) 
 

Create category context.

Create category context on the default naming service.

Parameters:
id category name as a context id

CosNaming::NamingContextExt_var RTM::RtcNaming::createContext CosNaming::NamingContextExt_var  context,
const std::string &  id,
const std::string &  kind
 

Create naming context.

Create a naming context using Context_var, id and kind

Parameters:
context Naming context to be created new context
id context ID
kind context KIND

bool RTM::RtcNaming::createHostContext const std::string &  id  ) 
 

Create host context.

Create host context on the default naming service.

Parameters:
id host name as a context id

bool RTM::RtcNaming::createManagerContext const std::string &  id  ) 
 

Create manager context.

Create manager context on the default naming service.

Parameters:
id manager name as a context id

bool RTM::RtcNaming::createModuleContext const std::string &  module,
const std::string &  category
 

Create module context.

Create module context on the default naming service.

Parameters:
module module name as a context id
category category name on which module context is created

bool RTM::RtcNaming::destroyCategoryContext const std::string &  id  ) 
 

Destroy manager context.

Parameters:
id Category name

bool RTM::RtcNaming::destroyHostContext  ) 
 

Destroy host context.

bool RTM::RtcNaming::destroyManagerContext  ) 
 

Destroy manager context.

bool RTM::RtcNaming::destroyModuleContext const std::string &  module,
const std::string &  category
 

Destroy manager context.

Parameters:
module Module name
category Category name

bool RTM::RtcNaming::destroyRecursive CosNaming::NamingContextExt_var  context  )  [protected]
 

Destroy naming context recursive.

Parameters:
context Starting point naming context to be deleted.

bool RTM::RtcNaming::findCategoryContext const std::string &  id_seq,
ContextList context
 

Find category context.

Parameters:
id_seq ID sequence to be find
context context sequence (return value)

bool RTM::RtcNaming::findComponents const std::string &  id_seq,
ObjectList objects
 

Find and get component object reference.

Parameters:
id_seq ID sequence to be find
object objecte reference list (return value)

void RTM::RtcNaming::findContextRecursive CosNaming::NamingContextExt_var  context,
const std::string &  path,
ContextList context_list
[protected]
 

Find naming context recursive.

Parameters:
context Starting point naming context
path Search path name
context_list Naming context list (return value)

bool RTM::RtcNaming::findHostContext const std::string &  id_seq,
ContextList context
 

Find host context.

Parameters:
id_seq ID sequence to be find
context context sequence (return value)

bool RTM::RtcNaming::findManager std::string &  id,
ObjectList objects
 

Find and get manager object reference.

Parameters:
id_seq ID sequence to be find
object objecte reference list (return value)

bool RTM::RtcNaming::findManagerContext const std::string &  id_seq,
ContextList context
 

Find manager context.

Parameters:
id_seq ID sequence to be find
context context sequence (return value)

bool RTM::RtcNaming::findModuleContext const std::string &  id_seq,
ContextList context
 

Find module context.

Parameters:
id_seq ID sequence to be find
context context sequence (return value)

void RTM::RtcNaming::findObjectsRecursive CosNaming::NamingContextExt_ptr  context,
const std::string &  path,
ObjectList obj
[protected]
 

Find object reference recursive.

Parameters:
context Starting point naming context
path Search path name
obj Object reference list (return value)

bool RTM::RtcNaming::initNaming const CORBA::ORB_ptr  orb  ) 
 

Initialize RtcNaming object.

Parameters:
orb pointer tod ORB

bool RTM::RtcNaming::unbindLocalComponent const std::string  category,
const std::string  module,
const std::string  instance
 

Unbind component object.

Unbind object which was bound this RtcNaming object.

Parameters:
category Category name of the object to be unbound.
module Module name of the object to be unbound.
instance Instance name of the object to be unbound.

bool RTM::RtcNaming::unbindObject CosNaming::NamingContextExt_var  context,
const std::string &  id,
const std::string &  kind
 

Unbind object to a context.

Unbind object to specified naming context

Parameters:
context A context to be unbound the object
id object ID
kind object KIND

bool RTM::RtcNaming::unbindObjectByFullPath const std::string &  path  ) 
 

Unbind object to a context specified full path string.

Unbind object to specified full path string.

Parameters:
path A full path string to be bound a object.


The documentation for this class was generated from the following file:
Generated on Mon May 23 03:13:58 2005 for OpenRTM by doxygen 1.3.6