ContactGuidedCable class

The ContactGuidedCable class gives you access to define *CONTACT_GUIDED_CABLE cards in PRIMER. More...

The PRIMER JavaScript API provides many class constants, properties and methods. For Arup to be able to extend and enhance the API in the future any constant, property or method names beginning with a lowercase or uppercase letter are reserved.
If you need to add your own properties or methods to one of the existing classes then to avoid any potential future conflict you should ensure that the name begins with either an underscore (_) or a dollar sign ($) or the name is prefixed with your own unique identifier.
For example if company 'ABC' need to add a property called 'example' then to avoid any potential future conflict use one of:

Class functions

Member functions

ContactGuidedCable constants

Name Description
ContactGuidedCable.PART CONTACT is *CONTACT_GUIDED_CABLE.
ContactGuidedCable.SET_PART CONTACT is *CONTACT_GUIDED_CABLE_SET.

ContactGuidedCable properties

Name Type Description
cid integer ContactGuidedCable number.
endtol real Tolerance, in length units.
exists (read only) logical true if contact guided_cable exists, false if referred to but not defined.
fric real Contact friction.
heading string ContactGuidedCable heading
id logical TRUE if _ID option is set, FALSE if not
include integer The Include file number that the contact guided_cable is in.
model (read only) integer The Model number that the contact guided_cable is in.
nsid integer Node Set ID that guides the 1D elements.
pid integer Part ID or Part Set ID
ptype constant The Contact Part type. Can be ContactGuidedCable.PART or ContactGuidedCable.SET_PART.
soft integer Flag for soft constraint option. Set to 1 for soft constraint.
ssfac real Stiffness scale factor for penalty stiffness value. The default value is unity. This applies to SOFT set to 0 and 1.

Detailed Description

The ContactGuidedCable class allows you to create, modify, edit and manipulate *CONTACT_GUIDED_CABLE cards. See the documentation below for more details.

Constructor

new ContactGuidedCable(Model[Model], ptype[constant], nsid[integer], pid[integer], soft (optional)[integer], ssfac (optional)[real], fric (optional)[real], cid (optional)[integer], heading (optional)[string], endtol (optional)[real])

Description

Create a new ContactGuidedCable object.

