webservices/model_soap.h File Reference

#import "stl.h"

Go to the source code of this file.

Typedefs
typedef unsigned long	xsd__unsignedInt
typedef unsigned long long	xsd__unsignedLong
Functions
int	dss__Authenticate (char *_userName, char *_password, std::string &token)
	Authenticates your ip to the system.
int	dss__SignOff (char *_token, int &result)
	Terminates a session.
int	dss__ApartmentCreateSetFromGroup (char *_token, char *_groupName, std::string &result)
	Creates a set containing all devices which are contained in a group named _groupName.
int	dss__ApartmentCreateSetFromDeviceIDs (char *_token, std::vector< std::string > _ids, std::string &result)
	Creates a set containing all devices in the given array.
int	dss__ApartmentCreateSetFromDeviceNames (char *_token, std::vector< std::string > _names, std::string &result)
	Creates a set containing all devices in the given array.
int	dss__ApartmentGetDevices (char *_token, std::string &result)
	Creates a set containing all devices.
int	dss__ApartmentGetDeviceIDByName (char *_token, char *_deviceName, std::string &deviceID)
	Returns the device ID for the given _deviceName.
int	dss__ApartmentGetName (char *_token, std::string &result)
int	dss__ApartmentSetName (char *_token, char *_name, bool &result)
int	dss__SetAddDeviceByName (char *_token, char *_setSpec, char *_name, std::string &result)
	Adds the given device to the set.
int	dss__SetAddDeviceByID (char *_token, char *_setSpec, char *_deviceID, std::string &result)
	Adds the given device to the set.
int	dss__SetRemoveDevice (char *_token, char *_setSpec, char *_deviceID, std::string &result)
	Removes the device from the set.
int	dss__SetCombine (char *_token, char *_setSpec1, char *_setSpec2, std::string &result)
	Combines two sets into another set.
int	dss__SetRemove (char *_token, char *_setSpec, char *_setSpecToRemove, std::string &result)
	Removes all devices contained in _SetIDToRemove from _setID and copies those into setID.
int	dss__SetByGroup (char *_token, char *_setSpec, int _groupID, std::string &result)
	Removes all devices which don't belong to the specified group.
int	dss__SetGetContainedDevices (char *_token, char *_setSpec, std::vector< std::string > &deviceIDs)
	Returns an array containing all device ids contained in the given set.
int	dss__ApartmentGetGroupByName (char *_token, char *_groupName, int &groupID)
	Looks up the group id for the given group name.
int	dss__ApartmentGetZoneByName (char *_token, char *_zoneName, int &zoneID)
	Looks up the zone id for the given zone.
int	dss__ApartmentGetZoneIDs (char *_token, std::vector< int > &zoneIDs)
	Returns an array containing all zone ids.
int	dss__SetTurnOn (char *_token, char *_setSpec, bool &result)
	Sends a turn on command to all devices contained in the set.
int	dss__SetTurnOff (char *_token, char *_setSpec, bool &result)
	Sends a turn off command to all devices contained in the set.
