Builder component of Data descriptor objects. Contains setter methods that allow for Data descriptor parameter configuration, and a build method that builds the Data descriptor. More...

Inheritance diagram for IDataDescriptorBuilder:

Collaboration diagram for IDataDescriptorBuilder:

Detailed Description

Builder component of Data descriptor objects. Contains setter methods that allow for Data descriptor parameter configuration, and a build method that builds the Data descriptor.

Public Member Functions
virtual ErrCode INTERFACE_FUNC	build (IDataDescriptor **dataDescriptor)=0
	Builds and returns a Data descriptor object using the currently set values of the Builder. More...

virtual ErrCode INTERFACE_FUNC	setName (IString *name)=0
	Sets a descriptive name for the signal's value. More...

virtual ErrCode INTERFACE_FUNC	getName (IString **name)=0
	Gets a descriptive name for the signal's value. More...

virtual ErrCode INTERFACE_FUNC	setDimensions (IList *dimensions)=0
	Sets the list of the descriptor's dimension's. More...

virtual ErrCode INTERFACE_FUNC	getDimensions (IList **dimensions)=0
	Gets the list of the descriptor's dimension's. More...

virtual ErrCode INTERFACE_FUNC	setSampleType (SampleType sampleType)=0
	Sets the descriptor's sample type. More...

virtual ErrCode INTERFACE_FUNC	getSampleType (SampleType *sampleType)=0
	Gets the descriptor's sample type. More...

virtual ErrCode INTERFACE_FUNC	setUnit (IUnit *unit)=0
	Sets the unit of the data in a signal's packets. More...

virtual ErrCode INTERFACE_FUNC	getUnit (IUnit **unit)=0
	Gets the unit of the data in a signal's packets. More...

virtual ErrCode INTERFACE_FUNC	setValueRange (IRange *range)=0
	Sets the value range of the data in a signal's packets defining the lowest and highest expected values. More...

virtual ErrCode INTERFACE_FUNC	getValueRange (IRange **range)=0
	Gets the value range of the data in a signal's packets defining the lowest and highest expected values. More...

virtual ErrCode INTERFACE_FUNC	setRule (IDataRule *rule)=0
	Sets the value Data rule. More...

virtual ErrCode INTERFACE_FUNC	getRule (IDataRule **rule)=0
	Gets the value Data rule. More...

virtual ErrCode INTERFACE_FUNC	setOrigin (IString *origin)=0
	Sets the absolute origin of a signal value component. More...

virtual ErrCode INTERFACE_FUNC	getOrigin (IString **origin)=0
	Gets the absolute origin of a signal value component. More...

virtual ErrCode INTERFACE_FUNC	setTickResolution (IRatio *tickResolution)=0
	Sets the Resolution which scales the an explicit or implicit value to the physical unit defined in `unit`. More...

virtual ErrCode INTERFACE_FUNC	getTickResolution (IRatio **tickResolution)=0
	Gets the Resolution which scales the an explicit or implicit value to the physical unit defined in `unit`. More...

virtual ErrCode INTERFACE_FUNC	setPostScaling (IScaling *scaling)=0
	Sets the scaling rule that needs to be applied to explicit/implicit data by readers. More...

virtual ErrCode INTERFACE_FUNC	getPostScaling (IScaling **scaling)=0
	Gets the scaling rule that needs to be applied to explicit/implicit data by readers. More...

virtual ErrCode INTERFACE_FUNC	setStructFields (IList *structFields)=0
	Sets the fields of the struct, forming a recursive value descriptor definition. More...

virtual ErrCode INTERFACE_FUNC	getStructFields (IList **structFields)=0
	Gets the fields of the struct, forming a recursive value descriptor definition. More...

virtual ErrCode INTERFACE_FUNC	setMetadata (IDict *metadata)=0
	Sets any extra metadata defined by the data descriptor. More...

virtual ErrCode INTERFACE_FUNC	getMetadata (IDict **metadata)=0
	Gets any extra metadata defined by the data descriptor. More...