Arguments

  • Model (Model)

    Model that ContactGuidedCable will be created in

  • ptype (constant)

    Specify the type of ContactGuidedCable (Can be ContactGuidedCable.PART or ContactGuidedCable.SET_PART

  • nsid (integer)

    Node Set ID that guides the 1D elements.

  • pid (integer)

    Part ID or Part Set ID

  • soft (optional) (integer)

    Flag for soft constraint option. Set to 1 for soft constraint.

  • ssfac (optional) (real)

    Stiffness scale factor for penalty stiffness value. The default value is unity. This applies to SOFT set to 0 and 1.

  • fric (optional) (real)

    Contact friction.

  • cid (optional) (integer)

    ContactGuidedCable number (Same as label).

  • heading (optional) (string)

    ContactGuidedCable heading (Same as title).

  • endtol (optional) (real)

    Tolerance, in length units.

    Returns

    ContactGuidedCable object

    Return type

    ContactGuidedCable

    Example

    To create a new contact guided_cable in model m, of ptype PART, with nsid 100, pid 10, soft 1 and ssfac 4.5. 

    var c_g_c = new ContactGuidedCable(m, ContactGuidedCable.PART, 100, 10, 1, 4.5);

    Details of functions

    AssociateComment(Comment[Comment])

    Description

    Associates a comment with a contact guided_cable.

    Arguments

  • Comment (Comment)

    Comment that will be attached to the contact guided_cable

    Returns

    No return value

    Example

    To associate comment c to the contact guided_cable c_g_c: 

    c_g_c.AssociateComment(c);

    Blank()

    Description

    Blanks the contact guided_cable

    Arguments

    No arguments

    Returns

    No return value

    Example

    To blank contact guided_cable c_g_c: 

    c_g_c.Blank();

    BlankAll(Model[Model], redraw (optional)[boolean]) [static]

    Description

    Blanks all of the contact guided_cables in the model.

    Arguments

  • Model (Model)

    Model that all contact guided_cables will be blanked in

  • redraw (optional) (boolean)

    If model should be redrawn or not. If omitted redraw is false. If you want to do several (un)blanks and only redraw after the last one then use false for all redraws apart from the last one. Alternatively you can redraw using View.Redraw().

    Returns

    No return value

    Example

    To blank all of the contact guided_cables in model m: 

    ContactGuidedCable.BlankAll(m);

    BlankFlagged(Model[Model], flag[Flag], redraw (optional)[boolean]) [static]

    Description

    Blanks all of the flagged contact guided_cables in the model.

    Arguments

  • Model (Model)

    Model that all the flagged contact guided_cables will be blanked in

  • flag (Flag)

    Flag set on the contact guided_cables that you want to blank

  • redraw (optional) (boolean)

    If model should be redrawn or not. If omitted redraw is false. If you want to do several (un)blanks and only redraw after the last one then use false for all redraws apart from the last one. Alternatively you can redraw using View.Redraw().

    Returns

    No return value

    Example

    To blank all of the contact guided_cables in model m flagged with f: 

    ContactGuidedCable.BlankFlagged(m, f);

    Blanked()

    Description

    Checks if the contact guided_cable is blanked or not.

    Arguments

    No arguments

    Returns

    true if blanked, false if not.

    Return type

    Boolean

    Example

    To check if contact guided_cable c_g_c is blanked: 

    if (c_g_c.Blanked() ) do_something...

    ClearFlag(flag[Flag])

    Description

    Clears a flag on the contact guided_cable.

    Arguments

  • flag (Flag)

    Flag to clear on the contact guided_cable

    Returns

    No return value

    Example

    To clear flag f for contact guided_cable c_g_c: 

    c_g_c.ClearFlag(f);

    Copy(range (optional)[boolean])

    Description

    Copies the contact guided_cable. The target include of the copied contact guided_cable can be set using Options.copy_target_include.

    Arguments

  • range (optional) (boolean)

    If you want to keep the copied item in the range specified for the current include. Default value is false. To set current include, use Include.MakeCurrentLayer().

    Returns

    ContactGuidedCable object

    Return type

    ContactGuidedCable

    Example

    To copy contact guided_cable c_g_c into contact guided_cable z: 

    var z = c_g_c.Copy();

    DetachComment(Comment[Comment])

    Description

    Detaches a comment from a contact guided_cable.

    Arguments

  • Comment (Comment)

    Comment that will be detached from the contact guided_cable

    Returns

    No return value

    Example

    To detach comment c from the contact guided_cable c_g_c: 

    c_g_c.DetachComment(c);

    Error(message[string], details (optional)[string])

    Description

    Adds an error for contact guided_cable. For more details on checking see the Check class.

    Arguments

  • message (string)

    The error message to give

  • details (optional) (string)

    An optional detailed error message

    Returns

    No return value

    Example

    To add an error message "My custom error" for contact guided_cable c_g_c: 

    c_g_c.Error("My custom error");

    First(Model[Model]) [static]

    Description

    Returns the first contact guided_cable in the model.

    Arguments

  • Model (Model)

    Model to get first contact guided_cable in

    Returns

    ContactGuidedCable object (or null if there are no contact guided_cables in the model).

    Return type

    ContactGuidedCable

    Example

    To get the first contact guided_cable in model m: 

    var c_g_c = ContactGuidedCable.First(m);

    FirstFreeLabel(Model[Model], layer (optional)[Include number]) [static]

    Description

    Returns the first free contact guided_cable label in the model. Also see ContactGuidedCable.LastFreeLabel(), ContactGuidedCable.NextFreeLabel() and Model.FirstFreeItemLabel().

    Arguments

  • Model (Model)

    Model to get first free contact guided_cable label in

  • layer (optional) (Include number)

    Include file (0 for the main file) to search for labels in (Equivalent to First free in layer in editing panels). If omitted the whole model will be used (Equivalent to First free in editing panels).

    Returns

    ContactGuidedCable label.

    Return type

    Number

    Example

    To get the first free contact guided_cable label in model m: 

    var label = ContactGuidedCable.FirstFreeLabel(m);

    FlagAll(Model[Model], flag[Flag]) [static]

    Description

    Flags all of the contact guided_cables in the model with a defined flag.

    Arguments

  • Model (Model)

    Model that all contact guided_cables will be flagged in

  • flag (Flag)

    Flag to set on the contact guided_cables

    Returns

    No return value

    Example

    To flag all of the contact guided_cables with flag f in model m: 

    ContactGuidedCable.FlagAll(m, f);

    Flagged(flag[Flag])

    Description

    Checks if the contact guided_cable is flagged or not.

    Arguments

  • flag (Flag)

    Flag to test on the contact guided_cable

    Returns

    true if flagged, false if not.

    Return type

    Boolean

    Example

    To check if contact guided_cable c_g_c has flag f set on it: 

    if (c_g_c.Flagged(f) ) do_something...

    ForEach(Model[Model], func[function], extra (optional)[any]) [static]

    Description

    Calls a function for each contact guided_cable in the model.
    Note that ForEach has been designed to make looping over contact guided_cables as fast as possible and so has some limitations.
    Firstly, a single temporary ContactGuidedCable object is created and on each function call it is updated with the current contact guided_cable data. This means that you should not try to store the ContactGuidedCable object for later use (e.g. in an array) as it is temporary.
    Secondly, you cannot create new contact guided_cables inside a ForEach loop.

    Arguments

  • Model (Model)

    Model that all contact guided_cables are in

  • func (function)

    Function to call for each contact guided_cable

  • extra (optional) (any)

    An optional extra object/array/string etc that will appended to arguments when calling the function

    Returns

    No return value

    Example

    To call function test for all of the contact guided_cables in model m: 

    ContactGuidedCable.ForEach(m, test);
function test(c_g_c)
{
// c_g_c is ContactGuidedCable object
}

    To call function test for all of the contact guided_cables in model m with optional object: 

    var data = { x:0, y:0 };
ContactGuidedCable.ForEach(m, test, data);
function test(c_g_c, extra)
{
// c_g_c is ContactGuidedCable object
// extra is data
}

    GetAll(Model[Model], property (optional)[string]) [static]

    Description

    Returns an array of ContactGuidedCable objects or properties for all of the contact guided_cables in a model in PRIMER. If the optional property argument is not given then an array of ContactGuidedCable objects is returned. If the property argument is given, that property value for each contact guided_cable is returned in the array instead of a ContactGuidedCable object

    Arguments

  • Model (Model)

    Model to get contact guided_cables from

  • property (optional) (string)

    Name for property to get for all contact guided_cables in the model

    Returns

    Array of ContactGuidedCable objects or properties

    Return type

    Array

    Example

    To make an array of ContactGuidedCable objects for all of the contact guided_cables in model m: 

    var a = ContactGuidedCable.GetAll(m);

    To return an array containing the value of property 'foo' (for example 'x' for a node) for each contact guided_cable in model m: 

    var a = ContactGuidedCable.GetAll(m, 'foo');

    GetComments()

    Description

    Extracts the comments associated to a contact guided_cable.

    Arguments

    No arguments

    Returns

    Array of Comment objects (or null if there are no comments associated to the node).

    Return type

    Array

    Example

    To get the array of comments associated to the contact guided_cable c_g_c: 

    var comm_array = c_g_c.GetComments();

    GetFlagged(Model[Model], flag[Flag], property (optional)[string]) [static]

    Description

    Returns an array of ContactGuidedCable objects for all of the flagged contact guided_cables in a model in PRIMER If the optional property argument is not given then an array of ContactGuidedCable objects is returned. If the property argument is given, then that property value for each contact guided_cable is returned in the array instead of a ContactGuidedCable object

    Arguments

  • Model (Model)

    Model to get contact guided_cables from

  • flag (Flag)

    Flag set on the contact guided_cables that you want to retrieve

  • property (optional) (string)

    Name for property to get for all flagged contact guided_cables in the model

    Returns

    Array of ContactGuidedCable objects or properties

    Return type

    Array

    Example

    To make an array of ContactGuidedCable objects for all of the contact guided_cables in model m flagged with f: 

    var c_g_c = ContactGuidedCable.GetFlagged(m, f);

    To return an array containing the value of property 'foo' (for example 'x' for a node) for all of the contact guided_cables in model m flagged with f: 

    var a = ContactGuidedCable.GetFlagged(m, f, 'foo');

    GetFromID(Model[Model], number[integer]) [static]

    Description

    Returns the ContactGuidedCable object for a contact guided_cable ID.

    Arguments

  • Model (Model)

    Model to find the contact guided_cable in

  • number (integer)

    number of the contact guided_cable you want the ContactGuidedCable object for

    Returns

    ContactGuidedCable object (or null if contact guided_cable does not exist).

    Return type

    ContactGuidedCable

    Example

    To get the ContactGuidedCable object for contact guided_cable 100 in model m 

    var c_g_c = ContactGuidedCable.GetFromID(m, 100);

    GetParameter(prop[string])

    Description

    Checks if a ContactGuidedCable property is a parameter or not. Note that object properties that are parameters are normally returned as the integer or float parameter values as that is virtually always what the user would want. For this function to work the JavaScript interpreter must use the parameter name instead of the value. This can be done by setting the Options.property_parameter_names option to true before calling the function and then resetting it to false afterwards.. This behaviour can also temporarily be switched by using the ContactGuidedCable.ViewParameters() method and 'method chaining' (see the examples below).

    Arguments

  • prop (string)

    contact guided_cable property to get parameter for

    Returns

    Parameter object if property is a parameter, null if not.

    Return type

    Parameter

    Example

    To check if ContactGuidedCable property c_g_c.example is a parameter: 

    Options.property_parameter_names = true;
if (c_g_c.GetParameter(c_g_c.example) ) do_something...
Options.property_parameter_names = false;

    To check if ContactGuidedCable property c_g_c.example is a parameter by using the GetParameter method: 

    if (c_g_c.ViewParameters().GetParameter(c_g_c.example) ) do_something...

    Keyword()

    Description

    Returns the keyword for this ContactGuidedCable (*contact_guided_cable). Note that a carriage return is not added. See also ContactGuidedCable.KeywordCards()

    Arguments

    No arguments

    Returns

    string containing the keyword.

    Return type

    String

    Example

    To get the keyword for ContactGuidedCable c_g_c: 

    var key = c_g_c.Keyword();

    KeywordCards()

    Description

    Returns the keyword cards for the ContactGuidedCable. Note that a carriage return is not added. See also ContactGuidedCable.Keyword()

    Arguments

    No arguments

    Returns

    string containing the cards.

    Return type

    String

    Example

    To get the cards for ContactGuidedCable c_g_c: 

    var cards = c_g_c.KeywordCards();

    Last(Model[Model]) [static]

    Description

    Returns the last contact guided_cable in the model.

    Arguments

  • Model (Model)

    Model to get last contact guided_cable in

    Returns

    ContactGuidedCable object (or null if there are no contact guided_cables in the model).

    Return type

    ContactGuidedCable

    Example

    To get the last contact guided_cable in model m: 

    var c_g_c = ContactGuidedCable.Last(m);

    LastFreeLabel(Model[Model], layer (optional)[Include number]) [static]

    Description

    Returns the last free contact guided_cable label in the model. Also see ContactGuidedCable.FirstFreeLabel(), ContactGuidedCable.NextFreeLabel() and see Model.LastFreeItemLabel()

    Arguments

  • Model (Model)

    Model to get last free contact guided_cable label in

  • layer (optional) (Include number)

    Include file (0 for the main file) to search for labels in (Equivalent to Highest free in layer in editing panels). If omitted the whole model will be used.

    Returns

    ContactGuidedCable label.

    Return type

    Number

    Example

    To get the last free contact guided_cable label in model m: 

    var label = ContactGuidedCable.LastFreeLabel(m);

    Next()

    Description

    Returns the next contact guided_cable in the model.

    Arguments

    No arguments

    Returns

    ContactGuidedCable object (or null if there are no more contact guided_cables in the model).

    Return type

    ContactGuidedCable

    Example

    To get the contact guided_cable in model m after contact guided_cable c_g_c: 

    var c_g_c = c_g_c.Next();

    NextFreeLabel(Model[Model], layer (optional)[Include number]) [static]

    Description

    Returns the next free (highest+1) contact guided_cable label in the model. Also see ContactGuidedCable.FirstFreeLabel(), ContactGuidedCable.LastFreeLabel() and Model.NextFreeItemLabel()

    Arguments

  • Model (Model)

    Model to get next free contact guided_cable label in

  • layer (optional) (Include number)

    Include file (0 for the main file) to search for labels in (Equivalent to Highest+1 in layer in editing panels). If omitted the whole model will be used (Equivalent to Highest+1 in editing panels).

    Returns

    ContactGuidedCable label.

    Return type

    Number

    Example

    To get the next free contact guided_cable label in model m: 

    var label = ContactGuidedCable.NextFreeLabel(m);

    Pick(prompt[string], limit (optional)[Model or Flag], modal (optional)[boolean], button text (optional)[string]) [static]

    Description

    Allows the user to pick a contact guided_cable.

    Arguments

  • prompt (string)

    Text to display as a prompt to the user

  • limit (optional) (Model or Flag)

    If the argument is a Model then only contact guided_cables from that model can be picked. If the argument is a Flag then only contact guided_cables that are flagged with limit can be selected. If omitted, or null, any contact guided_cables from any model can be selected. from any model.

  • modal (optional) (boolean)

    If picking is modal (blocks the user from doing anything else in PRIMER until this window is dismissed). If omitted the pick will be modal.

  • button text (optional) (string)

    By default the window with the prompt will have a button labelled 'Cancel' which if pressed will cancel the pick and return null. If you want to change the text on the button use this argument. If omitted 'Cancel' will be used.

    Returns

    ContactGuidedCable object (or null if not picked)

    Return type

    ContactGuidedCable

    Example

    To pick a contact guided_cable from model m giving the prompt 'Pick contact guided_cable from screen': 

    var c_g_c = ContactGuidedCable.Pick('Pick contact guided_cable from screen', m);

    Previous()

    Description

    Returns the previous contact guided_cable in the model.

    Arguments

    No arguments

    Returns

    ContactGuidedCable object (or null if there are no more contact guided_cables in the model).

    Return type

    ContactGuidedCable

    Example

    To get the contact guided_cable in model m before contact guided_cable c_g_c: 

    var c_g_c = c_g_c.Previous();

    RenumberAll(Model[Model], start[integer]) [static]

    Description

    Renumbers all of the contact guided_cables in the model.

    Arguments

  • Model (Model)

    Model that all contact guided_cables will be renumbered in

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

    To renumber all of the contact guided_cables in model m, from 1000000: 

    ContactGuidedCable.RenumberAll(m, 1000000);

    RenumberFlagged(Model[Model], flag[Flag], start[integer]) [static]

    Description

    Renumbers all of the flagged contact guided_cables in the model.

    Arguments

  • Model (Model)

    Model that all the flagged contact guided_cables will be renumbered in

  • flag (Flag)

    Flag set on the contact guided_cables that you want to renumber

  • start (integer)

    Start point for renumbering

    Returns

    No return value

    Example

    To renumber all of the contact guided_cables in model m flagged with f, from 1000000: 

    ContactGuidedCable.RenumberFlagged(m, f, 1000000);

    Select(flag[Flag], prompt[string], limit (optional)[Model or Flag], modal (optional)[boolean]) [static]

    Description

    Allows the user to select contact guided_cables using standard PRIMER object menus.

    Arguments

  • flag (Flag)

    Flag to use when selecting contact guided_cables

  • prompt (string)

    Text to display as a prompt to the user

  • limit (optional) (Model or Flag)

    If the argument is a Model then only contact guided_cables from that model can be selected. If the argument is a Flag then only contact guided_cables that are flagged with limit can be selected (limit should be different to flag). If omitted, or null, any contact guided_cables can be selected. from any model.

  • modal (optional) (boolean)

    If selection is modal (blocks the user from doing anything else in PRIMER until this window is dismissed). If omitted the selection will be modal.

    Returns

    Number of contact guided_cables selected or null if menu cancelled

    Return type

    Number

    Example

    To select contact guided_cables from model m, flagging those selected with flag f, giving the prompt 'Select contact guided_cables': 

    ContactGuidedCable.Select(f, 'Select contact guided_cables', m);

    To select contact guided_cables, flagging those selected with flag f but limiting selection to contact guided_cables flagged with flag l, giving the prompt 'Select contact guided_cables': 

    ContactGuidedCable.Select(f, 'Select contact guided_cables', l);

    SetFlag(flag[Flag])

    Description

    Sets a flag on the contact guided_cable.

    Arguments

  • flag (Flag)

    Flag to set on the contact guided_cable

    Returns

    No return value

    Example

    To set flag f for contact guided_cable c_g_c: 

    c_g_c.SetFlag(f);

    Sketch(redraw (optional)[boolean])

    Description

    Sketches the contact guided_cable. The contact guided_cable will be sketched until you either call ContactGuidedCable.Unsketch(), ContactGuidedCable.UnsketchAll(), Model.UnsketchAll(), or delete the model

    Arguments

  • redraw (optional) (boolean)

    If model should be redrawn or not after the contact guided_cable is sketched. If omitted redraw is true. If you want to sketch several contact guided_cables and only redraw after the last one then use false for redraw and call View.Redraw().

    Returns

    No return value

    Example

    To sketch contact guided_cable c_g_c: 

    c_g_c.Sketch();

    SketchFlagged(Model[Model], flag[Flag], redraw (optional)[boolean]) [static]

    Description

    Sketches all of the flagged contact guided_cables in the model. The contact guided_cables will be sketched until you either call ContactGuidedCable.Unsketch(), ContactGuidedCable.UnsketchFlagged(), Model.UnsketchAll(), or delete the model

    Arguments

  • Model (Model)

    Model that all the flagged contact guided_cables will be sketched in

  • flag (Flag)

    Flag set on the contact guided_cables that you want to sketch

  • redraw (optional) (boolean)

    If model should be redrawn or not after the contact guided_cables are sketched. If omitted redraw is true. If you want to sketch flagged contact guided_cables several times and only redraw after the last one then use false for redraw and call View.Redraw().

    Returns

    No return value

    Example

    To sketch all contact guided_cables flagged with flag in model m: 

    ContactGuidedCable.SketchFlagged(m, flag);

    Total(Model[Model], exists (optional)[boolean]) [static]

    Description

    Returns the total number of contact guided_cables in the model.

    Arguments

  • Model (Model)

    Model to get total for

  • exists (optional) (boolean)

    true if only existing contact guided_cables should be counted. If false or omitted referenced but undefined contact guided_cables will also be included in the total.

    Returns

    number of contact guided_cables

    Return type

    Number

    Example

    To get the total number of contact guided_cables in model m: 

    var total = ContactGuidedCable.Total(m);

    Unblank()

    Description

    Unblanks the contact guided_cable

    Arguments

    No arguments

    Returns

    No return value

    Example

    To unblank contact guided_cable c_g_c: 

    c_g_c.Unblank();

    UnblankAll(Model[Model], redraw (optional)[boolean]) [static]

    Description

    Unblanks all of the contact guided_cables in the model.

    Arguments

  • Model (Model)

    Model that all contact guided_cables will be unblanked in

  • redraw (optional) (boolean)

    If model should be redrawn or not. If omitted redraw is false. If you want to do several (un)blanks and only redraw after the last one then use false for all redraws apart from the last one. Alternatively you can redraw using View.Redraw().

    Returns

    No return value

    Example

    To unblank all of the contact guided_cables in model m: 

    ContactGuidedCable.UnblankAll(m);

    UnblankFlagged(Model[Model], flag[Flag], redraw (optional)[boolean]) [static]

    Description

    Unblanks all of the flagged contact guided_cables in the model.

    Arguments

  • Model (Model)

    Model that the flagged contact guided_cables will be unblanked in

  • flag (Flag)

    Flag set on the contact guided_cables that you want to unblank

  • redraw (optional) (boolean)

    If model should be redrawn or not. If omitted redraw is false. If you want to do several (un)blanks and only redraw after the last one then use false for all redraws apart from the last one. Alternatively you can redraw using View.Redraw().

    Returns

    No return value

    Example

    To unblank all of the contact guided_cables in model m flagged with f: 

    ContactGuidedCable.UnblankFlagged(m, f);

    UnflagAll(Model[Model], flag[Flag]) [static]

    Description

    Unsets a defined flag on all of the contact guided_cables in the model.

    Arguments

  • Model (Model)

    Model that the defined flag for all contact guided_cables will be unset in

  • flag (Flag)

    Flag to unset on the contact guided_cables

    Returns

    No return value

    Example

    To unset the flag f on all the contact guided_cables in model m: 

    ContactGuidedCable.UnflagAll(m, f);

    Unsketch(redraw (optional)[boolean])

    Description

    Unsketches the contact guided_cable.

    Arguments

  • redraw (optional) (boolean)

    If model should be redrawn or not after the contact guided_cable is unsketched. If omitted redraw is true. If you want to unsketch several contact guided_cables and only redraw after the last one then use false for redraw and call View.Redraw().

    Returns

    No return value

    Example

    To unsketch contact guided_cable c_g_c: 

    c_g_c.Unsketch();

    UnsketchAll(Model[Model], redraw (optional)[boolean]) [static]

    Description

    Unsketches all contact guided_cables.

    Arguments

  • Model (Model)

    Model that all contact guided_cables will be unblanked in

  • redraw (optional) (boolean)

    If model should be redrawn or not after the contact guided_cables are unsketched. If omitted redraw is true. If you want to unsketch several things and only redraw after the last one then use false for redraw and call View.Redraw().

    Returns

    No return value

    Example

    To unsketch all contact guided_cables in model m: 

    ContactGuidedCable.UnsketchAll(m);

    UnsketchFlagged(Model[Model], flag[Flag], redraw (optional)[boolean]) [static]

    Description

    Unsketches all flagged contact guided_cables in the model.

    Arguments

  • Model (Model)

    Model that all contact guided_cables will be unsketched in

  • flag (Flag)

    Flag set on the contact guided_cables that you want to unsketch

  • redraw (optional) (boolean)

    If model should be redrawn or not after the contact guided_cables are unsketched. If omitted redraw is true. If you want to unsketch several things and only redraw after the last one then use false for redraw and call View.Redraw().

    Returns

    No return value

    Example

    To unsketch all contact guided_cables flagged with flag in model m: 

    ContactGuidedCable.UnsketchAll(m, flag);

    ViewParameters()

    Description

    Object properties that are parameters are normally returned as the integer or float parameter values as that is virtually always what the user would want. This function temporarily changes the behaviour so that if a property is a parameter the parameter name is returned instead. This can be used with 'method chaining' (see the example below) to make sure a property argument is correct.

    Arguments

    No arguments

    Returns

    ContactGuidedCable object.

    Return type

    ContactGuidedCable

    Example

    To check if ContactGuidedCable property c_g_c.example is a parameter by using the ContactGuidedCable.GetParameter() method: 

    if (c_g_c.ViewParameters().GetParameter(c_g_c.example) ) do_something...

    Warning(message[string], details (optional)[string])

    Description

    Adds a warning for contact guided_cable. For more details on checking see the Check class.

    Arguments

  • message (string)

    The warning message to give

  • details (optional) (string)

    An optional detailed warning message

    Returns

    No return value

    Example

    To add a warning message "My custom warning" for contact guided_cable c_g_c: 

    c_g_c.Warning("My custom warning");

    Xrefs()

    Description

    Returns the cross references for this contact guided_cable.

    Arguments

    No arguments

    Returns

    Xrefs object.

    Return type

    Xrefs

    Example

    To get the cross references for contact guided_cable c_g_c: 

    var xrefs = c_g_c.Xrefs();

    toString()

    Description

    Creates a string containing the ContactGuidedCable data in keyword format. Note that this contains the keyword header and the keyword cards. See also ContactGuidedCable.Keyword() and ContactGuidedCable.KeywordCards().

    Arguments

    No arguments

    Returns

    string

    Return type

    String

    Example

    To get data for ContactGuidedCable c_g_c in keyword format 

    var s = c_g_c.toString();