Builder component of Component type objects. Contains setter methods to configure the Component type parameters, and a build method that builds the object. More...

Inheritance diagram for IComponentTypeBuilder:

Collaboration diagram for IComponentTypeBuilder:

Detailed Description

Builder component of Component type objects. Contains setter methods to configure the Component type parameters, and a build method that builds the object.

Depending on the set "Type" builder parameter, a different Component type is created - eg. Streaming type, Device type, Function block type, or Server type

Public Member Functions
virtual ErrCode INTERFACE_FUNC	build (IComponentType **componentType)=0
	Builds and returns a Component type object using the currently set values of the Builder. More...

virtual ErrCode INTERFACE_FUNC	setId (IString *id)=0
	Sets the unique component type id. More...

virtual ErrCode INTERFACE_FUNC	getId (IString **id)=0
	Gets the unique component type id. More...

virtual ErrCode INTERFACE_FUNC	setTypeSort (ComponentTypeSort sort)=0
	Sets the component type sort. Can be either Streaming, Function block, Device, or Server. Depending on the setting, the corresponding Component type object will be built. More...

virtual ErrCode INTERFACE_FUNC	getTypeSort (ComponentTypeSort *sort)=0
	Gets the component type sort. Can be either Streaming, Function block, Device, or Server. Depending on the setting, the corresponding Component type object will be built. More...

virtual ErrCode INTERFACE_FUNC	setName (IString *name)=0
	Sets the user-friendly name of a component type. More...

virtual ErrCode INTERFACE_FUNC	getName (IString **name)=0
	Gets the user-friendly name of a component type. More...

virtual ErrCode INTERFACE_FUNC	setDescription (IString *description)=0
	Sets the description 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	setDefaultConfig (IPropertyObject *defaultConfig)=0
	Sets the default configuration object that will be cloned and passed to users by the built Component type when requested. More...

virtual ErrCode INTERFACE_FUNC	getDefaultConfig (IPropertyObject **defaultConfig)=0
	Gets the default configuration object that will be cloned and passed to users by the built Component type when requested. 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

◆ build()

virtual ErrCode INTERFACE_FUNC build ( IComponentType ** componentType )

pure virtual

Builds and returns a Component type object using the currently set values of the Builder.

Parameters

[out] componentType The built Component type.

Depending on the set "sort" builder parameter, a different Component type is created - eg. Streaming type, Device type, Function block type, or Server type

◆ getDefaultConfig()

virtual ErrCode INTERFACE_FUNC getDefaultConfig ( IPropertyObject ** defaultConfig )

pure virtual

Gets the default configuration object that will be cloned and passed to users by the built Component type when requested.

Parameters

[out] defaultConfig The default 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.

◆ getTypeSort()

virtual ErrCode INTERFACE_FUNC getTypeSort ( ComponentTypeSort * sort )

pure virtual

Gets the component type sort. Can be either Streaming, Function block, Device, or Server. Depending on the setting, the corresponding Component type object will be built.

Parameters

sort	The sort of the component type.

◆ setDefaultConfig()

virtual ErrCode INTERFACE_FUNC setDefaultConfig ( IPropertyObject * defaultConfig )

pure virtual

Sets the default configuration object that will be cloned and passed to users by the built Component type when requested.

Parameters

defaultConfig The default configuration object.

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

◆ setDescription()

virtual ErrCode INTERFACE_FUNC setDescription ( IString * description )

pure virtual

Sets the description of a component type.

Parameters

description The description of a component type.

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

◆ setId()

virtual ErrCode INTERFACE_FUNC setId ( IString * id )

pure virtual

Sets the unique component type id.

Parameters

id	The unique id of a component type.

Unique id should not be presented on the UI.

◆ setName()

virtual ErrCode INTERFACE_FUNC setName ( IString * name )

pure virtual

Sets the user-friendly name of a component type.

Parameters

name	The user-friendly name of a component type.

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

◆ setTypeSort()

virtual ErrCode INTERFACE_FUNC setTypeSort ( ComponentTypeSort sort )

pure virtual

Sets the component type sort. Can be either Streaming, Function block, Device, or Server. Depending on the setting, the corresponding Component type object will be built.

Parameters

sort	The sort of the component type.

	openDAQ Open data acquisition platform

Detailed Description

Public Member Functions

Member Function Documentation

◆ build()

◆ getDefaultConfig()

◆ getDescription()

◆ getId()

◆ getName()

◆ getTypeSort()

◆ setDefaultConfig()

◆ setDescription()

◆ setId()

◆ setName()

◆ setTypeSort()