Open Lighting Architecture
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
ola::rdm::RDMAPI Class Reference

Public Member Functions

 RDMAPI (class RDMAPIImplInterface *impl)
uint8_t OutstandingMessagesCount (const UID &uid)
bool GetProxiedDeviceCount (unsigned int universe, const UID &uid, SingleUseCallback3< void, const ResponseStatus &, uint16_t, bool > *callback, string *error)
bool GetProxiedDevices (unsigned int universe, const UID &uid, SingleUseCallback2< void, const ResponseStatus &, const vector< UID > & > *callback, string *error)
bool GetCommStatus (unsigned int universe, const UID &uid, SingleUseCallback4< void, const ResponseStatus &, uint16_t, uint16_t, uint16_t > *callback, string *error)
bool ClearCommStatus (unsigned int universe, const UID &uid, SingleUseCallback1< void, const ResponseStatus & > *callback, string *error)
bool GetQueuedMessage (unsigned int universe, const UID &uid, rdm_status_type status_type, QueuedMessageHandler *handler, string *error)
bool GetQueuedMessage (unsigned int universe, const UID &uid, rdm_status_type status_type, SingleUseCallback3< void, const ResponseStatus &, uint16_t, const string & > *callback, string *error)
bool GetStatusMessage (unsigned int universe, const UID &uid, rdm_status_type status_type, SingleUseCallback2< void, const ResponseStatus &, const vector< StatusMessage > & > *callback, string *error)
bool GetStatusIdDescription (unsigned int universe, const UID &uid, uint16_t status_id, SingleUseCallback2< void, const ResponseStatus &, const string & > *callback, string *error)
bool ClearStatusId (unsigned int universe, const UID &uid, uint16_t sub_device, SingleUseCallback1< void, const ResponseStatus & > *callback, string *error)
bool GetSubDeviceReporting (unsigned int universe, const UID &uid, uint16_t sub_device, SingleUseCallback2< void, const ResponseStatus &, uint8_t > *callback, string *error)
bool SetSubDeviceReporting (unsigned int universe, const UID &uid, uint16_t sub_device, rdm_status_type status_type, SingleUseCallback1< void, const ResponseStatus & > *callback, string *error)
bool GetSupportedParameters (unsigned int universe, const UID &uid, uint16_t sub_device, SingleUseCallback2< void, const ResponseStatus &, const vector< uint16_t > & > *callback, string *error)
bool GetParameterDescription (unsigned int universe, const UID &uid, uint16_t pid, SingleUseCallback2< void, const ResponseStatus &, const ParameterDescriptor & > *callback, string *error)
bool GetDeviceInfo (unsigned int universe, const UID &uid, uint16_t sub_device, SingleUseCallback2< void, const ResponseStatus &, const DeviceDescriptor & > *callback, string *error)
bool GetProductDetailIdList (unsigned int universe, const UID &uid, uint16_t sub_device, SingleUseCallback2< void, const ResponseStatus &, const vector< uint16_t > & > *callback, string *error)
bool GetDeviceModelDescription (unsigned int universe, const UID &uid, uint16_t sub_device, SingleUseCallback2< void, const ResponseStatus &, const string & > *callback, string *error)
bool GetManufacturerLabel (unsigned int universe, const UID &uid, uint16_t sub_device, SingleUseCallback2< void, const ResponseStatus &, const string & > *callback, string *error)
bool GetDeviceLabel (unsigned int universe, const UID &uid, uint16_t sub_device, SingleUseCallback2< void, const ResponseStatus &, const string & > *callback, string *error)
bool SetDeviceLabel (unsigned int universe, const UID &uid, uint16_t sub_device, const string &label, SingleUseCallback1< void, const ResponseStatus & > *callback, string *error)
bool GetFactoryDefaults (unsigned int universe, const UID &uid, uint16_t sub_device, SingleUseCallback2< void, const ResponseStatus &, bool > *callback, string *error)
bool ResetToFactoryDefaults (unsigned int universe, const UID &uid, uint16_t sub_device, SingleUseCallback1< void, const ResponseStatus & > *callback, string *error)
bool GetLanguageCapabilities (unsigned int universe, const UID &uid, uint16_t sub_device, SingleUseCallback2< void, const ResponseStatus &, const vector< string > & > *callback, string *error)
bool GetLanguage (unsigned int universe, const UID &uid, uint16_t sub_device, SingleUseCallback2< void, const ResponseStatus &, const string & > *callback, string *error)
bool SetLanguage (unsigned int universe, const UID &uid, uint16_t sub_device, const string &language, SingleUseCallback1< void, const ResponseStatus & > *callback, string *error)
bool GetSoftwareVersionLabel (unsigned int universe, const UID &uid, uint16_t sub_device, SingleUseCallback2< void, const ResponseStatus &, const string & > *callback, string *error)
bool GetBootSoftwareVersion (unsigned int universe, const UID &uid, uint16_t sub_device, SingleUseCallback2< void, const ResponseStatus &, uint32_t > *callback, string *error)
bool GetBootSoftwareVersionLabel (unsigned int universe, const UID &uid, uint16_t sub_device, SingleUseCallback2< void, const ResponseStatus &, const string & > *callback, string *error)
bool GetDMXPersonality (unsigned int universe, const UID &uid, uint16_t sub_device, SingleUseCallback3< void, const ResponseStatus &, uint8_t, uint8_t > *callback, string *error)
bool SetDMXPersonality (unsigned int universe, const UID &uid, uint16_t sub_device, uint8_t personality, SingleUseCallback1< void, const ResponseStatus & > *callback, string *error)
bool GetDMXPersonalityDescription (unsigned int universe, const UID &uid, uint16_t sub_device, uint8_t personality, SingleUseCallback4< void, const ResponseStatus &, uint8_t, uint16_t, const string & > *callback, string *error)
bool GetDMXAddress (unsigned int universe, const UID &uid, uint16_t sub_device, SingleUseCallback2< void, const ResponseStatus &, uint16_t > *callback, string *error)
bool SetDMXAddress (unsigned int universe, const UID &uid, uint16_t sub_device, uint16_t start_address, SingleUseCallback1< void, const ResponseStatus & > *callback, string *error)
bool GetSlotInfo (unsigned int universe, const UID &uid, uint16_t sub_device, SingleUseCallback2< void, const ResponseStatus &, const vector< SlotDescriptor > & > *callback, string *error)
bool GetSlotDescription (unsigned int universe, const UID &uid, uint16_t sub_device, uint16_t slot_offset, SingleUseCallback3< void, const ResponseStatus &, uint16_t, const string & > *callback, string *error)
bool GetSlotDefaultValues (unsigned int universe, const UID &uid, uint16_t sub_device, SingleUseCallback2< void, const ResponseStatus &, const vector< SlotDefault > & > *callback, string *error)
bool GetSensorDefinition (unsigned int universe, const UID &uid, uint16_t sub_device, uint8_t sensor_number, SingleUseCallback2< void, const ResponseStatus &, const SensorDescriptor & > *callback, string *error)
bool GetSensorValue (unsigned int universe, const UID &uid, uint16_t sub_device, uint8_t sensor_number, SingleUseCallback2< void, const ResponseStatus &, const SensorValueDescriptor & > *callback, string *error)
bool SetSensorValue (unsigned int universe, const UID &uid, uint16_t sub_device, uint8_t sensor_number, SingleUseCallback2< void, const ResponseStatus &, const SensorValueDescriptor & > *callback, string *error)
bool RecordSensors (unsigned int universe, const UID &uid, uint16_t sub_device, uint8_t sensor_number, SingleUseCallback1< void, const ResponseStatus & > *callback, string *error)
bool GetDeviceHours (unsigned int universe, const UID &uid, uint16_t sub_device, SingleUseCallback2< void, const ResponseStatus &, uint32_t > *callback, string *error)
bool SetDeviceHours (unsigned int universe, const UID &uid, uint16_t sub_device, uint32_t device_hours, SingleUseCallback1< void, const ResponseStatus & > *callback, string *error)
bool GetLampHours (unsigned int universe, const UID &uid, uint16_t sub_device, SingleUseCallback2< void, const ResponseStatus &, uint32_t > *callback, string *error)
bool SetLampHours (unsigned int universe, const UID &uid, uint16_t sub_device, uint32_t lamp_hours, SingleUseCallback1< void, const ResponseStatus & > *callback, string *error)
bool GetLampStrikes (unsigned int universe, const UID &uid, uint16_t sub_device, SingleUseCallback2< void, const ResponseStatus &, uint32_t > *callback, string *error)
bool SetLampStrikes (unsigned int universe, const UID &uid, uint16_t sub_device, uint32_t lamp_strikes, SingleUseCallback1< void, const ResponseStatus & > *callback, string *error)
bool GetLampState (unsigned int universe, const UID &uid, uint16_t sub_device, SingleUseCallback2< void, const ResponseStatus &, uint8_t > *callback, string *error)
bool SetLampState (unsigned int universe, const UID &uid, uint16_t sub_device, uint8_t lamp_state, SingleUseCallback1< void, const ResponseStatus & > *callback, string *error)
bool GetLampMode (unsigned int universe, const UID &uid, uint16_t sub_device, SingleUseCallback2< void, const ResponseStatus &, uint8_t > *callback, string *error)
bool SetLampMode (unsigned int universe, const UID &uid, uint16_t sub_device, uint8_t lamp_mode, SingleUseCallback1< void, const ResponseStatus & > *callback, string *error)
bool GetDevicePowerCycles (unsigned int universe, const UID &uid, uint16_t sub_device, SingleUseCallback2< void, const ResponseStatus &, uint32_t > *callback, string *error)
bool SetDevicePowerCycles (unsigned int universe, const UID &uid, uint16_t sub_device, uint32_t power_cycles, SingleUseCallback1< void, const ResponseStatus & > *callback, string *error)
bool GetDisplayInvert (unsigned int universe, const UID &uid, uint16_t sub_device, SingleUseCallback2< void, const ResponseStatus &, uint8_t > *callback, string *error)
bool SetDisplayInvert (unsigned int universe, const UID &uid, uint16_t sub_device, uint8_t display_invert, SingleUseCallback1< void, const ResponseStatus & > *callback, string *error)
bool GetDisplayLevel (unsigned int universe, const UID &uid, uint16_t sub_device, SingleUseCallback2< void, const ResponseStatus &, uint8_t > *callback, string *error)
bool SetDisplayLevel (unsigned int universe, const UID &uid, uint16_t sub_device, uint8_t display_level, SingleUseCallback1< void, const ResponseStatus & > *callback, string *error)
bool GetPanInvert (unsigned int universe, const UID &uid, uint16_t sub_device, SingleUseCallback2< void, const ResponseStatus &, uint8_t > *callback, string *error)
bool SetPanInvert (unsigned int universe, const UID &uid, uint16_t sub_device, uint8_t invert, SingleUseCallback1< void, const ResponseStatus & > *callback, string *error)
bool GetTiltInvert (unsigned int universe, const UID &uid, uint16_t sub_device, SingleUseCallback2< void, const ResponseStatus &, uint8_t > *callback, string *error)
bool SetTiltInvert (unsigned int universe, const UID &uid, uint16_t sub_device, uint8_t invert, SingleUseCallback1< void, const ResponseStatus & > *callback, string *error)
bool GetPanTiltSwap (unsigned int universe, const UID &uid, uint16_t sub_device, SingleUseCallback2< void, const ResponseStatus &, uint8_t > *callback, string *error)
bool SetPanTiltSwap (unsigned int universe, const UID &uid, uint16_t sub_device, uint8_t swap, SingleUseCallback1< void, const ResponseStatus & > *callback, string *error)
bool GetClock (unsigned int universe, const UID &uid, uint16_t sub_device, SingleUseCallback2< void, const ResponseStatus &, const ClockValue & > *callback, string *error)
bool SetClock (unsigned int universe, const UID &uid, uint16_t sub_device, const ClockValue &clock, SingleUseCallback1< void, const ResponseStatus & > *callback, string *error)
bool GetIdentifyMode (unsigned int universe, const UID &uid, uint16_t sub_device, SingleUseCallback2< void, const ResponseStatus &, bool > *callback, string *error)
bool IdentifyDevice (unsigned int universe, const UID &uid, uint16_t sub_device, bool mode, SingleUseCallback1< void, const ResponseStatus & > *callback, string *error)
bool ResetDevice (unsigned int universe, const UID &uid, uint16_t sub_device, bool warm_reset, SingleUseCallback1< void, const ResponseStatus & > *callback, string *error)
bool GetPowerState (unsigned int universe, const UID &uid, uint16_t sub_device, SingleUseCallback2< void, const ResponseStatus &, uint8_t > *callback, string *error)
bool SetPowerState (unsigned int universe, const UID &uid, uint16_t sub_device, rdm_power_state power_state, SingleUseCallback1< void, const ResponseStatus & > *callback, string *error)
bool SetResetDevice (unsigned int universe, const UID &uid, uint16_t sub_device, rdm_reset_device_mode reset_device, SingleUseCallback1< void, const ResponseStatus & > *callback, string *error)
bool SelfTestEnabled (unsigned int universe, const UID &uid, uint16_t sub_device, SingleUseCallback2< void, const ResponseStatus &, bool > *callback, string *error)
bool PerformSelfTest (unsigned int universe, const UID &uid, uint16_t sub_device, uint8_t self_test_number, SingleUseCallback1< void, const ResponseStatus & > *callback, string *error)
bool SelfTestDescription (unsigned int universe, const UID &uid, uint16_t sub_device, uint8_t self_test_number, SingleUseCallback3< void, const ResponseStatus &, uint8_t, const string & > *callback, string *error)
bool CapturePreset (unsigned int universe, const UID &uid, uint16_t sub_device, uint16_t scene, uint16_t fade_up_time, uint16_t fade_down_time, uint16_t wait_time, SingleUseCallback1< void, const ResponseStatus & > *callback, string *error)
bool PresetPlaybackMode (unsigned int universe, const UID &uid, uint16_t sub_device, SingleUseCallback3< void, const ResponseStatus &, uint16_t, uint8_t > *callback, string *error)
bool SetPresetPlaybackMode (unsigned int universe, const UID &uid, uint16_t sub_device, uint16_t playback_mode, uint8_t level, SingleUseCallback1< void, const ResponseStatus & > *callback, string *error)
void _HandleLabelResponse (SingleUseCallback2< void, const ResponseStatus &, const string & > *callback, const ResponseStatus &status, const string &data)
void _HandleBoolResponse (SingleUseCallback2< void, const ResponseStatus &, bool > *callback, const ResponseStatus &status, const string &data)
void _HandleU8Response (SingleUseCallback2< void, const ResponseStatus &, uint8_t > *callback, const ResponseStatus &status, const string &data)
void _HandleU32Response (SingleUseCallback2< void, const ResponseStatus &, uint32_t > *callback, const ResponseStatus &status, const string &data)
void _HandleEmptyResponse (SingleUseCallback1< void, const ResponseStatus & > *callback, const ResponseStatus &status, const string &data)
void _HandleGetProxiedDeviceCount (SingleUseCallback3< void, const ResponseStatus &, uint16_t, bool > *callback, const ResponseStatus &status, const string &data)
void _HandleGetProxiedDevices (SingleUseCallback2< void, const ResponseStatus &, const vector< UID > & > *callback, const ResponseStatus &status, const string &data)
void _HandleGetCommStatus (SingleUseCallback4< void, const ResponseStatus &, uint16_t, uint16_t, uint16_t > *callback, const ResponseStatus &status, const string &data)
void _HandleQueuedMessage (QueuedMessageHandler *handler, const ResponseStatus &status, uint16_t pid, const string &data)
void _HandleGetStatusMessage (SingleUseCallback2< void, const ResponseStatus &, const vector< StatusMessage > & > *callback, const ResponseStatus &status, const string &data)
void _HandleGetSubDeviceReporting (SingleUseCallback2< void, const ResponseStatus &, uint8_t > *callback, const ResponseStatus &status, const string &data)
void _HandleGetSupportedParameters (SingleUseCallback2< void, const ResponseStatus &, const vector< uint16_t > & > *callback, const ResponseStatus &status, const string &data)
void _HandleGetParameterDescriptor (SingleUseCallback2< void, const ResponseStatus &, const ParameterDescriptor & > *callback, const ResponseStatus &status, const string &data)
void _HandleGetDeviceDescriptor (SingleUseCallback2< void, const ResponseStatus &, const DeviceDescriptor & > *callback, const ResponseStatus &status, const string &data)
void _HandleGetProductDetailIdList (SingleUseCallback2< void, const ResponseStatus &, const vector< uint16_t > & > *callback, const ResponseStatus &status, const string &data)
void _HandleGetLanguageCapabilities (SingleUseCallback2< void, const ResponseStatus &, const vector< string > & > *callback, const ResponseStatus &status, const string &data)
void _HandleGetLanguage (SingleUseCallback2< void, const ResponseStatus &, const string & > *callback, const ResponseStatus &status, const string &data)
void _HandleGetBootSoftwareVersion (SingleUseCallback2< void, const ResponseStatus &, uint32_t > *callback, const ResponseStatus &status, const string &data)
void _HandleGetDMXPersonality (SingleUseCallback3< void, const ResponseStatus &, uint8_t, uint8_t > *callback, const ResponseStatus &status, const string &data)
void _HandleGetDMXPersonalityDescription (SingleUseCallback4< void, const ResponseStatus &, uint8_t, uint16_t, const string & > *callback, const ResponseStatus &status, const string &data)
void _HandleGetDMXAddress (SingleUseCallback2< void, const ResponseStatus &, uint16_t > *callback, const ResponseStatus &status, const string &data)
void _HandleGetSlotInfo (SingleUseCallback2< void, const ResponseStatus &, const vector< SlotDescriptor > & > *callback, const ResponseStatus &status, const string &data)
void _HandleGetSlotDescription (SingleUseCallback3< void, const ResponseStatus &, uint16_t, const string & > *callback, const ResponseStatus &status, const string &data)
void _HandleGetSlotDefaultValues (SingleUseCallback2< void, const ResponseStatus &, const vector< SlotDefault > & > *callback, const ResponseStatus &status, const string &data)
void _HandleGetSensorDefinition (SingleUseCallback2< void, const ResponseStatus &, const SensorDescriptor & > *callback, const ResponseStatus &status, const string &data)
void _HandleSensorValue (SingleUseCallback2< void, const ResponseStatus &, const SensorValueDescriptor & > *callback, const ResponseStatus &status, const string &data)
void _HandleClock (SingleUseCallback2< void, const ResponseStatus &, const ClockValue & > *callback, const ResponseStatus &status, const string &data)
void _HandleSelfTestDescription (SingleUseCallback3< void, const ResponseStatus &, uint8_t, const string & > *callback, const ResponseStatus &status, const string &data)
void _HandlePlaybackMode (SingleUseCallback3< void, const ResponseStatus &, uint16_t, uint8_t > *callback, const ResponseStatus &status, const string &data)

Member Function Documentation

void ola::rdm::RDMAPI::_HandlePlaybackMode ( SingleUseCallback3< void, const ResponseStatus &, uint16_t, uint8_t > *  callback,
const ResponseStatus status,
const string &  data 
)

Handle a PID_PRESET_PLAYBACK response

void ola::rdm::RDMAPI::_HandleSelfTestDescription ( SingleUseCallback3< void, const ResponseStatus &, uint8_t, const string & > *  callback,
const ResponseStatus status,
const string &  data 
)

Handle a PID_SELF_TEST_DESCRIPTION response.

bool ola::rdm::RDMAPI::GetQueuedMessage ( unsigned int  universe,
const UID uid,
rdm_status_type  status_type,
QueuedMessageHandler handler,
string *  error 
)

Send a queued message request.

bool ola::rdm::RDMAPI::GetQueuedMessage ( unsigned int  universe,
const UID uid,
rdm_status_type  status_type,
SingleUseCallback3< void, const ResponseStatus &, uint16_t, const string & > *  callback,
string *  error 
)

Send a queued message request. When complete the callback will be run and it's up to the caller to decode the message based on the PID.


The documentation for this class was generated from the following files: