PhysicalName::ParentName

Returns the repeated capability physical name of the parent repeated capability.

Syntax

const char* ParentName() const;

Return value

Returns the repeated capability physical name of the parent repeated capability.

Remarks

Important

This function is only available for PhysicalName instances that are associated with a nested repeated capability. Attempting to access this function from a non-nested PhysicalName instance will produce a compile error.

Physical names for nested repeated capabilities have the following form:

a1:b2:c3

This function can be used to access the b2 component of the full physical name.

Other ancestor components of the full physical name (grandparent repeated capabilities, etc) can be accessed using the more general AncestorName function.

Example

The following example demonstrates use of the ParentName function.

ViStatus _VI_FUNC acme4321_ConfigureArmCount(ViSession Vi, ViConstString RepCapIdentifier, ViInt32 ArmCount)
{
    // Assume the following nested repeated capability definition exists:
    //
    //     Channel -> Trace -> Marker
    //
    //     where the Channel repeated capability is the highest-level parent repeated capability
    //
    PhysicalName<Marker> marker("C1:T3:M2");

    cout << marker.ParentName();   // prints "T3"
}