Collapse all Symbian^3 Product Developer Library

SsmCommandFactory Class Reference

class SsmCommandFactory

Public Member Functions
IMPORT_C MSsmCommand *	ConstructAMAStarterCommandLC(TCmdErrorSeverity, TSsmExecutionBehaviour, const TUid &)
IMPORT_C MSsmCommand *	ConstructAMAStarterCommandLC(TCmdErrorSeverity, TSsmExecutionBehaviour, const TUid &, const TUint16)
CSsmCommandBase *	ConstructCommandFromCommandLC(const MSsmCommand &, TArray< MSsmCommand * > &, CSsmCommandUtilProvider *)
CSsmCommandBase *	ConstructCommandFromResourceLC(TSsmCommandType, TSsmCommandParameters &)
CSsmCommandBase *	ConstructCommandFromStreamLC(TSsmCommandType, RReadStream &, TArray< MSsmCommand * > &)
IMPORT_C MSsmCommand *	ConstructCreateSwpCommandLC(TCmdErrorSeverity, const TSsmSwp &, TDesC &)
IMPORT_C MSsmCommand *	ConstructCreateSwpCommandLC(TCmdErrorSeverity, const TSsmSwp &, TDesC &, const TUint16)
IMPORT_C MSsmCommand *	ConstructCustomCommandCommandLC(TCmdErrorSeverity, TSsmExecutionBehaviour, CSsmCustomCommandInfo &)
IMPORT_C MSsmCommand *	ConstructCustomCommandCommandLC(TCmdErrorSeverity, TSsmExecutionBehaviour, CSsmCustomCommandInfo &, const TUint16)
IMPORT_C MSsmCommand *	ConstructFinaliseDrivesCommandLC(TCmdErrorSeverity)
IMPORT_C MSsmCommand *	ConstructLoadSupCommandLC(TCmdErrorSeverity, TSsmExecutionBehaviour, TInt, const TSsmSupInfo &)
IMPORT_C MSsmCommand *	ConstructLoadSupCommandLC(TCmdErrorSeverity, TSsmExecutionBehaviour, TInt, const TSsmSupInfo &, const TUint16)
IMPORT_C MSsmCommand *	ConstructMultipleWaitCommandLC(TInt32)
IMPORT_C MSsmCommand *	ConstructMultipleWaitCommandLC(TInt32, const TUint16)
IMPORT_C MSsmCommand *	ConstructPersistHalAttributesCommandLC(TCmdErrorSeverity)
IMPORT_C MSsmCommand *	ConstructPowerOffCommandLC(TCmdErrorSeverity, TPowerState)
IMPORT_C MSsmCommand *	ConstructPublishSwpCommandLC(TCmdErrorSeverity, TSsmExecutionBehaviour, const TSsmSwp &)
IMPORT_C MSsmCommand *	ConstructPublishSwpCommandLC(TCmdErrorSeverity, TSsmExecutionBehaviour, const TSsmSwp &, const TUint16)
IMPORT_C MSsmCommand *	ConstructPublishSystemStateCommandLC(TCmdErrorSeverity, TSsmExecutionBehaviour, TSsmPublishSystemStateInfo &)
IMPORT_C MSsmCommand *	ConstructPublishSystemStateCommandLC(TCmdErrorSeverity, TSsmExecutionBehaviour, TSsmPublishSystemStateInfo &, const TUint16)
IMPORT_C MSsmCommand *	ConstructReqSwpChangeCommandLC(TCmdErrorSeverity, TSsmExecutionBehaviour, const TSsmSwp &)
IMPORT_C MSsmCommand *	ConstructReqSwpChangeCommandLC(TCmdErrorSeverity, TSsmExecutionBehaviour, const TSsmSwp &, const TUint16)
IMPORT_C MSsmCommand *	ConstructSetPAndSKeyCommandLC(TCmdErrorSeverity, const TUid &, TUint, TInt)
IMPORT_C MSsmCommand *	ConstructSetPAndSKeyCommandLC(TCmdErrorSeverity, const TUid &, TUint, TInt, const TUint16)
IMPORT_C MSsmCommand *	ConstructStartApplicationCommandLC(TCmdErrorSeverity, CSsmStartupProperties *)
IMPORT_C MSsmCommand *	ConstructStartApplicationCommandLC(TCmdErrorSeverity, CSsmStartupProperties *, const TUint16)
IMPORT_C MSsmCommand *	ConstructStartProcessCommandLC(TCmdErrorSeverity, CSsmStartupProperties *)
IMPORT_C MSsmCommand *	ConstructStartProcessCommandLC(TCmdErrorSeverity, CSsmStartupProperties *, const TUint16)
IMPORT_C MSsmCommand *	ConstructWaitForApparcInitCommandLC(TCmdErrorSeverity)
IMPORT_C MSsmCommand *	ConstructWaitForApparcInitCommandLC(TCmdErrorSeverity, const TUint16)

