Pepper やNaoで使用されているNaoqi OSのメモです。

このページについて

NAOqi Core - 概要 | API | チュートリアル

Namespace : AL
#include <alproxies/almemoryproxy.h>

Method list

このモジュールはALModule APIから引き継がれており、そして以下のメソッドもあります。

class ALMemoryProxy
  • ALMemoryProxy::declareEvent
  • ALMemoryProxy::getData
  • ALMemoryProxy::getDataList
  • ALMemoryProxy::getDataListName
  • ALMemoryProxy::getDataOnChange
  • ALMemoryProxy::getDataPtr
  • ALMemoryProxy::getDescriptionList
  • ALMemoryProxy::getEventHistory
  • ALMemoryProxy::getEventList
  • ALMemoryProxy::getExtractorEvent
  • ALMemoryProxy::getListData
  • ALMemoryProxy::getMicroEventList
  • ALMemoryProxy::getSubscribers
  • ALMemoryProxy::getType
  • ALMemoryProxy::getTimestamp
  • ALMemoryProxy::insertData
  • ALMemoryProxy::insertListData
  • ALMemoryProxy::raiseEvent
  • ALMemoryProxy::raiseMicroEvent
  • ALMemoryProxy::removeData
  • ALMemoryProxy::removeMicroEvent
  • ALMemoryProxy::setDescription
  • ALMemoryProxy::subscribeToEvent
  • ALMemoryProxy::subscribeToMicroEvent
  • ALMemoryProxy::unregisterModuleReference
  • ALMemoryProxy::unsubscribeToEvent
  • ALMemoryProxy::unsubscribeToMicroEvent
  • ALMemoryProxy::subscriber

Event list

Methods


&aname(0)
void ALMemoryProxy::declareEvent(const std::string& eventName)
今後の宣言されるイベントへ対応します。

パラメータ:
eventName – イベント名



void ALMemoryProxy::declareEvent(const std::string& eventName, const std::string& extractorName)
今後の宣言されるイベントへ対応します。

パラメータ:
eventName – イベント名
extractorName – イベントをつくることが可能なエクストラクター名

&aname()
AL::ALValue ALMemoryProxy::getData(const std::string& key)
メモリにペアとして格納されているキーと値のうち、値をとってきます。

パラメータ:
key – 値の名前
返り値:
AL::ALValueとしてのデータ。元の型に透過的にキャストされることが多いです。

&aname()
AL::ALValue ALMemoryProxy::getData(const std::string& key, const int& deprecatedParameter)
バージョン1.12から非推奨のため、2つ目のパラメータをなくして使ってください。

メモリにペアとして格納されているキーと値のうち、値をとってきます。

パラメータ:
key – 値の名前
deprecatedParameter – このパラメータはもう機能しませんが、互換性のために残されています。
返り値:
AL::ALValueとしてのデータ

&aname()
std::vector<std::string> ALMemoryProxy::getDataList(const std::string& filter)
指定されたstring型を含むすべてのキーのリストをとってきます。

パラメータ:
filter – 検索するために使われるstirng型
返り値:
指定されたstring型を含むすべてのキーのリストをとってきます。

&aname()
std::vector<std::string> ALMemoryProxy::getDataListName()
メモリにペアとして格納されているキーと値のうち、値をとってきます。

返り値:メモリに存在するキーを含むリスト

&aname()
AL::ALValue ALMemoryProxy::getDataOnChange(const std::string& key, const int& deprecatedParameter)
キーの値が変わるまで呼び出し関数をブロックします。

バージョン1.12から非推奨のため、ALMemoryProxy::getDataを呼び出すように設定しデータが変わる際には比較をしてください。

パラメータ:
key – データ名
deprecatedParameter – このパラメータは機能しません。
返り値:
検索されたすべてのデータを含む配列

&aname()
void* ALMemoryProxy::getDataPtr(const std::string& key)
32bit型のポインタをとってきます。ALMemoryProxy オブジェクトが機能している限りでしかポインタが有効でないことに注意してください。初期化の際に注意し、毎回のループで使わないようにしてください。

パラメータ:
key – データ名
返り値:
int型に変換されたポインタ

&aname()
AL::ALValue ALMemoryProxy::getDescriptionList(const std::vector<std::string>& keys)
与えられたすべてのキーの説明をとってきます。

パラメータ:
keys – キーのリスト。すべての説明を得るには空にしてください。
返り値:
データあるいはイベントが型の配列(キー、型、説明)