int	dss__SetIncreaseValue (char *_token, char *_setSpec, bool &result)
	Increases the main value (e.g.
int	dss__SetDecreaseValue (char *_token, char *_setSpec, bool &result)
	Decreases the main value (e.g.
int	dss__SetSetValue (char *_token, char *_setSpec, unsigned char _value, bool &result)
	Sets the parameter specified by _paramID to _value.
int	dss__SetCallScene (char *_token, char *_setSpec, int _sceneNr, bool &result)
	Calls the scene _sceneNr on all devices contained int the set _setID.
int	dss__SetSaveScene (char *_token, char *_setSpec, int _sceneNr, bool &result)
	Saves the scene _sceneNr on all devices contained int the set _setID.
int	dss__ApartmentTurnOn (char *_token, int _groupID, bool &result)
	Sends a turn on command to all devices contained in the group.
int	dss__ApartmentTurnOff (char *_token, int _groupID, bool &result)
	Sends a turn off command to all devices contained in the group.
int	dss__ApartmentIncreaseValue (char *_token, int _groupID, bool &result)
	Increases the main value (e.g.
int	dss__ApartmentDecreaseValue (char *_token, int _groupID, bool &result)
	Decreases the main value (e.g.
int	dss__ApartmentSetValue (char *_token, int _groupID, unsigned char _value, bool &result)
	Sets the parameter specified by _paramID to _value.
int	dss__ApartmentCallScene (char *_token, int _groupID, int _sceneNr, bool &result)
	Calls the scene _sceneNr on all devices contained int the group _groupID.
int	dss__ApartmentSaveScene (char *_token, int _groupID, int _sceneNr, bool &result)
	Saves the scene _sceneNr on all devices contained int the group _groupID.
int	dss__ApartmentRescan (char *_token, bool &result)
	Rescans the bus for new devices/circuits.
int	dss__CircuitRescan (char *_token, char *_dsid, bool &result)
	Rescans the circuit for new/lost devices.
int	dss__ZoneTurnOn (char *_token, int _zoneID, int _groupID, bool &result)
	Sends a turn on command to all devices contained in the zone/group.
int	dss__ZoneTurnOff (char *_token, int _zoneID, int _groupID, bool &result)
	Sends a turn off command to all devices contained in the group.
int	dss__ZoneIncreaseValue (char *_token, int _zoneID, int _groupID, bool &result)
	Increases the main value (e.g.
int	dss__ZoneDecreaseValue (char *_token, int _zoneID, int _groupID, bool &result)
	Decreases the main value (e.g.
int	dss__ZoneSetValue (char *_token, int _zoneID, int _groupID, unsigned char _value, bool &result)
	Sets the parameter specified by _paramID to _value.
int	dss__ZoneCallScene (char *_token, int _zoneID, int _groupID, int _sceneNr, bool &result)
	Calls the scene _sceneNr on all devices contained int the zone/group _groupID.
int	dss__ZoneSaveScene (char *_token, int _zoneID, int _groupID, int _sceneNr, bool &result)
	Saves the scene _sceneNr on all devices contained int the zone/group _groupID.
int	dss__DeviceTurnOn (char *_token, char *_deviceID, bool &result)
	Sends a turn on command to the device.
int	dss__DeviceTurnOff (char *_token, char *_deviceID, bool &result)
	Sends a turn off command to the device.
int	dss__DeviceIncreaseValue (char *_token, char *_deviceID, bool &result)
	Increases the main value (e.g.
int	dss__DeviceDecreaseValue (char *_token, char *_deviceID, bool &result)
	Decreases the main value (e.g.
int	dss__DeviceSetValue (char *_token, char *_deviceID, unsigned char _value, bool &result)
	Set main value (e.g.
int	dss__DeviceSetConfig (char *_token, char *_deviceID, unsigned char _configClass, unsigned char _configIndex, unsigned char _value, bool &result)
	Sets the configuration value of the given config class and config index.
int	dss__DeviceGetConfig (char *_token, char *_deviceID, unsigned char _configClass, unsigned char _configIndex, unsigned char &result)
	Returns configuration value of the given config class and config index.
int	dss__DeviceGetConfigWord (char *_token, char *_deviceID, unsigned char _configClass, unsigned char _configIndex, unsigned short int &result)
	Returns configuration value of the given config class and config index.
int	dss__DeviceCallScene (char *_token, char *_deviceID, int _sceneNr, bool &result)
	Calls the scene _sceneNr on the device identified by _deviceID.
int	dss__DeviceSaveScene (char *_token, char *_deviceID, int _sceneNr, bool &result)
	Saves the scene _sceneNr on the device identified by _devicdID.
int	dss__DeviceGetName (char *_token, char *_deviceID, char **result)
	Returns the name of a device.
int	dss__DeviceSetName (char *_token, char *_deviceID, char *_name, bool &result)
	Sets the name of a device.
int	dss__DeviceGetZoneID (char *_token, char *_deviceID, int &result)
	Returns the zone id of the specified device.
int	dss__DeviceAddTag (char *_token, char *_deviceID, char *_tag, bool &result)
int	dss__DeviceRemoveTag (char *_token, char *_deviceID, char *_tag, bool &result)
int	dss__DeviceHasTag (char *_token, char *_deviceID, char *_tag, bool &result)
int	dss__DeviceGetTags (char *_token, char *_deviceID, std::vector< std::string > &result)
int	dss__DeviceLock (char *_token, char *_deviceID, bool &result)
int	dss__DeviceUnlock (char *_token, char *_deviceID, bool &result)
int	dss__DeviceGetIsLocked (char *_token, char *_deviceID, bool &result)
int	dss__DSMeterGetPowerConsumption (char *_token, char *_dsMeterID, xsd__unsignedInt &result)
int	dss__ApartmentGetDSMeterIDs (char *_token, std::vector< std::string > &ids)
	Returns an integer array of dsMeters known to the dss.
int	dss__DSMeterGetName (char *_token, char *_dsMeterID, std::string &name)
	Retuns the name of the given dsMeter.
int	dss__DSMeterSetName (char *_token, char *_dsMeterID, char *_name, bool &result)
	Sets the name of the given dsMeter.
int	dss__ApartmentAllocateZone (char *_token, int &zoneID)
	Allocates a zone.
int	dss__ApartmentDeleteZone (char *_token, int _zoneID, int &result)
	Deletes a previously allocated zone.
int	dss__ZoneSetName (char *_token, int _zoneID, char *_name, bool &result)
	Sets the name of a zone to _name.
int	dss__ZoneGetName (char *_token, int _zoneID, std::string &result)
	Returns the name of a zone.
int	dss__GroupSetName (char *_token, int _zoneID, int _groupID, char *_name, bool &result)
int	dss__GroupGetName (char *_token, int _zoneID, int _groupID, std::string &result)
int	dss__DeviceGetFunctionID (char *_token, char *_deviceID, int &result)
	Returns the function id of the specified device.
int	dss__EventRaise (char *_token, char *_eventName, char *_context, char *_parameter, char *_location, bool &result)
int	dss__EventWaitFor (char *_token, int _timeout, std::vector< dss__Event > &result)
int	dss__EventSubscribeTo (char *_token, std::string _name, std::string &result)
int	dss__PropertyGetType (char *_token, std::string _propertyName, std::string &result)
int	dss__PropertySetInt (char *_token, std::string _propertyName, int _value, bool _mayCreate=true, bool &result)
int	dss__PropertySetString (char *_token, std::string _propertyName, char *_value, bool _mayCreate=true, bool &result)
int	dss__PropertySetBool (char *_token, std::string _propertyName, bool _value, bool _mayCreate=true, bool &result)
int	dss__PropertyGetInt (char *_token, std::string _propertyName, int &result)
int	dss__PropertyGetString (char *_token, std::string _propertyName, std::string &result)
int	dss__PropertyGetBool (char *_token, std::string _propertyName, bool &result)
int	dss__PropertyGetChildren (char *_token, std::string _propertyName, std::vector< std::string > &result)
int	dss__StructureAddDeviceToZone (char *_token, char *_deviceID, int _zoneID, bool &result)

---

Detailed Description

---

Function Documentation

int dss__ApartmentCallScene	(	char *	_token,
		int	_groupID,
		int	_sceneNr,
		bool &	result
	)

Calls the scene _sceneNr on all devices contained int the group _groupID.

int dss__ApartmentCreateSetFromDeviceIDs	(	char *	_token,
		std::vector< std::string >	_ids,
		std::string &	result
	)

Creates a set containing all devices in the given array.

See also:

dss__CreateEmptySet

int dss__ApartmentCreateSetFromGroup	(	char *	_token,
		char *	_groupName,
		std::string &	result
	)

Creates a set containing all devices which are contained in a group named _groupName.

See also:

dss__CreateEmptySet

int dss__ApartmentDecreaseValue	(	char *	_token,
		int	_groupID,
		bool &	result
	)

Decreases the main value (e.g.

brightness) for each device contained in the group.

int dss__ApartmentDeleteZone	(	char *	_token,
		int	_zoneID,
		int &	result
	)

Deletes a previously allocated zone.

int dss__ApartmentGetDSMeterIDs	(	char *	_token,
		std::vector< std::string > &	ids
	)

Returns an integer array of dsMeters known to the dss.

int dss__ApartmentIncreaseValue	(	char *	_token,
		int	_groupID,
		bool &	result
	)

Increases the main value (e.g.

brightness) for each device contained in the group.

int dss__ApartmentSaveScene	(	char *	_token,
		int	_groupID,
		int	_sceneNr,
		bool &	result
	)

Saves the scene _sceneNr on all devices contained int the group _groupID.

int dss__ApartmentSetValue	(	char *	_token,
		int	_groupID,
		unsigned char	_value,
		bool &	result
	)

Sets the parameter specified by _paramID to _value.

If _paramID == -1 the default parameter will be set.

int dss__Authenticate	(	char *	_userName,
		char *	_password,
		std::string &	token
	)

Authenticates your ip to the system.

The token received will be used in any subsequent call. The ip/token pair identifies a session. A Session will time out after n minutes of no activity (default 5).

int dss__DeviceCallScene	(	char *	_token,
		char *	_deviceID,
		int	_sceneNr,
		bool &	result
	)

Calls the scene _sceneNr on the device identified by _deviceID.

int dss__DeviceDecreaseValue	(	char *	_token,
		char *	_deviceID,
		bool &	result
	)

Decreases the main value (e.g.

brightness) on the device.

int dss__DeviceIncreaseValue	(	char *	_token,
		char *	_deviceID,
		bool &	result
	)

Increases the main value (e.g.

brightness) on the device.

int dss__DeviceSaveScene	(	char *	_token,
		char *	_deviceID,
		int	_sceneNr,
		bool &	result
	)

Saves the scene _sceneNr on the device identified by _devicdID.

int dss__DeviceSetValue	(	char *	_token,
		char *	_deviceID,
		unsigned char	_value,
		bool &	result
	)

Set main value (e.g.

brightness) on the device.

int dss__DeviceTurnOff	(	char *	_token,
		char *	_deviceID,
		bool &	result
	)

Sends a turn off command to the device.

int dss__DeviceTurnOn	(	char *	_token,
		char *	_deviceID,
		bool &	result
	)

Sends a turn on command to the device.

int dss__DSMeterGetName	(	char *	_token,
		char *	_dsMeterID,
		std::string &	name
	)

Retuns the name of the given dsMeter.

int dss__DSMeterSetName	(	char *	_token,
		char *	_dsMeterID,
		char *	_name,
		bool &	result
	)

Sets the name of the given dsMeter.

int dss__SetCallScene	(	char *	_token,
		char *	_setSpec,
		int	_sceneNr,
		bool &	result
	)

Calls the scene _sceneNr on all devices contained int the set _setID.

int dss__SetDecreaseValue	(	char *	_token,
		char *	_setSpec,
		bool &	result
	)

Decreases the main value (e.g.

brightness) for each device contained in the set.

int dss__SetIncreaseValue	(	char *	_token,
		char *	_setSpec,
		bool &	result
	)

Increases the main value (e.g.

brightness) for each device contained in the set.

int dss__SetSaveScene	(	char *	_token,
		char *	_setSpec,
		int	_sceneNr,
		bool &	result
	)

Saves the scene _sceneNr on all devices contained int the set _setID.

int dss__SetSetValue	(	char *	_token,
		char *	_setSpec,
		unsigned char	_value,
		bool &	result
	)

Sets the parameter specified by _paramID to _value.

If _paramID == -1 the default parameter will be set.

int dss__SignOff	(	char *	_token,
		int &	result
	)

Terminates a session.

All resources allocate by the session will be released.

int dss__ZoneCallScene	(	char *	_token,
		int	_zoneID,
		int	_groupID,
		int	_sceneNr,
		bool &	result
	)

Calls the scene _sceneNr on all devices contained int the zone/group _groupID.

int dss__ZoneDecreaseValue	(	char *	_token,
		int	_zoneID,
		int	_groupID,
		bool &	result
	)

Decreases the main value (e.g.

brightness) for each device contained in the zone/group.

int dss__ZoneIncreaseValue	(	char *	_token,
		int	_zoneID,
		int	_groupID,
		bool &	result
	)

Increases the main value (e.g.

brightness) for each device contained in the zone/group.

int dss__ZoneSaveScene	(	char *	_token,
		int	_zoneID,
		int	_groupID,
		int	_sceneNr,
		bool &	result
	)

Saves the scene _sceneNr on all devices contained int the zone/group _groupID.

int dss__ZoneSetValue	(	char *	_token,
		int	_zoneID,
		int	_groupID,
		unsigned char	_value,
		bool &	result
	)

Sets the parameter specified by _paramID to _value.

If _paramID == -1 the default parameter will be set.