Private Member Functions
	SsmCommandFactory()

Constructor & Destructor Documentation

SsmCommandFactory()

SsmCommandFactory

(

)

[private]

Member Functions Documentation

ConstructAMAStarterCommandLC(TCmdErrorSeverity, TSsmExecutionBehaviour, const TUid &)

IMPORT_C MSsmCommand *	ConstructAMAStarterCommandLC	(	TCmdErrorSeverity	aSeverity,
			TSsmExecutionBehaviour	aExecutionBehaviour,
			const TUid &	aDscId
		)	[static]

Constructs and returns a new AMA starter command.

KDefaultSymbianDsc

Parameters

TCmdErrorSeverity aSeverity	The severity to use for the returned command.
TSsmExecutionBehaviour aExecutionBehaviour	The execution behaviour of the command.
const TUid & aDscId	The UID of the DSC that this command should start.

ConstructAMAStarterCommandLC(TCmdErrorSeverity, TSsmExecutionBehaviour, const TUid &, const TUint16)

IMPORT_C MSsmCommand *	ConstructAMAStarterCommandLC	(	TCmdErrorSeverity	aSeverity,
			TSsmExecutionBehaviour	aExecutionBehaviour,
			const TUid &	aDscId,
			const TUint16	aPriority
		)	[static]

Constructs and returns a new AMA starter command.

KDefaultSymbianDsc

Parameters

TCmdErrorSeverity aSeverity	The severity to use for the returned command.
TSsmExecutionBehaviour aExecutionBehaviour	The execution behaviour of the command.
const TUid & aDscId	The UID of the DSC that this command should start.
const TUint16 aPriority	The priority of the command in the list

ConstructCommandFromCommandLC(const MSsmCommand &, TArray< MSsmCommand * > &, CSsmCommandUtilProvider *)

CSsmCommandBase *	ConstructCommandFromCommandLC	(	const MSsmCommand &	aSsmCommand,
			TArray< MSsmCommand * > &	aDeferredList,
			CSsmCommandUtilProvider *	aUtilProvider
		)	[static]

Factory function to create a command from a MSsmCommand object.

panic: ECmdBadCommand if the command type is invalid

TSsmCommandType

Parameters

const MSsmCommand & aSsmCommand	is reference of MSsmCommand which needs to be created.
TArray< MSsmCommand * > & aDeferredList	List of commands which has execution behaviour as ESsmDeferredWaitForSignal in command list. @param aUtilProvider CSsmCommandUtilProvider reference. Only few commands require CSsmCommandUtilProvider reference
CSsmCommandUtilProvider * aUtilProvider

ConstructCommandFromResourceLC(TSsmCommandType, TSsmCommandParameters &)

CSsmCommandBase *	ConstructCommandFromResourceLC	(	TSsmCommandType	aType,
			TSsmCommandParameters &	aCommandParameters
		)	[static]

Factory function to create a command from a resource.

panic: ECmdBadCommand if the command type is invalid

TSsmCommandType TSsmCommandParameters

Parameters

TSsmCommandType aType	Type of the command which needs to be created.
TSsmCommandParameters & aCommandParameters	Object data from a resource file

ConstructCommandFromStreamLC(TSsmCommandType, RReadStream &, TArray< MSsmCommand * > &)

CSsmCommandBase *	ConstructCommandFromStreamLC	(	TSsmCommandType	aType,
			RReadStream &	aReadStream,
			TArray< MSsmCommand * > &	aDeferredList
		)	[static]

