Medialon MxMs' Help 
  
Name : Medialon Strings Management
Version : 1.0.4
Available for : Manager V5 (all versions), Showmaster (ST & Pro)
Limitation In :
Device Brand : Medialon
Positrack Compatible : No
Resources type : None
 
Compatible hardware interfaces - available resource modules (MRC) :
 

 

> Overview | > Installation (MXM) | > Creation (Device) | > Commands (List Of) | > Variables (List Of) | > Support


Overview :

This mxm provides conversion and analysis of character strings.

> Top


Installation (MXM) :

No specific installation required.

> Top


Creation (Device) :

No device creation window.

> Top


Commands (List Of) :

String length :

      Description : to return the length of a string
      Parameters :
        String : [Type : String] : String to analyze
        Return Length : [Type : Integer] : Return length.

Substring position :
      Description : to return the position of a string in a string
      Parameters :
        String : [Type : String] : String to analyze.
        Substring : [Type : String] : String to find.
        Return Position : [Type : Integer] : Return position (0 indexed, -1 if not found)
Extract string:
      Description : to return a substring contained in a string.
      Parameters :
        String : [Type : String] : String to analyze.
        Position : [Type : Integer] : Position of the substring to return (0 indexed).
        Length : [Type : Integer] : Length of the substring to return.
        Return substring : [Type : String] : Return string.
Delete substring :
      Description : to delete a part of a string.
      Parameters :
        String : [Type : String] : String to modify.
        Index : [Type : Integer] : Start of substring to delete. (0 indexed)
        Length : [Type : Integer] : Length of substring to delete.

Insert substring :
      Description : to insert a string into a string.
      Parameters :
        String : [Type : String] : String to modify.
        Index : [Type : Integer] : Where to insert the substring.
        Substring : [Type : String] : String to insert.

Replace substrings :
      Description : to replace all the substring(s) by a new one into a string.
      Parameters :
        String : [Type : String] : String to modify.
        Substring : [Type : String] : String(s) to find.
        Replacement substring : [Type : String] : Replacement string.
Uppercase string:
      Description : to convert a string to uppercase.
      Parameters :
        String : [Type : String] : String to modify.
Lowercase string:
      Description : to convert a string to lowercase.
      Parameters :
        String : [Type : String] : String to modify.
Hexadecimal string to integer:
      Description : to compute an hexadecimal string into an integer value.
      Parameters :
        String : [Type : String] : String to analyze.
        Return value : [Type : Integer] : Return integer.
Integer to hexadecimal string:
      Description : to return the string representation of an integer value.
      Parameters :
        Integer value : [Type : Integer] : Integer to analyze.
        Min count : [Type : Integer] : Minimum count of digits.
        Return String : [Type : String] : String to return.
Left string:
      Description : to return the left part of a string.
      Parameters :
        String : [Type : String] : String to analyze.
        Count of characters : [Type : Integer] : Count of character of the substring to return.
        Return string : [Type : String] : Return string.
Right string:
      Description : to return the right part of a string.
      Parameters :
        String : [Type : String] : String to analyze.
        Count of characters : [Type : Integer] : Count of character of the substring to return.
        Return string : [Type : String] : Return string.
Read ASCII character:
      Description : to return the value of a character in ASCII.
      Parameters :
        String : [Type : String] : String to analyze.
        Position of the characters : [Type : Integer] ] : Position of the character to return.
        Return ASCII value : [Type : String] : Return value.
Write ASCII character:
      Description : to change a character in a string by an ASCII value.
      Parameters :
        String : [Type : String] : String to modify.
        Position of the characters : [Type : Integer] : Position of the character to modify.
        ASCII value : [Type : String] : ASCII value of the character.
Pad String:
      Description : to fill a string with a serie of one character to a string until a specified length.
      Parameters :
        String : [Type : String] : String to modify.
        Length: [Type : Integer] The resulting desired lenth.
        Side : [Type : Enum] :
        Available values :
        Left : the characters are added at the head of the string.
        Right : the characters are added at the end of the string.
        Character ASCII value : [Type : Integer] : ASCII value of the character to add.

Replace character:
      Description : replace a character value in a string.
      Parameters :
        String : [Type : String] : String to analize.
        Character to replace : [Type : Integer] The ascii value of the character to replace.
        Replacement character to replace : [Type : Integer] The ascii value of the replacement character.
        Multiple following characters : [Type : Enum] :
        Available values :
        Yes : if several following character are found, the suite is replaced by one character.
        No : each character found is replaced.
        Occurence : [Type : Enum] :
        Available values :
        All : all the occurences of the character are replaced.
        First : only the first occurences of the character is replaced.
        Last : only the last occurences of the character is replaced.

Return string : [Type : String] : Return string.


Rotate string :

Description : Rotate the characters of a string.
Parameters :
String [Type : String] : String to rotate
Usage : This command can be used for a scroll effect in a display. Each time the command is called, the first character of the string is moved at the end of the string. In order to create a real scroll effect, the string must end with white spaces or with dots: <rotate...> <otate...r> <tate...ro> <ate...rot> <te...rota> <e...rotat> <rotate...>


Build string block :

      Description : Build up a block of strings separated by specified character ASCII values.
      Parameters :
      String block [Type : String] : Original block of strings.
      Separator [Type : Integer] : Separator ASCII value between 1 and 255 (0 is not allowed).
      String to add [Type : String] : The string that has to be added at the end of the original block.
      Return string [Type : String] : Destination block of strings (can be the same as the original).






Read string from block :
      Description : Read back a string from a block of strings at the specified index.
      Parameters :
      String block [Type : String] : Block of strings to read from.
      Separator [Type : Integer] : Separator ASCII value between 1 and 255 ( 0 is not allowed ).
      Index [Type : Integer] : Position of the string in the block (starting at 0).
      Return string [Type : String] : Variable filled with the value in return.

Compute:
      Description: Compute the given string with one of the available algorithm.
      Parameters:
      String[Type: String]: String to compute.
      Type: [Type: Enum]: Type of algorihtm.
      Available values:
      MD5: Message Digest 5.
      CRC32: Cyclic Redundancy Check 32 Bits.
      CRC16: Cyclic Redundancy Check 16 Bits.
      CRC8: Cyclic Redundancy Check 8 Bits.
      SUM: Sum of bytes.
      Result Type: [Type: Enum]: Type (form) of the result.
      Available values:
      Normal: Result data are provided in a raw format.
      Escaped: A '!' escape character is placed before each hexa decimal value.
      Result[Type: String]: Variable filled with the value in return.
      Note 1: The input string accept '!' escape char to encode hexadecimal char (!01 is 01h).
      Note 2: If the given return parameter is a String, the result of the computation will be given in hexadecimal ascii chars. If the return parameter is an Integer or a Real, the command try to fill-in with an integer value macthing the result (MD5 type return 0 in this case as the result is a 128 bits value).

> Top


Variables (List Of) :

No variables.

> Top


Support (Difference with previous versions) :

V 1.0.1:

  • Added: Support for Showmaster.

V 1.0.2:

  • Added: Support for Showmaster Pro.

V 1.0.3:

  • Added: 'Compute' command.

V 1.0.4:

  • Fixed: In some circusmtances, cues may not be executed.

> Top