&aname()
AL::ALValue ALMemoryProxy::getEventHistory(const std::string& pName)
パラメータ:
key – 変数名
返り値:
与えられたstring型を含むすべてのデータキーの名前のリスト。

&aname()
std::vector<std::string> ALMemoryProxy::getEventList()
宣言したすべてのイベント名を含むリストを得る。

返り値: すべてのイベント名を含むリスト。

&aname()
AL::ALValue ALMemoryProxy::getTimestamp(const std::string& memoryKey)
memoryKeyの値とそのタイムスタンプを得る。

パラメータ:
memoryKey – ALMemory内のmemoryKey名。
返り値:
3つのitem要素を持つALValue: memoryKeyの値、タイムスタンプの秒数の数字、タイムスタンプのマイクロ秒の数字


&aname()
std::vector<std::string> ALMemoryProxy::getExtractorEvent(const std::string& extractorName)
与えられたエクストラクターにより生成されたすべてのイベントのリストを得る。


パラメータ:
extractorName – エクストラクター名
返り値:
与えらたエクストラクターに関連するイベント名を含むリスト

&aname()
AL::ALValue ALMemoryProxy::getListData(const AL::ALValue& keyList)
与えられたキーのリストに関連した値を得ます。特にネットワークを介して使う際は、getDataを何度も呼び出すよりも効率的です。

パラメータ:
keyList – キー名を含む配列。
返り値:
与えられたキーに対応するすべての値を含む配列。

&aname()
std::vector<std::string> ALMemoryProxy::getMicroEventList()
宣言したすべてのmicroEventを含むリストを得ます。

返り値:すべてのmicroEvent名を含むリスト

&aname()
std::vector<std::string> ALMemoryProxy::getSubscribers(const std::string& name)
Subscribersの名前を含むリストを得ます。

パラメータ:
name – イベントあるいはmicro-eventの名前
返り値:
subscribersの名前のリスト


&aname()
std::string ALMemoryProxy::getType(const std::string& key)
格納されたデータの記憶クラスを得ます。これは根本的なPOD型ではありません。

パラメータ:
key – 変数の名前
返り値:
String型: Data, Event, MicroEvent

&aname()
void ALMemoryProxy::insertData(const std::string& key, const int& value)
メモリにキーと値(int型)のペアに挿入します。

パラメータ:
key – 挿入される値の名前
value – 挿入されるint型

&aname()
void ALMemoryProxy::insertData(const std::string& key, const float& value)
メモリにキーと値(float型)のペアに挿入します。

パラメータ:
key – 挿入される値の名前
value – 挿入されるfloat型

&aname()
void ALMemoryProxy::insertData(const std::string& key, const std::string& value)
メモリにキーと値(string型)のペアに挿入します。

パラメータ:
key – 挿入される値の名前
value – 挿入されるstring型

&aname()
void ALMemoryProxy::insertData(const std::string& key, const AL::ALValue& data)
メモリにキーと値(ALValue)のペアに挿入します。

パラメータ:
key – 挿入される値の名前
data – 挿入されるALValue。これは基本的な型あるいはより複雑な配列を含むことがあります。さらに詳しくはALValue documentationを参照してください。

&aname()
void ALMemoryProxy::insertListData(const AL::ALValue& list)
メモリにキーと値のペアのリストを挿入します。

パラメータ:
list –[[Key, Value],...]の形のALValueリスト。各itemは挿入されます。

&aname()
void ALMemoryProxy::raiseEvent(const std::string& name, const AL::ALValue& value)
すべてのsubscribersに与えられたデータをパブリッシュします。

パラメータ:
name – raiseするイベント名。
value – イベントと関連するデータ。これは基本的な型あるいはより複雑な配列を含むことがあります。さらに詳しくはALValue documentationを参照してください。

&aname()
void ALMemoryProxy::raiseMicroEvent(const std::string& name, const AL::ALValue& value)
すべてのsubscribersに与えられたデータをパブリッシュします。

パラメータ:
name – raiseするイベント名。
value – イベントに関連するデータ。これは基本的な型あるいはより複雑な配列を含むことがあります。さらに詳しくは libalvalue documentationを参照してください。

&aname()
void ALMemoryProxy::removeData(const std::string& key)
メモリからキーと値のペアを消去する。

パラメータ:
key – 消去するデータの名前。

&aname()
void ALMemoryProxy::removeMicroEvent(const std::string& name)
メモリからmicro eventを消去し、あらゆるsubscribersをunscribeします。

パラメータ:
name – 消去するイベント名。

&aname()
void ALMemoryProxy::setDescription(const std::string& name, const std::string& description)
メモリエントリの説明をします。