Factory function to create a command from a stream.

panic: ECmdBadCommand if the command type is invalid

TSsmCommandType RReadStream

Parameters

TSsmCommandType aType	Type of the command which needs to be created.
RReadStream & aReadStream	Stream containing the data for the command.
TArray< MSsmCommand * > & aDeferredList	List of commands which has execution behaviour as ESsmDeferredWaitForSignal in command list.

ConstructCreateSwpCommandLC(TCmdErrorSeverity, const TSsmSwp &, TDesC &)

IMPORT_C MSsmCommand *	ConstructCreateSwpCommandLC	(	TCmdErrorSeverity	aSeverity,
			const TSsmSwp &	aSwp,
			TDesC &	aFilename
		)	[static]

Constructs and returns a new publish system state command.

This command should only be used by the current system state policy to publish a change in system state value.

Parameters

TCmdErrorSeverity aSeverity	The severity to use for the returned command.
const TSsmSwp & aSwp
TDesC & aFilename

ConstructCreateSwpCommandLC(TCmdErrorSeverity, const TSsmSwp &, TDesC &, const TUint16)

IMPORT_C MSsmCommand *	ConstructCreateSwpCommandLC	(	TCmdErrorSeverity	aSeverity,
			const TSsmSwp &	aSwp,
			TDesC &	aFilename,
			const TUint16	aPriority
		)	[static]

Constructs and returns a new publish system state command.

This command should only be used by the current system state policy to publish a change in system state value.

Parameters

TCmdErrorSeverity aSeverity	The severity to use for the returned command.
const TSsmSwp & aSwp
TDesC & aFilename
const TUint16 aPriority	The priority of the command in the list

ConstructCustomCommandCommandLC(TCmdErrorSeverity, TSsmExecutionBehaviour, CSsmCustomCommandInfo &)

IMPORT_C MSsmCommand *	ConstructCustomCommandCommandLC	(	TCmdErrorSeverity	aSeverity,
			TSsmExecutionBehaviour	aExecutionBehaviour,
			CSsmCustomCommandInfo &	aCustomInfo
		)	[static]

Constructs and returns a new custom command.

Parameters

TCmdErrorSeverity aSeverity	The severity to use for the returned command.
TSsmExecutionBehaviour aExecutionBehaviour	The execution behaviour of the command.
CSsmCustomCommandInfo & aCustomInfo	The properties of the custom command.

ConstructCustomCommandCommandLC(TCmdErrorSeverity, TSsmExecutionBehaviour, CSsmCustomCommandInfo &, const TUint16)

IMPORT_C MSsmCommand *	ConstructCustomCommandCommandLC	(	TCmdErrorSeverity	aSeverity,
			TSsmExecutionBehaviour	aExecutionBehaviour,
			CSsmCustomCommandInfo &	aCustomInfo,
			const TUint16	aPriority
		)	[static]

Constructs and returns a new custom command.

Parameters

TCmdErrorSeverity aSeverity	The severity to use for the returned command.
TSsmExecutionBehaviour aExecutionBehaviour	The execution behaviour of the command.
CSsmCustomCommandInfo & aCustomInfo	The properties of the custom command.
const TUint16 aPriority	The priority of the command in the list

ConstructFinaliseDrivesCommandLC(TCmdErrorSeverity)

IMPORT_C MSsmCommand *

ConstructFinaliseDrivesCommandLC

(

TCmdErrorSeverity

aSeverity

)

[static]

Constructs and returns a new finalise drives command.

Parameters

TCmdErrorSeverity aSeverity

The severity to use for the returned command.

ConstructLoadSupCommandLC(TCmdErrorSeverity, TSsmExecutionBehaviour, TInt, const TSsmSupInfo &)

IMPORT_C MSsmCommand *	ConstructLoadSupCommandLC	(	TCmdErrorSeverity	aSeverity,
			TSsmExecutionBehaviour	aExecutionBehaviour,
			TInt	aRetries,
			const TSsmSupInfo &	aInfo
		)	[static]

Constructs and returns a load SSM Utility Plugin command.

Parameters