virtual ErrCode INTERFACE_FUNC	setReferenceDomainInfo (IReferenceDomainInfo *referenceDomainInfo)=0
	Sets the Reference Domain Info. More...

virtual ErrCode INTERFACE_FUNC	getReferenceDomainInfo (IReferenceDomainInfo **referenceDomainInfo)=0
	Gets the Reference Domain Info. 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 ( IDataDescriptor ** dataDescriptor )

pure virtual

Builds and returns a Data descriptor object using the currently set values of the Builder.

Parameters

[out] dataDescriptor The built Data descriptor.

◆ getDimensions()

virtual ErrCode INTERFACE_FUNC getDimensions ( IList ** dimensions )

pure virtual

Gets the list of the descriptor's dimension's.

Parameters

[out] dimensions The list of dimensions.

◆ getMetadata()

virtual ErrCode INTERFACE_FUNC getMetadata ( IDict ** metadata )

pure virtual

Gets any extra metadata defined by the data descriptor.

Parameters

[out] metadata Additional metadata of the descriptor as a dictionary.

◆ getName()

virtual ErrCode INTERFACE_FUNC getName ( IString ** name )

pure virtual

Gets a descriptive name for the signal's value.

Parameters

[out] name The name of the signal value.

◆ getOrigin()

virtual ErrCode INTERFACE_FUNC getOrigin ( IString ** origin )

pure virtual

Gets the absolute origin of a signal value component.

Parameters

[out] origin The absolute origin.

◆ getPostScaling()

virtual ErrCode INTERFACE_FUNC getPostScaling ( IScaling ** scaling )

pure virtual

Gets the scaling rule that needs to be applied to explicit/implicit data by readers.

Parameters

[out] scaling The scaling rule.

◆ getReferenceDomainInfo()

virtual ErrCode INTERFACE_FUNC getReferenceDomainInfo ( IReferenceDomainInfo ** referenceDomainInfo )

pure virtual

Gets the Reference Domain Info.

Parameters

[out] referenceDomainInfo The Reference Domain Info.

If set, gives additional information about the reference domain.

◆ getRule()

virtual ErrCode INTERFACE_FUNC getRule ( IDataRule ** rule )

pure virtual

Gets the value Data rule.

Parameters

[out] rule The value Data rule.

◆ getSampleType()

virtual ErrCode INTERFACE_FUNC getSampleType ( SampleType * sampleType )

pure virtual

Gets the descriptor's sample type.

Parameters

[out] sampleType The descriptor's sample type.

◆ getStructFields()

virtual ErrCode INTERFACE_FUNC getStructFields ( IList ** structFields )

pure virtual

Gets the fields of the struct, forming a recursive value descriptor definition.

Parameters

[out] structFields The list of data descriptors forming the struct fields.

◆ getTickResolution()

virtual ErrCode INTERFACE_FUNC getTickResolution ( IRatio ** tickResolution )

pure virtual

Gets the Resolution which scales the an explicit or implicit value to the physical unit defined in unit.

Parameters

[out] tickResolution The Resolution.

◆ getUnit()

virtual ErrCode INTERFACE_FUNC getUnit ( IUnit ** unit )

pure virtual

Gets the unit of the data in a signal's packets.

Parameters

[out] unit The unit specified by the descriptor.

◆ getValueRange()

virtual ErrCode INTERFACE_FUNC getValueRange ( IRange ** range )

pure virtual

Gets the value range of the data in a signal's packets defining the lowest and highest expected values.

Parameters

[out] range The value range the signal's data.

◆ setDimensions()

virtual ErrCode INTERFACE_FUNC setDimensions ( IList * dimensions )

pure virtual

Sets the list of the descriptor's dimension's.

Parameters

dimensions The list of dimensions.

The number of dimensions defines the rank of the signal's data (eg. Vector, Matrix).

◆ setMetadata()

virtual ErrCode INTERFACE_FUNC setMetadata ( IDict * metadata )

pure virtual

Sets any extra metadata defined by the data descriptor.

