Difference between revisions of "Component: Base2dObject (Development)"

From Flowcode Help
Jump to navigationJump to search
(Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Steve Tandy |- | width="20%" style="color:gray;" | Version | 1.0 |- | width="20%" style="color:gra...")
 
Line 16: Line 16:
  
 
==Detailed description==
 
==Detailed description==
 +
 +
  
 
''No detailed description exists yet for this component''
 
''No detailed description exists yet for this component''
  
 
==Examples==
 
==Examples==
 +
 +
  
 
''<span style="color:red;">No additional examples</span>''
 
''<span style="color:red;">No additional examples</span>''
Line 173: Line 177:
 
|-
 
|-
 
| colspan="2" | The value of the data point&nbsp;
 
| colspan="2" | The value of the data point&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetList'''
 +
|-
 +
| colspan="2" | Returns CHANNEL or PRESCALE list from the FCD and updates the internal property &nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Name
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''InitRXConfig'''
 +
|-
 +
| colspan="2" | Initialization setting for RX Buffer Config&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Buffer
 +
|-
 +
| colspan="2" | Buffer Number (0 or 1)&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Value
 +
|-
 +
| colspan="2" | Config data byte&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Uninit'''
 +
|-
 +
| colspan="2" | Uninitialises the CAN, freeing its connections for general use &nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetList'''
 +
|-
 +
| colspan="2" | Get the Filter List of the Named Property&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Name
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetRxIdent'''
 +
|-
 +
| colspan="2" | Generic function to get the received message Identifier.  &nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | buffer
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetRxFilterStd'''
 +
|-
 +
| colspan="2" | Sets the 16-bit filter as a bit-mask of the standard ID for received messages The messages are accepted if (StdID & Mask) == Filter  &nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Filter
 +
|-
 +
| colspan="2" | Filter number&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Hi
 +
|-
 +
| colspan="2" | The high byte (bits 8-15) of the ID&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Lo
 +
|-
 +
| colspan="2" | The low byte (bits 0-7) of the ID&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetRxFilterExd'''
 +
|-
 +
| colspan="2" | Sets the 32-bit filter as a bit-mask of the extended ID for received messages The messages are accepted if (ExtID & Mask) == Filter &nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Filter
 +
|-
 +
| colspan="2" | Send filter: 0  to 3&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | ID3
 +
|-
 +
| colspan="2" | The high byte (bits 24-31) of the ID&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | ID2
 +
|-
 +
| colspan="2" | The mid-high byte (bits 16-23) of the ID&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | ID1
 +
|-
 +
| colspan="2" | The mid-low byte (bits 8-15) of the ID&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | ID0
 +
|-
 +
| colspan="2" | The low byte (bits 0-7) of the ID&nbsp;
 
|-
 
|-
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID

Revision as of 10:34, 17 November 2021

Author Steve Tandy
Version 1.0
Category Development


Base2dObject component

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Downloadable macro reference

Fc9-comp-macro.png GetValue
Returns the current value of the component. 
[[File:]] - Return


Fc9-comp-macro.png SetValue
Sets the component to the specified value. 
[[File:]] - value
A new value for the component. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetMode
Select the mode of operation 
[[File:]] - bUseArrays
True if data points are added to a hidden buffer; False if data is drawn directly onto chart. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ClearData
Removes all datapoints from the chart. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetValue
Sets the component to the specified value. 
[[File:]] - value
A new value for the component. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png RefreshChart
Redraws the chart. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png GetData
Gets a data point from the specified series. 
Fc9-u8-icon.png - BYTE Series
Which series to add to (1-8) 
[[File:]] - Index
The data point index (1 - 32767) 
[[File:]] - Return


Fc9-comp-macro.png AddDataCXYY1
Adds a data point to a bubble chart. 
Fc9-u8-icon.png - BYTE Series
Which series to add to (1-8) 
Fc9-string-icon.png - STRING Category
 
[[File:]] - Y
Y coordinate 
[[File:]] - X
X coordinate 
[[File:]] - Value
The value of the data point 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png GetList
Returns CHANNEL or PRESCALE list from the FCD and updates the internal property  
Fc9-string-icon.png - STRING Name
 
Fc9-string-icon.png - STRING Return


Fc9-comp-macro.png InitRXConfig
Initialization setting for RX Buffer Config 
Fc9-u8-icon.png - BYTE Buffer
Buffer Number (0 or 1) 
Fc9-u8-icon.png - BYTE Value
Config data byte 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Uninit
Uninitialises the CAN, freeing its connections for general use  
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png GetList
Get the Filter List of the Named Property 
Fc9-string-icon.png - STRING Name
 
Fc9-string-icon.png - STRING Return


Fc9-comp-macro.png GetRxIdent
Generic function to get the received message Identifier.  
Fc9-u8-icon.png - BYTE buffer
 
Fc9-u32-icon.png - ULONG Return


Fc9-comp-macro.png SetRxFilterStd
Sets the 16-bit filter as a bit-mask of the standard ID for received messages The messages are accepted if (StdID & Mask) == Filter  
Fc9-u8-icon.png - BYTE Filter
Filter number 
Fc9-u8-icon.png - BYTE Hi
The high byte (bits 8-15) of the ID 
Fc9-u8-icon.png - BYTE Lo
The low byte (bits 0-7) of the ID 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetRxFilterExd
Sets the 32-bit filter as a bit-mask of the extended ID for received messages The messages are accepted if (ExtID & Mask) == Filter  
Fc9-u8-icon.png - BYTE Filter
Send filter: 0 to 3 
Fc9-u8-icon.png - BYTE ID3
The high byte (bits 24-31) of the ID 
Fc9-u8-icon.png - BYTE ID2
The mid-high byte (bits 16-23) of the ID 
Fc9-u8-icon.png - BYTE ID1
The mid-low byte (bits 8-15) of the ID 
Fc9-u8-icon.png - BYTE ID0
The low byte (bits 0-7) of the ID 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-15-icon.png Value
 
Fc9-conn-icon.png Connections
Fc9-conn-icon.png Simulations
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Base2dObject_(Development)&oldid=25931"