TCmdErrorSeverity aSeverity	The severity to use for the returned command.
TSsmExecutionBehaviour aExecutionBehaviour	The execution behaviour of the command.
TInt aRetries	The number of times to attempt to load the specified SSM Utility Plugin.
const TSsmSupInfo & aInfo	The properties of the SSM Utility Plugin to load.

ConstructLoadSupCommandLC(TCmdErrorSeverity, TSsmExecutionBehaviour, TInt, const TSsmSupInfo &, const TUint16)

IMPORT_C MSsmCommand *	ConstructLoadSupCommandLC	(	TCmdErrorSeverity	aSeverity,
			TSsmExecutionBehaviour	aExecutionBehaviour,
			TInt	aRetries,
			const TSsmSupInfo &	aInfo,
			const TUint16	aPriority
		)	[static]

Constructs and returns a load SSM Utility Plugin command.

Parameters

TCmdErrorSeverity aSeverity	The severity to use for the returned command.
TSsmExecutionBehaviour aExecutionBehaviour	The execution behaviour of the command.
TInt aRetries	The number of times to attempt to load the specified SSM Utility Plugin.
const TSsmSupInfo & aInfo	The properties of the SSM Utility Plugin to load.
const TUint16 aPriority	The priority of the command in the list

ConstructMultipleWaitCommandLC(TInt32)

IMPORT_C MSsmCommand *

ConstructMultipleWaitCommandLC

(

TInt32

aTimeout

)

[static]

Constructs and returns a new multiple wait command.

Parameters

TInt32 aTimeout

Timeout in milliseconds for the multiple wait command to wait for.

ConstructMultipleWaitCommandLC(TInt32, const TUint16)

IMPORT_C MSsmCommand *	ConstructMultipleWaitCommandLC	(	TInt32	aTimeout,
			const TUint16	aPriority
		)	[static]

Constructs and returns a new multiple wait command.

Parameters

TInt32 aTimeout	Timeout in milliseconds for the multiple wait command to wait for.
const TUint16 aPriority	The priority of the command in the list

ConstructPersistHalAttributesCommandLC(TCmdErrorSeverity)

IMPORT_C MSsmCommand *

ConstructPersistHalAttributesCommandLC

(

TCmdErrorSeverity

aSeverity

)

[static]

Constructs and returns a new persist HAL attributes.

This command calls BaflUtils::PersistHAL().

Parameters

TCmdErrorSeverity aSeverity

The severity to use for the returned command.

ConstructPowerOffCommandLC(TCmdErrorSeverity, TPowerState)

IMPORT_C MSsmCommand *	ConstructPowerOffCommandLC	(	TCmdErrorSeverity	aSeverity,
			TPowerState	aPowerEvent
		)	[static]

Constructs and returns a new power off command.

Parameters

TCmdErrorSeverity aSeverity	The severity to use for the returned command.
TPowerState aPowerEvent	The type of power off event represented by the returned command.

ConstructPublishSwpCommandLC(TCmdErrorSeverity, TSsmExecutionBehaviour, const TSsmSwp &)

IMPORT_C MSsmCommand *	ConstructPublishSwpCommandLC	(	TCmdErrorSeverity	aSeverity,
			TSsmExecutionBehaviour	aExecutionBehaviour,
			const TSsmSwp &	aSwp
		)	[static]

Constructs and returns a new publish System-wide Property command.

This command should only be used by a System-wide Property policy to publish the System-wide Property value or values controlled by that policy.

Parameters

TCmdErrorSeverity aSeverity	The severity to use for the returned command.
TSsmExecutionBehaviour aExecutionBehaviour
const TSsmSwp & aSwp	The System-wide Property information.

ConstructPublishSwpCommandLC(TCmdErrorSeverity, TSsmExecutionBehaviour, const TSsmSwp &, const TUint16)

IMPORT_C MSsmCommand *	ConstructPublishSwpCommandLC	(	TCmdErrorSeverity	aSeverity,
			TSsmExecutionBehaviour	aExecutionBehaviour,
			const TSsmSwp &	aSwp,
			const TUint16	aPriority
		)	[static]

Constructs and returns a new publish System-wide Property command.

This command should only be used by a System-wide Property policy to publish the System-wide Property value or values controlled by that policy.

Parameters

