webservices/model_soap.h File Reference

#import "stl.h"

Typedefs
typedef unsigned long	xsd__unsignedInt
typedef unsigned long long	xsd__unsignedLong
Functions
int	Authenticate (char *_userName, char *_password, int &token)
	Authenticates your ip to the system.
int	SignOff (int _token, int &result)
	Terminates a session.
int	ApartmentCreateSetFromGroup (int _token, char *_groupName, std::string &result)
	Creates a set containing all devices which are contained in a group named _groupName.
int	ApartmentCreateSetFromDeviceIDs (int _token, std::vector< std::string > _ids, std::string &result)
	Creates a set containing all devices in the given array.
int	ApartmentCreateSetFromDeviceNames (int _token, std::vector< std::string > _names, std::string &result)
	Creates a set containing all devices in the given array.
int	ApartmentGetDevices (int _token, std::string &result)
	Creates a set containing all devices.
int	ApartmentGetDeviceIDByName (int _token, char *_deviceName, std::string &deviceID)
	Returns the device ID for the given _deviceName.
int	SetAddDeviceByName (int _token, char *_setSpec, char *_name, std::string &result)
	Adds the given device to the set.
int	SetAddDeviceByID (int _token, char *_setSpec, char *_deviceID, std::string &result)
	Adds the given device to the set.
int	SetRemoveDevice (int _token, char *_setSpec, char *_deviceID, std::string &result)
	Removes the device from the set.
int	SetCombine (int _token, char *_setSpec1, char *_setSpec2, std::string &result)
	Combines two sets into another set.
int	SetRemove (int _token, char *_setSpec, char *_setSpecToRemove, std::string &result)
	Removes all devices contained in _SetIDToRemove from _setID and copies those into setID.
int	SetByGroup (int _token, char *_setSpec, int _groupID, std::string &result)
	Removes all devices which don't belong to the specified group.
int	SetGetContainedDevices (int _token, char *_setSpec, std::vector< std::string > &deviceIDs)
	Returns an array containing all device ids contained in the given set.
int	ApartmentGetGroupByName (int _token, char *_groupName, int &groupID)
	Looks up the group id for the given group name.
int	ApartmentGetZoneByName (int _token, char *_zoneName, int &zoneID)
	Looks up the zone id for the given zone.
int	ApartmentGetZoneIDs (int _token, std::vector< int > &zoneIDs)
	Returns an array containing all zone ids.
int	SetTurnOn (int _token, char *_setSpec, bool &result)
	Sends a turn on command to all devices contained in the set.
int	SetTurnOff (int _token, char *_setSpec, bool &result)
	Sends a turn off command to all devices contained in the set.
