libs/orcacm/types.h

/*
 * Orca-Robotics Project: Components for robotics 
 *               http://orca-robotics.sf.net/
 * Copyright (c) 2004-2009 Alex Brooks, Alexei Makarenko, Tobias Kaupp
 *
 * This copy of Orca is licensed to you under the terms described in
 * the LICENSE file included in this distribution.
 *
 */

#ifndef ORCACM_TYPES_H
#define ORCACM_TYPES_H

#include <vector>
#include <string>
#include <orca/common.h>
#include <orca/ocm.h>

namespace orcacm
{

struct ResultHeader
{
    std::string name;
    std::string text;
};

struct OperationHeader
{
    std::string name;
    std::string signature;
    bool isSupported;
};

struct OperationData
{
    std::string locatorString;
    orca::FQInterfaceName parent;
    std::string parentId;
    std::string name;
    std::vector<ResultHeader> results;
};

struct ProvidesHeader
{
    std::string name;
    std::string id;
    bool isReachable;
};

struct RequiresHeader
{
    orca::FQInterfaceName name;
    std::string id;
    bool isReachable;
};

struct InterfaceData
{
    std::string locatorString;
    orca::FQInterfaceName name;
    std::string id;
    std::vector<OperationHeader> operations;
};

struct ComponentHeader
{
    orca::FQComponentName name;
    bool isReachable;
    std::string address;
};

struct ComponentData
{
    std::string locatorString;
    std::string adminAddress;
    Ice::ObjectPrx adminPrx;
    orca::FQComponentName name;
    bool isReachable;
    std::string address;
    std::vector<ProvidesHeader> provides;
    std::vector<RequiresHeader> requires;
};

struct PlatformHeader
{
    std::string name;
};

struct PlatformData
{
    std::string locatorString;
    std::string adminAddress;
    std::string name;
    std::vector<ComponentHeader> components;
};

struct HomeHeader
{
    Ice::ObjectPrx proxy;
    bool isReachable;
    std::string address;
};

// needed for sorting
bool operator<(const HomeHeader& l, const HomeHeader& r);

struct RegistryFlatData
{
    std::string locatorString;
    std::string address;
    bool isReachable;
    std::vector<ComponentHeader> adapters;
};

struct RegistryHierarchicalData1
{
    std::string locatorString;
    std::string address;
    bool isReachable;
    std::vector<PlatformHeader> platforms;
};

struct RegistryHierarchicalData2
{
    std::string locatorString;
    std::string address;
    bool isReachable;
    PlatformHeader platform;
    std::vector<HomeHeader> homes;
};

struct RegistryHomeData
{
    std::string locatorString;
    std::string address;
    bool isReachable;
    std::vector<HomeHeader> homes;
};

} // namespace

#endif