r3oraw

Class

real/frio/r3oraw.h

Library

r3frio

Description:

Raw output setting class - a multi-channel base class

See Also

real/frio/r3output.h

Super Class

r3Output

R3CLID_OUTPUT

JavaScript

r3Rawoutputsettings

Class Identifier

R3CLID_RAWOUTPUTSETTINGS - 757

Methods

ENABLECHANNEL, DTCALLBACKENABLEC, DISABLECHANNEL, DISABLEALLCHANNEL, SETCHANNELSTORAGE, CLEARSTORAGETYPES, INSERTCHANNELLIST, SETNORMALVALUE, RENAMECHANNEL, SIGNED,

Attributes

ChannelList, ChannelCount, Channels, ChannelIndices, ChannelTypes, ChannelNormValues, ChannelSigns,

Registration

int R3RegisterRawOutputSettingsClass(R3APP *app);

R3RAWOSETM_ENABLECHANNEL

Method

ENABLECHANNEL

Identifier

R3RAWOSETM_ENABLECHANNEL

Param 1:

R3INT, storage type to use for the channel (if 0, default or previous value used)

Param 2:

char*, name of the channel. If NULL, default class defined channel name is used

Param 3:

R3INT, channel base class id

JavaScript

obj.ENABLECHANNEL(p1, p2, p3);

Description

Attempts to enable a channel and optionally defines the storage type for it. * If the channel was already enabled, the method only checks the old storage type * and the new given one and selects the more accurate one (if variable storage type supported). * If no storage type is defined, the default storage type as defined by R3CHCA_NormalStorageType * will be used.

R3RAWOSETM_DTCALLBACKENABLEC

Method

DTCALLBACKENABLEC

Identifier

R3RAWOSETM_DTCALLBACKENABLEC

Param 1:

R3INT, channel index

Param 2:

R3INT, channel clid

Param 3:

R3TAG*, tag list. See r3raw.h and R3RAWM_ENUMCHANNELS for more information.

JavaScript

obj.DTCALLBACKENABLEC(p1, p2, p3);

Description

Enables a channel using the parameters from RAWM_ENUMCHANNELS. * Can be used for building the channel list from an existing datatype object.

R3RAWOSETM_DISABLECHANNEL

Method

DISABLECHANNEL

Identifier

R3RAWOSETM_DISABLECHANNEL

Param 3:

char*, name of the channel

JavaScript

obj.DISABLECHANNEL(p3);

Description

disables a channel enabled by the previous method.

R3RAWOSETM_DISABLEALLCHANNEL

Method

DISABLEALLCHANNEL

Identifier

R3RAWOSETM_DISABLEALLCHANNEL

JavaScript

obj.DISABLEALLCHANNEL();

Description

disables all channels

R3RAWOSETM_SETCHANNELSTORAGE

Method

SETCHANNELSTORAGE

Identifier

R3RAWOSETM_SETCHANNELSTORAGE

Param 1:

char*, name of the channel

Param 3:

R3INT, storage type to use for the channel R3TID_BYTE-R3TID_FLOAT, see r3typids.h

JavaScript

obj.SETCHANNELSTORAGE(p1, p3);

Description

sets the storage type for a channel

R3RAWOSETM_CLEARSTORAGETYPES

Method

CLEARSTORAGETYPES

Identifier

R3RAWOSETM_CLEARSTORAGETYPES

JavaScript

obj.CLEARSTORAGETYPES();

Description

clears storage types of all channels. Storage types * of enabled channes must be then redefined before use !

R3RAWOSETM_INSERTCHANNELLIST

Method

INSERTCHANNELLIST

Identifier

R3RAWOSETM_INSERTCHANNELLIST

Param 3:

R3LIST, a list of R3RAYNODEs (see r3output.h)

JavaScript

obj.INSERTCHANNELLIST(p3);

Description

Adds all channels of a R3RAYNODE list to the object

R3RAWOSETM_SETNORMALVALUE

Method

SETNORMALVALUE

Identifier

R3RAWOSETM_SETNORMALVALUE