TCmdErrorSeverity aSeverity	The severity to use for the returned command.
TSsmExecutionBehaviour aExecutionBehaviour
const TSsmSwp & aSwp	The System-wide Property information.
const TUint16 aPriority	The priority of the command in the list

ConstructPublishSystemStateCommandLC(TCmdErrorSeverity, TSsmExecutionBehaviour, TSsmPublishSystemStateInfo &)

IMPORT_C MSsmCommand *	ConstructPublishSystemStateCommandLC	(	TCmdErrorSeverity	aSeverity,
			TSsmExecutionBehaviour	aExecutionBehaviour,
			TSsmPublishSystemStateInfo &	aInfo
		)	[static]

Constructs and returns a new publish system state command.

This command should only be used by the current system state policy to publish a change in system state value.

Parameters

TCmdErrorSeverity aSeverity	The severity to use for the returned command.
TSsmExecutionBehaviour aExecutionBehaviour	The execution behaviour of the returned command.
TSsmPublishSystemStateInfo & aInfo	The system state information used in the returned command.

ConstructPublishSystemStateCommandLC(TCmdErrorSeverity, TSsmExecutionBehaviour, TSsmPublishSystemStateInfo &, const TUint16)

IMPORT_C MSsmCommand *	ConstructPublishSystemStateCommandLC	(	TCmdErrorSeverity	aSeverity,
			TSsmExecutionBehaviour	aExecutionBehaviour,
			TSsmPublishSystemStateInfo &	aInfo,
			const TUint16	aPriority
		)	[static]

Constructs and returns a new publish system state command.

This command should only be used by the current system state policy to publish a change in system state value.

Parameters

TCmdErrorSeverity aSeverity	The severity to use for the returned command.
TSsmExecutionBehaviour aExecutionBehaviour	The execution behaviour of the returned command.
TSsmPublishSystemStateInfo & aInfo	The system state information used in the returned command.
const TUint16 aPriority	The priority of the command in the list

ConstructReqSwpChangeCommandLC(TCmdErrorSeverity, TSsmExecutionBehaviour, const TSsmSwp &)

IMPORT_C MSsmCommand *	ConstructReqSwpChangeCommandLC	(	TCmdErrorSeverity	aSeverity,
			TSsmExecutionBehaviour	aExecutionBehaviour,
			const TSsmSwp &	aSwp
		)	[static]

Constructs and returns a new request System-wide Property change command.

This command will request a change to a System-wide Property, using the appropriate policy for the System-wide Property to determine required actions.

This is equivalent to calling RSsmStateManger::RequestSwpChange().

Parameters

TCmdErrorSeverity aSeverity	The severity to use for the returned command.
TSsmExecutionBehaviour aExecutionBehaviour	The execution behaviour of the returned command.
const TSsmSwp & aSwp	The System-wide Property information used in the returned command.

ConstructReqSwpChangeCommandLC(TCmdErrorSeverity, TSsmExecutionBehaviour, const TSsmSwp &, const TUint16)

IMPORT_C MSsmCommand *	ConstructReqSwpChangeCommandLC	(	TCmdErrorSeverity	aSeverity,
			TSsmExecutionBehaviour	aExecutionBehaviour,
			const TSsmSwp &	aSwp,
			const TUint16	aPriority
		)	[static]

Constructs and returns a new request System-wide Property change command.

This command will request a change to a System-wide Property, using the appropriate policy for the System-wide Property to determine required actions.

This is equivalent to calling RSsmStateManger::RequestSwpChange().

Parameters

TCmdErrorSeverity aSeverity	The severity to use for the returned command.
TSsmExecutionBehaviour aExecutionBehaviour	The execution behaviour of the returned command.
const TSsmSwp & aSwp	The System-wide Property information used in the returned command.
const TUint16 aPriority	The priority of the command in the list

ConstructSetPAndSKeyCommandLC(TCmdErrorSeverity, const TUid &, TUint, TInt)

IMPORT_C MSsmCommand *	ConstructSetPAndSKeyCommandLC	(	TCmdErrorSeverity	aSeverity,
			const TUid &	aCategory,
			TUint	aKey,
			TInt	aValue
		)	[static]

Constructs and returns a new set publish and subscribe key command.

Parameters

