TcUnit

67 objects — 14 function blocks  36 functions  3 interfaces  3 GVLs  9 structs  2 enums 


Function Blocks

NameDescription
FB FB_AdjustAssertFailureMessageToMax253CharLengthThis function block is responsible for making sure that the asserted test instance path and test message are not loo...
FB FB_AdsAssertMessageFormatterThis function block is responsible for printing the results of the assertions using the built-in ADSLOGSTR...
FB FB_AdsLogStringMessageFifoQueueThis function block is responsible for making sure that the ADSLOGSTR-messages to the ADS-router are transmitted...
FB FB_AdsTestResultLoggerThis function block reports the results from the tests using the built-in ADSLOGSTR functionality provided by the...
FB FB_AssertArrayResultStaticThis function block is responsible for keeping track of which array-asserts that have been made. The reason we need...
FB FB_AssertResultStaticThis function block is responsible for keeping track of which asserts that have been made. The reason we need to...
FB FB_FileControlThis functionblock can open, close, read, write and delete files on the local filesystem
FB FB_StreamBufferThis functionblock acts as a stream buffer for use with FB_XmlControl
FB FB_TcUnitRunnerThis function block is responsible for holding track of the tests and executing them.
FB FB_TestThis function block holds all data that defines a test.
FB FB_TestResultsThis function block holds results of the complete test run, i.e. results for all test suites
FB FB_TestSuiteThis function block is responsible for holding the internal state of the test suite. Every test suite can have one...
FB FB_XmlControlOrganizes parsing and composing of XML data. Data can be treated as STRING or char array. Buffer size of file can be...
FB FB_xUnitXmlPublisherPublishes test results into an xUnit compatible Xml file

Functions

NameDescription
FN F_AnyToUnionValue
FN F_AnyTypeClassToStringThis function takes the type-class of a ANY-variable and returns the STRING representation of it.
FN F_AssertionTypeToStringSince TwinCAT 3.1.4024.x it's possible to do TO_STRING on enumerations, but for backward compability we need to do...
FN F_GetCpuCounterAs64bitCalls the passed GETCPUCOUNTER function block and converts the output of the GETCPUCOUNTER function block from...
FN F_GetTestSuiteNameFromTestInstancePath
FN F_IsAnyEqualToUnionValue
FN F_RemoveInstancePathAndProjectNameFromTestInstancePath
FN IS_TEST_FINISHEDCheck if a certain test in the current suite is finished
FN RUNThis function runs all test suites that have been initialized. The test suites are run in parallel (all at once).
FN RUN_IN_SEQUENCEThis function runs all test suites that have been initialized. The test suites are run in sequence (one after the other).
FN TCUNIT_ADSLOGSTRThis function allows to put ADS strings into the TcUnit ADS message buffer. If ADSLOGSTR() is used directly, the...
FN TESTThis function declares a new test (if it has not been already declared in an earlier cycle)
FN TEST_FINISHEDSets the currently running test as finished
FN TEST_FINISHED_NAMEDSets a test defined by TestName as finished. Note that the TestName-input must match a TestName that has been...
FN TEST_ORDEREDThis function declares a new ordered test (if it has not been already declared in an earlier cycle). The test...
FN WRITE_PROTECTED_BOOL
FN WRITE_PROTECTED_BYTE
FN WRITE_PROTECTED_DATE
FN WRITE_PROTECTED_DATE_AND_TIME
FN WRITE_PROTECTED_DINT
FN WRITE_PROTECTED_DWORD
FN WRITE_PROTECTED_INT
FN WRITE_PROTECTED_LINT
FN WRITE_PROTECTED_LREAL
FN WRITE_PROTECTED_LWORD
FN WRITE_PROTECTED_REAL
FN WRITE_PROTECTED_SINT
FN WRITE_PROTECTED_STRING
FN WRITE_PROTECTED_TIME
FN WRITE_PROTECTED_TIME_OF_DAY
FN WRITE_PROTECTED_UDINT
FN WRITE_PROTECTED_UINT
FN WRITE_PROTECTED_ULINT
FN WRITE_PROTECTED_USINT
FN WRITE_PROTECTED_WORD
FN WRITE_PROTECTED_WSTRING

Interfaces

NameDescription
ITF I_AssertMessageFormatter
ITF I_TestResultLogger
ITF I_TestResults

Global Variable Lists

NameDescription
GVL GVL_Param_TcUnit
GVL GVL_TcUnit
GVL Global_VersionThis function has been automatically generated from the project information.

Structures

NameDescription
ST ST_AdsLogStringMessage
ST ST_AssertArrayResult
ST ST_AssertArrayResultInstances
ST ST_AssertResult
ST ST_AssertResultInstances
ST ST_TestCaseResult
ST ST_TestSuiteResult
ST ST_TestSuiteResults
ST U_ExpectedOrActual

Enumerations

NameDescription
ENUM E_AssertionType
ENUM E_XmlError