openDAQ
Open data acquisition platform
IDataRuleCalcPrivate Struct Referenceabstract

Internal functions used by openDAQ core. This interface should never be used in client SDK or module code. More...

+ Inheritance diagram for IDataRuleCalcPrivate:
+ Collaboration diagram for IDataRuleCalcPrivate:

Detailed Description

Internal functions used by openDAQ core. This interface should never be used in client SDK or module code.

Public Member Functions

virtual void *INTERFACE_FUNC calculateRule (const NumberPtr &packetOffset, SizeT sampleCount, void *input, SizeT inputSize) const =0
 Calculates the data according to the rule. More...
 
virtual void INTERFACE_FUNC calculateRule (const NumberPtr &packetOffset, SizeT sampleCount, void *input, SizeT inputSize, void **output) const =0
 Calculates the data according to the rule. More...
 
virtual void *INTERFACE_FUNC calculateSample (const NumberPtr &packetOffset, SizeT sampleIndex, void *input, SizeT inputSize) const =0
 Calculates the sample according to the rule. More...
 
virtual void INTERFACE_FUNC calculateSample (const NumberPtr &packetOffset, SizeT sampleIndex, void *input, SizeT inputSize, void **output) const =0
 Calculates the sample according to the rule. More...
 
virtual Bool INTERFACE_FUNC hasDataRuleCalc () const =0
 Checks whether the Data Rule Calculator is available for packet or not. 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

◆ calculateRule() [1/2]

virtual void* INTERFACE_FUNC calculateRule ( const NumberPtr packetOffset,
SizeT  sampleCount,
void *  input,
SizeT  inputSize 
) const
pure virtual

Calculates the data according to the rule.

Parameters
packetOffsetPacket offset.
sampleCountThe number of samples in the packet.
Returns
A pointer to the calculated data.

◆ calculateRule() [2/2]

virtual void INTERFACE_FUNC calculateRule ( const NumberPtr packetOffset,
SizeT  sampleCount,
void *  input,
SizeT  inputSize,
void **  output 
) const
pure virtual

Calculates the data according to the rule.

Parameters
packetOffsetPacket offset.
sampleCountThe number of samples in the packet.
[out]outputA pointer to the calculated data.

◆ calculateSample() [1/2]

virtual void* INTERFACE_FUNC calculateSample ( const NumberPtr packetOffset,
SizeT  sampleIndex,
void *  input,
SizeT  inputSize 
) const
pure virtual

Calculates the sample according to the rule.

Parameters
packetOffsetPacket offset.
sampleIndexThe index of sample in the packet.
Returns
A pointer to the calculated data.

◆ calculateSample() [2/2]

virtual void INTERFACE_FUNC calculateSample ( const NumberPtr packetOffset,
SizeT  sampleIndex,
void *  input,
SizeT  inputSize,
void **  output 
) const
pure virtual

Calculates the sample according to the rule.

Parameters
packetOffsetPacket offset.
sampleIndexThe index of sample in the packet.
[out]outputA pointer to the calculated data.

◆ hasDataRuleCalc()

virtual Bool INTERFACE_FUNC hasDataRuleCalc ( ) const
pure virtual

Checks whether the Data Rule Calculator is available for packet or not.

Returns
True if the Data Rule Calculator is initialized within the implementation; false otherwise.