PhysicalName::AncestorName

Returns the physical name of an ancestor repeated capability.

Syntax

template <typename TAncestor>
const char* AncestorName() const;

Return value

Returns the physical name of an ancestor 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 a1 and b2 components of the full physical name.

The parent repeated capability (immediate ancestor) can be accessed more succinctly using the ParentName function.

Example

The following example demonstrates use of the AncestorName 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.AncestorName<Channel>();   // prints "C1"
    cout << marker.AncestorName<Trace>();     // prints "T3"
}