orca-robotics INTRODUCTION Overview Download and Install Quick Start Documentation Publications REPOSITORY Interfaces Components Libraries Utilities Software Map DEVELOPER Tutorials Examples Dev Guide Dashboard Wiki login/pass: orca/orca PEOPLE Contributors Users Project Download Mailing lists

orcacm Namespace Reference Utilities for navigating the Orca Component Model (OCM). More... Classes struct   ResultHeader   Brief version of operation result. More... struct   OperationHeader struct   OperationData struct   ProvidesHeader struct   RequiresHeader struct   InterfaceData struct   ComponentHeader struct   ComponentData struct   PlatformHeader struct   PlatformData struct   HomeHeader   Information about a Home object. More... struct   RegistryFlatData   Registry data which lists components. More... struct   RegistryHierarchicalData1   Registry data which lists platforms. More... struct   RegistryHierarchicalData2   Registry data which lists platforms. More... struct   RegistryHomeData   Registry data. More... Lookup Functions bool  pingObject (const orcaice::Context &context, const std::string &objectId) RegistryHomeData  getRegistryHomeData (const orcaice::Context &context, const std::string &locatorString, bool tryToPing) ComponentData  getComponentData (const orcaice::Context &context, const std::string &adapterId) ComponentData  getComponentData (const orcaice::Context &context, const orca::FQComponentName &component) ProvidesHeader  getProvidesHeader (const orcaice::Context &context, const orca::FQInterfaceName &fqName) RequiresHeader  getRequiresHeader (const orcaice::Context &context, const orca::FQInterfaceName &fqName) Functions std::string  connectionToLocalAddress (const std::string &s)   Parses a string returned by Ice::Connection to extract the local address. std::string  connectionToRemoteAddress (const std::string &s)   Parses a string returned by Ice::Connection to extract the remote address. std::string  stringToIceGridInstanceName (const std::string &s) Detailed Description Utilities for navigating the Orca Component Model (OCM). This namespace is part of a library which helps navigate the Orca Component Model (OCM). See also: libOrcaCompModel Function Documentation ComponentData orcacm::getComponentData (  const orcaice::Context &  context, const orca::FQComponentName &  component )    Connects to Home interface of the specified component and gets its deployment and interface information. If connection fails for some reason, isReachable field of ComponentData is set to FALSE. If you already have an instance of RegistryData, do this: getComponentData( context, registryData.adapters[i].name ) ComponentData orcacm::getComponentData (  const orcaice::Context &  context, const std::string &  adapterId )    Convenience function, behaves like the one above. ProvidesHeader orcacm::getProvidesHeader (  const orcaice::Context &  context, const orca::FQInterfaceName &  fqName )    Tries to connect to the specified interface and, if successful, gets its ID. If connection fails for some reason, the Object ID is set to "unknown". RegistryHomeData orcacm::getRegistryHomeData (  const orcaice::Context &  context, const std::string &  locatorString, bool  tryToPing = true )    Connects to IceGrid/Query interface of the specified registry and gets the list of objects of type orca::Home. If connection fails for some reason, isReachable field of RegistryData is set to FALSE. When using the default registry, you can obtain the locatorString like this: communicator()->getDefaultLocator()->ice_toString() If tryToPing is TRUE (default), the function attempts to ping each Home object. Otherwise it doesn't and the isReachable field for each Home is set to TRUE; RequiresHeader orcacm::getRequiresHeader (  const orcaice::Context &  context, const orca::FQInterfaceName &  fqName )    Tries to connect to the specified interface and, if successful, gets its ID. If connection fails for some reason, the Object ID is set to "unknown". bool orcacm::pingObject (  const orcaice::Context &  context, const std::string &  objectId )    Attempts to ping the well-known object with specified identity. Returns TRUE if successful. std::string orcacm::stringToIceGridInstanceName (  const std::string &  s  )    Parses the stringified proxy of an IceGrid well-known object, e.g. MyGrid/Locator and extracts just the IceGrid Instance Name, e.g. MyGrid.

Webmaster: Tobias Kaupp (tobasco at users.sourceforge.net)

---