TCmdErrorSeverity aSeverity	The severity to use for the returned command.
const TUid & aCategory	The category of the P+S key to be set.
TUint aKey	The key value of the P+S key to be set.
TInt aValue	The value to set the P+S key to.

ConstructSetPAndSKeyCommandLC(TCmdErrorSeverity, const TUid &, TUint, TInt, const TUint16)

IMPORT_C MSsmCommand *	ConstructSetPAndSKeyCommandLC	(	TCmdErrorSeverity	aSeverity,
			const TUid &	aCategory,
			TUint	aKey,
			TInt	aValue,
			const TUint16	aPriority
		)	[static]

Constructs and returns a new set publish and subscribe key command.

Parameters

TCmdErrorSeverity aSeverity	The severity to use for the returned command.
const TUid & aCategory	The category of the P+S key to be set.
TUint aKey	The key value of the P+S key to be set.
TInt aValue	The value to set the P+S key to.
const TUint16 aPriority	The priority of the command in the list

ConstructStartApplicationCommandLC(TCmdErrorSeverity, CSsmStartupProperties *)

IMPORT_C MSsmCommand *	ConstructStartApplicationCommandLC	(	TCmdErrorSeverity	aSeverity,
			CSsmStartupProperties *	aStartupProperties
		)	[static]

Constructs and returns a new start application command.

Parameters

TCmdErrorSeverity aSeverity	The severity to use for the returned command.
CSsmStartupProperties * aStartupProperties	The properties of the started application. Ownership of this object is not transferred to the returned command.

ConstructStartApplicationCommandLC(TCmdErrorSeverity, CSsmStartupProperties *, const TUint16)

IMPORT_C MSsmCommand *	ConstructStartApplicationCommandLC	(	TCmdErrorSeverity	aSeverity,
			CSsmStartupProperties *	aStartupProperties,
			const TUint16	aPriority
		)	[static]

Constructs and returns a new start application command.

Parameters

TCmdErrorSeverity aSeverity	The severity to use for the returned command.
CSsmStartupProperties * aStartupProperties	The properties of the started application. Ownership of this object is not transferred to the returned command.
const TUint16 aPriority	The priority of the command in the list

ConstructStartProcessCommandLC(TCmdErrorSeverity, CSsmStartupProperties *)

IMPORT_C MSsmCommand *	ConstructStartProcessCommandLC	(	TCmdErrorSeverity	aSeverity,
			CSsmStartupProperties *	aStartupProperties
		)	[static]

Constructs and returns a new start process command.

Parameters

TCmdErrorSeverity aSeverity	The severity to use for the returned command.
CSsmStartupProperties * aStartupProperties	The properties of the started process. Ownership of this object is not transferred to the returned command.

ConstructStartProcessCommandLC(TCmdErrorSeverity, CSsmStartupProperties *, const TUint16)

IMPORT_C MSsmCommand *	ConstructStartProcessCommandLC	(	TCmdErrorSeverity	aSeverity,
			CSsmStartupProperties *	aStartupProperties,
			const TUint16	aPriority
		)	[static]

Constructs and returns a new start process command.

Parameters

TCmdErrorSeverity aSeverity	The severity to use for the returned command.
CSsmStartupProperties * aStartupProperties	The properties of the started process. Ownership of this object is not transferred to the returned command.
const TUint16 aPriority	The priority of the command in the list

ConstructWaitForApparcInitCommandLC(TCmdErrorSeverity)

IMPORT_C MSsmCommand *

ConstructWaitForApparcInitCommandLC

(

TCmdErrorSeverity

aSeverity

)

[static]

Constructs and returns a new wait for app-arc init command.

Parameters

TCmdErrorSeverity aSeverity

The severity to use for the returned command.

ConstructWaitForApparcInitCommandLC(TCmdErrorSeverity, const TUint16)

IMPORT_C MSsmCommand *	ConstructWaitForApparcInitCommandLC	(	TCmdErrorSeverity	aSeverity,
			const TUint16	aPriority
		)	[static]

Constructs and returns a new wait for app-arc init command.

Parameters

TCmdErrorSeverity aSeverity	The severity to use for the returned command.
const TUint16 aPriority	The priority of the command in the list