パラメータ:
name – ドキュメントに対するキーの名前
description – 説明

&aname()
void ALMemoryProxy::subscribeToEvent(const std::string& name, const std::string& callbackModule, const std::string& callbackMethod)
イベントをサブスクライブし、要求された際にそれ自身イベントのジェネレータとして宣言されたモジュールを自動的にローンチします。

パラメータ:
name – サブスクライブするイベント名
callbackModule – 通知とともに呼びされるモジュールの名前
callbackMethod – データが変わった際に呼びされるモジュールのメソッドの名前
詳細は以下のであげた例を参照してください。

C++ callback signature:

class MyModule : public AL::ALModule {
public:
void myCallback(const std::string &key, const AL::ALValue &value, const AL::ALValue &message);
};
Python callback signature:

# create python module
class MyModule(ALModule):
""" Mandatory docstring. comment needed to create a new python module """
def myCallback(self, key, value, message): """ Mandatory docstring. comment needed to create a bound method """ pass

&aname()
void ALMemoryProxy::subscribeToEvent(const std::string& name, const std::string& callbackModule, const std::string& callbackMessage, const std::string& callbackMethod)
バージョン1.12から非推奨のため、callbackMessageパラメータのないバージョンをを使ってください。

イベントをサブスクライブし、すでに実行されていない場合イベントを生成することが可能なモジュールを自動的にローンチします。callbackMessageパラメータのないバージョンを使ってください。

パラメータ:
name – サブスクライブするイベント名
callbackModule – 通知とともに呼びされるモジュールの名前
callbackMessage – DEPRECATED Messageが含まれる通知
callbackMethod – データが変わった際に呼びされるモジュールのメソッドの名前
void ALMemoryProxy::subscribeToMicroEvent(const std::string& name, const std::string& callbackModule, const std::string& callbackMessage, const std::string& callbackMethod)
microEventをサブスクライブします。例え新たな値が古い値と同じだとしても、データが更新された際には常にコールバックメソッドでsubscribedメソッドが通知されます。

パラメータ:
name – データの名前
callbackModule – 通知とともに呼びされるモジュールの名前
callbackMessage – 通知に含まれるメッセージ。複数のサブスクライブを明確にするために使用されることがあります。
callbackMethod – データが変わった際に呼びされるモジュールのメソッドの名前
詳細は以下のであげた例を参照してください。

C++ callback signature:

class MyModule : public AL::ALModule {
public:
void myCallback(const std::string &key, const AL::ALValue &value, const AL::ALValue &message);
};
Python callback signature:

# create python module
class MyModule(ALModule):
""" Mandatory docstring. comment needed to create a new python module """
def myCallback(self, key, value, message): """ Mandatory docstring. comment needed to create a bound method """ pass
void ALMemoryProxy::unregisterModuleReference(const std::string& moduleName)
モジュールがもう存在しないことをALMemoryProxyに知らせます。

パラメータ:
moduleName – 切り離されるモジュールの名前

&aname()
void ALMemoryProxy::unsubscribeToEvent(const std::string& name, const std::string& callbackModule)
モジュールを与えられたイベントからunsubscribeします。それ以上の通知は受け取りません。最後のsubscriberがunsubscribeしたらイベントを生成することが可能なモジュールは自動的に停止します。

パラメータ:
name – イベントの名前
callbackModule – サブスクライブする際に与えられたモジュールの名前

&aname()
void ALMemoryProxy::unsubscribeToMicroEvent(const std::string& name, const std::string& callbackModule)
指定されたイベントをunsubscribeします。さらなる通知は受け取りません。

パラメータ:
name – イベントの名前
callbackModule – サブスクライブする際に指定されたモジュールの名前

&aname()
qi::AnyObject ALMemoryProxy::subscriber(const std::string& name)
イベントを引き起こした際に引き起こされるsignalという名の信号とともにdynamic objectを返します。もしもイベントが存在しない場合はイベントが作られます。詳細はSubscribing to an event from ALMemoryを参照してください。

信号を接続した状態のままにするにはobjectをいかす必要があります。

パラメータ:
name – イベント名


Events

コメントをかく


ユーザーIDでかく場合はこちら

画像に記載されている文字を下のフォームに入力してください。

「http://」を含む投稿は禁止されています。

利用規約をご確認のうえご記入下さい

×

この広告は60日間更新がないwikiに表示されております。

Menu

NAOqi - Developer guide

Creating an application?

Programming for a living robot?

Other tutorials?

Choregraphe Suite?

どなたでも編集できます