Param 1:

char*, name of the channel

Param 3:

R3INT, normvalue.

JavaScript

obj.SETNORMALVALUE(p1, p3);

Description

sets the 'normal value' for a channel

R3RAWOSETM_RENAMECHANNEL

Method

RENAMECHANNEL

Identifier

R3RAWOSETM_RENAMECHANNEL

Param 1:

char*, old name of the channel

Param 3:

char*, new name of the channel

JavaScript

obj.RENAMECHANNEL(p1, p3);

Description

changes a channel name

R3RAWOSETM_SIGNED

Method

SIGNED

Identifier

R3RAWOSETM_SIGNED

Param 1:

char*, name of the channel

Param 3:

R3BOOL, if TRUE channel values are treated as signed units.

JavaScript

obj.SIGNED(p1, p3);

Description

sets the signed/unsigned state for a channel

ChannelList

Attribute

ChannelList

Identifier

R3RAWOSETA_ChannelList

JavaScript type

r3List

C type

R3LIST*

Description

see R3RAWCHANNEL node below

Syntax

value = jsobj.GetChannelList();

R3LIST* value;
R3GetAttrs(r3obj, R3RAWOSETA_ChannelList, &value, R3TAG_END);

ChannelCount

Attribute

ChannelCount

Identifier

R3RAWOSETA_ChannelCount

JavaScript type

Integer

C type

R3INT

Description

read only, number of channels included

Syntax

jsobj.SetChannelCount(value);
value = jsobj.GetChannelCount();

R3INT value = ...;
R3SetAttrs(r3obj, R3RAWOSETA_ChannelCount, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3RAWOSETA_ChannelCount, &value, R3TAG_END);

Channels

Attribute

Channels

Identifier

R3RAWOSETA_Channels

JavaScript type

Integer

C type

R3INT*

Description

read only attribute for reading the included channel clids to R3INT array

Syntax

jsobj.SetChannels(value);
value = jsobj.GetChannels();

R3INT* value = ...;
R3SetAttrs(r3obj, R3RAWOSETA_Channels, value, R3TAG_END);
R3INT* value;
R3GetAttrs(r3obj, R3RAWOSETA_Channels, &value, R3TAG_END);

ChannelIndices

Attribute

ChannelIndices

Identifier

R3RAWOSETA_ChannelIndices

JavaScript type

Integer

C type

R3INT*

Description

read only attribute for reading the included channel indices to R3INT array

Syntax

value = jsobj.GetChannelIndices();

R3INT* value;
R3GetAttrs(r3obj, R3RAWOSETA_ChannelIndices, &value, R3TAG_END);

ChannelTypes

Attribute

ChannelTypes

Identifier

R3RAWOSETA_ChannelTypes

JavaScript type

Integer

C type

R3INT*

Description

read only attribute for reading the included channel typeids to R3INT array

Syntax

jsobj.SetChannelTypes(value);
value = jsobj.GetChannelTypes();

R3INT* value = ...;
R3SetAttrs(r3obj, R3RAWOSETA_ChannelTypes, value, R3TAG_END);
R3INT* value;
R3GetAttrs(r3obj, R3RAWOSETA_ChannelTypes, &value, R3TAG_END);

ChannelNormValues

Attribute

ChannelNormValues

Identifier

R3RAWOSETA_ChannelNormValues

JavaScript type

Integer

C type

R3INT*

Description

read only attribute for reading the included channel norm values to R3INT array

Syntax

value = jsobj.GetChannelNormValues();

R3INT* value;
R3GetAttrs(r3obj, R3RAWOSETA_ChannelNormValues, &value, R3TAG_END);

ChannelSigns

Attribute

ChannelSigns

Identifier

R3RAWOSETA_ChannelSigns

JavaScript type

String

C type

R3BYTE*

Description

read only attribute for reading the included channel signs to R3BYTE array

Syntax

value = jsobj.GetChannelSigns();

R3BYTE* value;
R3GetAttrs(r3obj, R3RAWOSETA_ChannelSigns, &value, R3TAG_END);