IComponentType Struct Reference

Provides information about the component types. More...

Inheritance diagram for IComponentType:

Collaboration diagram for IComponentType:

Detailed Description

Provides information about the component types.

Is a Struct core type, and has access to Struct methods internally. Note that the Default config is not part of the Struct fields.

Public Member Functions
virtual ErrCode INTERFACE_FUNC	getId (IString **id)=0
	Gets the unique component type id. More...
virtual ErrCode INTERFACE_FUNC	getName (IString **name)=0
	Gets the user-friendly name of a component type. More...
virtual ErrCode INTERFACE_FUNC	getDescription (IString **description)=0
	Gets the description of a component type. More...
virtual ErrCode INTERFACE_FUNC	createDefaultConfig (IPropertyObject **defaultConfig)=0
	The function clones and returns default configuration. On each call, we need to create new object, because we want that each instance of the component has its own configuration object. More...
Public Member Functions inherited from IBaseObject
virtual ErrCode INTERFACE_FUNC	borrowInterface (const IntfID &intfID, void **obj) const =0
	Returns another interface which is supported by the object without incrementing the reference count. More...
virtual ErrCode INTERFACE_FUNC	dispose ()=0
	Disposes all references held by the object. More...
virtual ErrCode INTERFACE_FUNC	getHashCode (SizeT *hashCode)=0
	Returns hash code of the object. More...
virtual ErrCode INTERFACE_FUNC	equals (IBaseObject *other, Bool *equal) const =0
	Compares object to another object for equality. More...
virtual ErrCode INTERFACE_FUNC	toString (CharPtr *str)=0
	Returns a string representation of the object. More...
Public Member Functions inherited from IUnknown
virtual ErrCode INTERFACE_FUNC	queryInterface (const IntfID &intfID, void **obj)=0
	Returns another interface which is supported by the object and increments the reference count. More...
virtual int INTERFACE_FUNC	addRef ()=0
	Increments the reference count for an interface on an object. More...
virtual int INTERFACE_FUNC	releaseRef ()=0
	Decrements the reference count for an interface on an object. More...

Member Function Documentation

createDefaultConfig()

virtual ErrCode INTERFACE_FUNC createDefaultConfig ( IPropertyObject **  defaultConfig )

pure virtual

The function clones and returns default configuration. On each call, we need to create new object, because we want that each instance of the component has its own configuration object.

Parameters

[out]

defaultConfig

Newly created configuration object.

Configuration objects are property object with user-defined key-value pairs. For example: Port=1000, OutputRate=5000, ...

getDescription()

virtual ErrCode INTERFACE_FUNC getDescription ( IString **  description )

pure virtual

Gets the description of a component type.

Parameters

[out]

description

The description of a component type.

A short description of a component type and the associated configuration parameters it offers.

getId()

virtual ErrCode INTERFACE_FUNC getId ( IString **  id )

pure virtual

Gets the unique component type id.

Parameters

[out]

id

The unique id of a component type.

Unique id should not be presented on the UI.

getName()

virtual ErrCode INTERFACE_FUNC getName ( IString **  name )

pure virtual

Gets the user-friendly name of a component type.

Parameters

[out]

name

The user-friendly name of a component type.

Name is usually presented on the UI. Does not have to be unique.