Parameters

metadata Additional metadata of the descriptor as a dictionary.

All objects in the metadata dictionary must be serializable.

◆ setName()

virtual ErrCode INTERFACE_FUNC setName ( IString * name )

pure virtual

Sets a descriptive name for the signal's value.

Parameters

name	The name of the signal value.

When, for example, describing the amplitude values of spectrum data, the name would be Amplitude.

◆ setOrigin()

virtual ErrCode INTERFACE_FUNC setOrigin ( IString * origin )

pure virtual

Sets the absolute origin of a signal value component.

Parameters

origin The absolute origin.

An origin can be an arbitrary string that determines the starting point of the signal data. All explicit or implicit values are multiplied by the resolution and added to the origin to obtain absolute data instead of relative.

Most commonly a time epoch is used, in which case it should be formatted according to the ISO 8601 standard.

◆ setPostScaling()

virtual ErrCode INTERFACE_FUNC setPostScaling ( IScaling * scaling )

pure virtual

Sets the scaling rule that needs to be applied to explicit/implicit data by readers.

Parameters

scaling The scaling rule.

The OutputDataType of the rule matches the value descriptor's sample type. The InputDataType defines the sample type of either the explicit data in packet buffers, or the packet's implicit value's sample type.

◆ setReferenceDomainInfo()

virtual ErrCode INTERFACE_FUNC setReferenceDomainInfo ( IReferenceDomainInfo * referenceDomainInfo )

pure virtual

Sets the Reference Domain Info.

Parameters

referenceDomainInfo The Reference Domain Info.

If set, gives additional information about the reference domain.

◆ setRule()

virtual ErrCode INTERFACE_FUNC setRule ( IDataRule * rule )

pure virtual

Sets the value Data rule.

Parameters

rule	The value Data rule.

If explicit, the values will be contained in the packet buffer. Otherwise they are calculated using the packet parameter as the input into the rule.

◆ setSampleType()

virtual ErrCode INTERFACE_FUNC setSampleType ( SampleType sampleType )

pure virtual

Sets the descriptor's sample type.

Parameters

sampleType The descriptor's sample type.

◆ setStructFields()

virtual ErrCode INTERFACE_FUNC setStructFields ( IList * structFields )

pure virtual

Sets the fields of the struct, forming a recursive value descriptor definition.

Parameters

structFields The list of data descriptors forming the struct fields.

Contains a list of value descriptors, defining the data layout: the data described by the first DataDescriptor of the list is at the start, followed by the data described by the second and so on.

◆ setTickResolution()

virtual ErrCode INTERFACE_FUNC setTickResolution ( IRatio * tickResolution )

pure virtual

Sets the Resolution which scales the an explicit or implicit value to the physical unit defined in unit.

Parameters

tickResolution The Resolution.

◆ setUnit()

virtual ErrCode INTERFACE_FUNC setUnit ( IUnit * unit )

pure virtual

Sets the unit of the data in a signal's packets.

Parameters

unit	The unit specified by the descriptor.

◆ setValueRange()

virtual ErrCode INTERFACE_FUNC setValueRange ( IRange * range )

pure virtual

Sets the value range of the data in a signal's packets defining the lowest and highest expected values.

Parameters

range The value range the signal's data.

The range is not enforced by openDAQ.

	openDAQ Open data acquisition platform

Detailed Description

Public Member Functions

Member Function Documentation

◆ build()

◆ getDimensions()

◆ getMetadata()

◆ getName()

◆ getOrigin()

◆ getPostScaling()

◆ getReferenceDomainInfo()

◆ getRule()

◆ getSampleType()

◆ getStructFields()

◆ getTickResolution()

◆ getUnit()

◆ getValueRange()

◆ setDimensions()

◆ setMetadata()

◆ setName()

◆ setOrigin()

◆ setPostScaling()

◆ setReferenceDomainInfo()

◆ setRule()

◆ setSampleType()

◆ setStructFields()

◆ setTickResolution()

◆ setUnit()

◆ setValueRange()