Skip to content

C++ Keynodes API

Note

This is correct for only versions of sc-machine that >= 0.10.0.

This API provides functionality to define keynodes on C++.

A keynode is a key sc-element used by some program (agent) during its operation. Typically, keynodes can be classes and relations, which are sc-elements that program (agent) uses to find constructions in sc-memory or generate new ones. However, keynodes can be any sc-elements (incl. connectors between sc-elements).

Note

To include this API provide #include <sc-memory/sc_keynodes.hpp> in your hpp source.

ScKeynode

It is a base class for all keynodes. Use it to generate keynodes in the ScKeynodes class for use in agent programs.

#include <sc-memory/sc_keynodes.hpp>

static ScKeynode const my_keynode_class{
    "my_keynode_class", ScType::ConstNodeClass};

Note

We recommend to name keynode as a system identifier of key element.

Note

Keynodes can be defined not only in classes inherited from the ScKeynodes class. You can define them as static objects anywhere.

Warning

Use this class only for static object declarations.

Also, you can convert any keynode to string.

std::string const & systemIdtf = my_keynode_class;

It can be useful if you want logging keynode system identifiers.

ScTemplateKeynode

It is a base class to generate sc-templates as keynodes. This class is useful when you want use programably represented sc-template in different places in the code or when you don't want specify sc-template in knowledge base and use it in ScAgentBuilder.

#include <sc-memory/sc_keynodes.hpp>

static ScTemplateKeynode const & my_agent_initiation_condition =
  ScTemplateKeynode("my_agent_initiation_condition")
     .Triple(
        ScKeynodes::action_initiated,
        ScType::VarPermPosArc,
        ScType::VarNode >> "_action")
     .Triple(
        MyKeynodes::my_action,
        ScType::VarPermPosArc,
        "_action");

Note

Objects of this class can be used as ScTemplate and ScAddr.

Warning

Use this class only for static object declarations.

ScKeynodes

This class is a base class for keynodes declaration. It's like a namespace. Use it as a base class for own keynodes. This class already contains frequently used keynodes. Use them in your code.

// File my_keynodes.hpp:
#pragma once

#include <sc-memory/sc_keynodes.hpp>

class MyKeynodes : public ScKeynodes
{
public:
  static inline ScKeynode const my_keynode_class_a{
    "my_keynode_class_a", ScType::ConstNodeClass};
  static inline ScKeynode const my_keynode_relation_b{
    "my_keynode_relation_b", ScType::ConstNodeNonRole};
};

You don't have to inherit class ScKeynodes, you can do it this way.

// File my_keynodes.hpp:
#pragma once

#include <sc-memory/sc_keynodes.hpp>

class MyKeynodes
{
public:
  static inline ScKeynode const my_keynode_class_a{
    "my_keynode_class_a", ScType::ConstNodeClass};
  static inline ScKeynode const my_keynode_relation_b{
    "my_keynode_relation_b", ScType::ConstNodeNonRole};
};

Frequently Asked Questions

Is it possible to generate the same keynodes in different modules but with different types?

You can generate the same keynodes in different modules. The main thing is that there should be no name conflict in the classes in which these keynodes are declared. However, you cannot generate identical keynodes in different modules with different types, for example, as structure and as class. All sc-elements with the same system identifiers are automatically glued together.

Is it possible to generate a keynode inside an agent class?

Yes, the algorithm is exactly the same if you were to generate this keynode in a separate special class for keynodes.

When are keynodes initialized?

They are initialized during sc-memory initialization. Do not use them before the memory has been initialized.