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

orcadef Namespace Reference Parses component definition files. More... Classes class   InterfaceDef   Definition of an interface. More... class   ProvidedDef   Definition of a provided interface. More... class   RequiredDef   Definition of a required interface. More... struct   ConfigDef   Definition of a configuration option. More... struct   ComponentDef   Holds the information for component definition. More... class   InterfaceCfg   Configuration of an interface. More... class   ProvidedCfg   Configuration of a provided interface. More... class   RequiredCfg   Configuration of a required interface. More... struct   ConfigCfg   Configuration option. More... struct   ComponentCfg   Holds the information for component configuration. More... class   Exception   Base class for exceptions coming from libOrcaDef. More... class   FileException   Throw it when something is wrong with reading the definition file. More... class   ParseException   Throw it when something is wrong in parsing the definition file. More... Functions const std::string  toDefText (const ComponentDef &def) ComponentCfg  toCfg (const ComponentDef &def) const std::string  toCfgText (const ComponentDef &def) const std::string  toCfgTextWithHeaders (const ComponentDef &def, const std::vector< std::string > &headers) const std::string  toXmlText (const ComponentDef &def, bool withTemplate) const std::string  toXmlTemplateText (const ComponentDef &def) ComponentDef  invertDef (const ComponentDef &def, const std::string &invTag) void  parseDefFile (const std::string &filename, ComponentDef &def) Detailed Description Parses component definition files. This namespace is part of a library which parses component definition files. One use of this library is to build the .cfg files. See also: libOrcaDef Function Documentation ComponentDef orcadef::invertDef (  const ComponentDef &  def, const std::string &  invTag )    Reverses required and provided interfaces. The output file describes a component which provides all the interfaces which the original component requires and vice versa. The input configuration parameters are discarded because they don't apply to the output component. void orcadef::parseDefFile (  const std::string &  filename, ComponentDef &  def )    Opens the component definition file and parses it. May throw exceptions: orcadef::FileException: if the def file can't be opened orcadef::ParseException if the def file is badly-formed. See also: defToCfg ComponentCfg orcadef::toCfg (  const ComponentDef &  def  )    Generates a configuration structure based on definitions and built-in conventions. Throws ParseException if the definition structure is ill-formed. const std::string orcadef::toCfgText (  const ComponentDef &  def  )    Use this function to generate a default config file from a component description structure. Throws ParseException if the definition structure is ill-formed. const std::string orcadef::toCfgTextWithHeaders (  const ComponentDef &  def, const std::vector< std::string > &  headers )    Same as orcadef::toCfgText but adds some common properties. const std::string orcadef::toDefText (  const ComponentDef &  def  )    Generates a string in the format suitable for writing to a file. Throws ParseException if the definition structure is ill-formed. const std::string orcadef::toXmlTemplateText (  const ComponentDef &  def  )    Generates a templated descriptor file from a component definition structure. Throws ParseException if the definition structure is ill-formed. const std::string orcadef::toXmlText (  const ComponentDef &  def, bool  withTemplate = false )    Generates a default descriptor file from a component definition structure. Throws ParseException if the definition structure is ill-formed.

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

---