int	SetIncreaseValue (int _token, char *_setSpec, bool &result)
	Increases the main value (e.g.
int	SetDecreaseValue (int _token, char *_setSpec, bool &result)
	Decreases the main value (e.g.
int	SetStartDim (int _token, char *_setSpec, bool _directionUp, bool &result)
	Starts dimming the main parameter (e.g.
int	SetEndDim (int _token, char *_setSpec, bool &result)
	Stops dimming on all devices contained in the set.
int	SetSetValue (int _token, char *_setSpec, double _value, bool &result)
	Sets the parameter specified by _paramID to _value.
int	SetCallScene (int _token, char *_setSpec, int _sceneNr, bool &result)
	Calls the scene _sceneNr on all devices contained int the set _setID.
int	SetSaveScene (int _token, char *_setSpec, int _sceneNr, bool &result)
	Saves the scene _sceneNr on all devices contained int the set _setID.
int	ApartmentTurnOn (int _token, int _groupID, bool &result)
	Sends a turn on command to all devices contained in the group.
int	ApartmentTurnOff (int _token, int _groupID, bool &result)
	Sends a turn off command to all devices contained in the group.
int	ApartmentIncreaseValue (int _token, int _groupID, bool &result)
	Increases the main value (e.g.
int	ApartmentDecreaseValue (int _token, int _groupID, bool &result)
	Decreases the main value (e.g.
int	ApartmentStartDim (int _token, int _groupID, bool _directionUp, bool &result)
	Starts dimming the main parameter on all devices contained in the group.
int	ApartmentEndDim (int _token, int _groupID, bool &result)
	Stops dimming the given parameter on all devices contained in the group.
int	ApartmentSetValue (int _token, int _groupID, double _value, bool &result)
	Sets the parameter specified by _paramID to _value.
int	ApartmentCallScene (int _token, int _groupID, int _sceneNr, bool &result)
	Calls the scene _sceneNr on all devices contained int the group _groupID.
int	ApartmentSaveScene (int _token, int _groupID, int _sceneNr, bool &result)
	Saves the scene _sceneNr on all devices contained int the group _groupID.
int	ApartmentRescan (int _token, bool &result)
	Rescans the bus for new devices/circuits.
int	CircuitRescan (int _token, char *_dsid, bool &result)
	Rescans the circuit for new/lost devices.
int	ZoneTurnOn (int _token, int _zoneID, int _groupID, bool &result)
	Sends a turn on command to all devices contained in the zone/group.
int	ZoneTurnOff (int _token, int _zoneID, int _groupID, bool &result)
	Sends a turn off command to all devices contained in the group.
int	ZoneIncreaseValue (int _token, int _zoneID, int _groupID, bool &result)
	Increases the main value (e.g.
int	ZoneDecreaseValue (int _token, int _zoneID, int _groupID, bool &result)
	Decreases the main value (e.g.
int	ZoneStartDim (int _token, int _zoneID, int _groupID, bool _directionUp, bool &result)
	Starts dimming the main parameter (e.g.
int	ZoneEndDim (int _token, int _zoneID, int _groupID, bool &result)
	Stops dimming on all devices contained in the zone/group.
int	ZoneSetValue (int _token, int _zoneID, int _groupID, double _value, bool &result)
	Sets the parameter specified by _paramID to _value.
int	ZoneCallScene (int _token, int _zoneID, int _groupID, int _sceneNr, bool &result)
	Calls the scene _sceneNr on all devices contained int the zone/group _groupID.
int	ZoneSaveScene (int _token, int _zoneID, int _groupID, int _sceneNr, bool &result)
	Saves the scene _sceneNr on all devices contained int the zone/group _groupID.
int	DeviceTurnOn (int _token, char *_deviceID, bool &result)
	Sends a turn on command to the device.
int	DeviceTurnOff (int _token, char *_deviceID, bool &result)
	Sends a turn off command to the device.
int	DeviceIncreaseValue (int _token, char *_deviceID, bool &result)
	Increases the main value (e.g.
int	DeviceDecreaseValue (int _token, char *_deviceID, bool &result)
	Decreases the main value (e.g.
int	DeviceEnable (int _token, char *_deviceID, bool &result)
	Enables the device.
int	DeviceDisable (int _token, char *_deviceID, bool &result)
	Disables the device.
int	DeviceStartDim (int _token, char *_deviceID, bool _directionUp, bool &result)
	Starts dimming the main parameter (e.g.
int	DeviceEndDim (int _token, char *_deviceID, bool &result)
	Stops dimming.
int	DeviceSetValue (int _token, char *_deviceID, double _value, bool &result)
	Sets the value of the parameter _paramID to _value.
int	DeviceGetValue (int _token, char *_deviceID, int _paramID, double &result)
	Returns the value of the parameter _paramID.
int	DeviceCallScene (int _token, char *_deviceID, int _sceneNr, bool &result)
	Calls the scene _sceneNr on the device identified by _deviceID.
int	DeviceSaveScene (int _token, char *_deviceID, int _sceneNr, bool &result)
	Saves the scene _sceneNr on the device identified by _devicdID.
int	DeviceGetName (int _token, char *_deviceID, char **result)
	Returns the name of a device.
int	DeviceGetZoneID (int _token, char *_deviceID, int &result)
	Returns the zone id of the specified device.
int	DSMeterGetPowerConsumption (int _token, int _dsMeterID, xsd__unsignedInt &result)
int	ApartmentGetDSMeterIDs (int _token, std::vector< std::string > &ids)
	Returns an integer array of dsMeters known to the dss.
int	DSMeterGetName (int _token, char *_dsMeterID, std::string &name)
	Retuns the name of the given dsMeter.
int	ApartmentAllocateZone (int _token, int &zoneID)
	Allocates a zone.
int	ApartmentDeleteZone (int _token, int _zoneID, int &result)
	Deletes a previously allocated zone.
int	Zone_AddDevice (int _token, int _zoneID, char *_deviceID, int &result)
	Adds a device to a zone.
int	Zone_RemoveDevice (int _token, int _zoneID, char *_deviceID, int &result)
	Removes a device from a zone.
int	Zone_SetName (int _token, int _zoneID, char *_name, int &result)
	Sets the name of a zone to _name.
int	ApartmentAllocateUserGroup (int _token, int &groupID)
	Allocates a user-defined group.
int	GroupRemoveUserGroup (int _token, int _groupID, int &result)
	Revmoes a previously allocated group.
int	GroupAddDevice (int _token, int _groupID, char *_deviceID, int &result)
	Adds a device to the given group.
int	GroupRemoveDevice (int _token, int _groupID, char *_deviceID, int &result)
	Removes a device from the given group.
int	DeviceGetFunctionID (int _token, char *_deviceID, int &result)
	Returns the function id of the specified device.
int	SwitchGetGroupID (int _token, char *_deviceID, int &result)
	Returns the group id of the specified switch.
int	EventRaise (int _token, char *_eventName, char *_context, char *_parameter, char *_location, bool &result)
int	EventWaitFor (int _token, int _timeout, std::vector< Event > &result)
int	EventSubscribeTo (int _token, std::string _name, std::string &result)
int	PropertyGetType (int _token, std::string _propertyName, std::string &result)
int	PropertySetInt (int _token, std::string _propertyName, int _value, bool _mayCreate=true, bool &result)
int	PropertySetString (int _token, std::string _propertyName, char *_value, bool _mayCreate=true, bool &result)
int	PropertySetBool (int _token, std::string _propertyName, bool _value, bool _mayCreate=true, bool &result)
int	PropertyGetInt (int _token, std::string _propertyName, int &result)
int	PropertyGetString (int _token, std::string _propertyName, std::string &result)
int	PropertyGetBool (int _token, std::string _propertyName, bool &result)
int	PropertyGetChildren (int _token, std::string _propertyName, std::vector< std::string > &result)

---

Detailed Description

---

Function Documentation

int ApartmentAllocateUserGroup	(	int	_token,
		int &	groupID
	)

Allocates a user-defined group.

int ApartmentCallScene	(	int	_token,
		int	_groupID,
		int	_sceneNr,
		bool &	result
	)

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

int ApartmentCreateSetFromDeviceIDs	(	int	_token,
		std::vector< std::string >	_ids,
		std::string &	result
	)

Creates a set containing all devices in the given array.

See also:

CreateEmptySet

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

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

See also:

CreateEmptySet

int ApartmentDecreaseValue	(	int	_token,
		int	_groupID,
		bool &	result
	)

Decreases the main value (e.g.

brightness) for each device contained in the group.

int ApartmentDeleteZone	(	int	_token,
		int	_zoneID,
		int &	result
	)

Deletes a previously allocated zone.

int ApartmentEndDim	(	int	_token,
		int	_groupID,
		bool &	result
	)

Stops dimming the given parameter on all devices contained in the group.

int ApartmentGetDSMeterIDs	(	int	_token,
		std::vector< std::string > &	ids
	)

Returns an integer array of dsMeters known to the dss.

int ApartmentIncreaseValue	(	int	_token,
		int	_groupID,
		bool &	result
	)

Increases the main value (e.g.

brightness) for each device contained in the group.

int ApartmentSaveScene	(	int	_token,
		int	_groupID,
		int	_sceneNr,
		bool &	result
	)

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

int ApartmentSetValue	(	int	_token,
		int	_groupID,
		double	_value,
		bool &	result
	)

Sets the parameter specified by _paramID to _value.

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

int ApartmentStartDim	(	int	_token,
		int	_groupID,
		bool	_directionUp,
		bool &	result
	)

Starts dimming the main parameter on all devices contained in the group.

If _directionUp is true, the dimming will increase the parameter.

int Authenticate	(	char *	_userName,
		char *	_password,
		int &	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 DeviceCallScene	(	int	_token,
		char *	_deviceID,
		int	_sceneNr,
		bool &	result
	)

Calls the scene _sceneNr on the device identified by _deviceID.

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

Decreases the main value (e.g.

brightness) on the device.

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

Disables the device.

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

Enables the device.

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

Stops dimming.

int DeviceGetValue	(	int	_token,
		char *	_deviceID,
		int	_paramID,
		double &	result
	)

Returns the value of the parameter _paramID.

If _paramID == -1 the value of the default parameter will be returned.

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

Increases the main value (e.g.

brightness) on the device.

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

Saves the scene _sceneNr on the device identified by _devicdID.

int DeviceSetValue	(	int	_token,
		char *	_deviceID,
		double	_value,
		bool &	result
	)

Sets the value of the parameter _paramID to _value.

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

int DeviceStartDim	(	int	_token,
		char *	_deviceID,
		bool	_directionUp,
		bool &	result
	)

Starts dimming the main parameter (e.g.

brightness). If _directionUp is true, the dimming will increase the parameter.

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

Sends a turn off command to the device.

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

Sends a turn on command to the device.

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

Retuns the name of the given dsMeter.

int GroupAddDevice	(	int	_token,
		int	_groupID,
		char *	_deviceID,
		int &	result
	)

Adds a device to the given group.

int GroupRemoveDevice	(	int	_token,
		int	_groupID,
		char *	_deviceID,
		int &	result
	)

Removes a device from the given group.

int GroupRemoveUserGroup	(	int	_token,
		int	_groupID,
		int &	result
	)

Revmoes a previously allocated group.

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

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

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

Decreases the main value (e.g.

brightness) for each device contained in the set.

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

Stops dimming on all devices contained in the set.

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

Increases the main value (e.g.

brightness) for each device contained in the set.

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

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

int SetSetValue	(	int	_token,
		char *	_setSpec,
		double	_value,
		bool &	result
	)

Sets the parameter specified by _paramID to _value.

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

int SetStartDim	(	int	_token,
		char *	_setSpec,
		bool	_directionUp,
		bool &	result
	)

Starts dimming the main parameter (e.g.

brightness) on all devices contained in the set. If _directionUp is true, the dimming will increase the parameter

int SignOff	(	int	_token,
		int &	result
	)

Terminates a session.

All resources allocate by the session will be released.

int ZoneCallScene	(	int	_token,
		int	_zoneID,
		int	_groupID,
		int	_sceneNr,
		bool &	result
	)

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

int ZoneDecreaseValue	(	int	_token,
		int	_zoneID,
		int	_groupID,
		bool &	result
	)

Decreases the main value (e.g.

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

int ZoneEndDim	(	int	_token,
		int	_zoneID,
		int	_groupID,
		bool &	result
	)

Stops dimming on all devices contained in the zone/group.

int ZoneIncreaseValue	(	int	_token,
		int	_zoneID,
		int	_groupID,
		bool &	result
	)

Increases the main value (e.g.

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

int ZoneSaveScene	(	int	_token,
		int	_zoneID,
		int	_groupID,
		int	_sceneNr,
		bool &	result
	)

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

int ZoneSetValue	(	int	_token,
		int	_zoneID,
		int	_groupID,
		double	_value,
		bool &	result
	)

Sets the parameter specified by _paramID to _value.

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

int ZoneStartDim	(	int	_token,
		int	_zoneID,
		int	_groupID,
		bool	_directionUp,
		bool &	result
	)

Starts dimming the main parameter (e.g.

brightness) on all devices contained in the group/zone. If _directionUp is true, the dimming will increase the parameter.