NX Open C++ Reference Guide
Public Member Functions
NXOpen::PDM::SessionSettings Class Reference

Values for the settings that affect the current Teamcenter session. More...

Inheritance diagram for NXOpen::PDM::SessionSettings:
NXOpen::TransientObject

List of all members.

Public Member Functions

bool AdministrationBypass ()
 Returns a flag controlling the Teamcenter administrator's bypass option.
bool AdministrationLogging ()
 Returns a flag controlling Teamcenter administration logging.
bool ApplicationLogging ()
 Returns a flag controlling Teamcenter application logging
Created in NX4.0.0.
void Apply ()
 Applies any changes to the settings
Created in NX4.0.0.
void DumpValidationInfo (const NXString &logFileName)
 Dump the validation info .This API can be used to expose the current state from the UGMGR session, typically the information about the session,assembly,components,their states etc.
std::vector< NXStringGetGroups ()
 Gets the names of the Teamcenter groups to which the user belongs.
std::vector< NXStringGetRoles ()
 Gets the names of the Teamcenter roles in which the user may act, given the current group returned by PDM::SessionSettings::Group .
std::vector< NXStringGetVolumes ()
 Gets the names of the Teamcenter volumes which the user may use, given the current group returned by PDM::SessionSettings::Group .
NXString Group ()
 Returns the Teamcenter group in which the user acts.
bool IsAdministrator ()
 Returns a flag indicating if the user has Teamcenter administator privileges.
bool Journaling ()
 Returns a flag controlling Teamcenter journaling
Created in NX4.0.0.
NXString Role ()
 Returns the Teamcenter role in which the user acts.
bool SecurityLogging ()
 Returns a flag controlling Teamcenter security logging.
void SetAdministrationBypass (bool adminBypassOn)
 Sets a flag controlling the Teamcenter administrator's bypass option.
void SetAdministrationLogging (bool adminLoggingOn)
 Sets a flag controlling Teamcenter administration logging.
void SetApplicationLogging (bool appLoggingOn)
 Sets a flag controlling Teamcenter application logging
Created in NX4.0.0.
void SetGroup (const NXString &group)
 Sets the Teamcenter group in which the user acts.
void SetJournaling (bool journalingOn)
 Sets a flag controlling Teamcenter journaling
Created in NX4.0.0.
void SetRole (const NXString &role)
 Sets the Teamcenter role in which the user acts.
void SetSecurityLogging (bool securityLoggingOn)
 Sets a flag controlling Teamcenter security logging.
void SetVolume (const NXString &volume)
 Sets the Teamcenter role in which the user acts.
NXString Volume ()
 Returns the Teamcenter role in which the user acts.
virtual ~SessionSettings ()
 Free resources associated with the instance.

Detailed Description

Values for the settings that affect the current Teamcenter session.

Any changes will only take effect when PDM::SessionSettings::Apply is callsed.
Created in NX4.0.0.


Constructor & Destructor Documentation

Free resources associated with the instance.

After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector.
Created in NX4.0.0.

License requirements : None


Member Function Documentation

Returns a flag controlling the Teamcenter administrator's bypass option.

Only available to administrators.
Created in NX4.0.0.

License requirements : None

Returns a flag controlling Teamcenter administration logging.

Only available to administrators.
Created in NX4.0.0.

License requirements : None

Returns a flag controlling Teamcenter application logging
Created in NX4.0.0.



License requirements : None

Applies any changes to the settings
Created in NX4.0.0.



License requirements : None

Dump the validation info .This API can be used to expose the current state from the UGMGR session, typically the information about the session,assembly,components,their states etc.


Created in NX6.0.0.

License requirements : None

Parameters:
logFileNamelog file name
NOTE: The full Unicode character set is not supported for this parameter.

Gets the names of the Teamcenter groups to which the user belongs.

Returns:
the names of the groups
Created in NX4.0.0.

License requirements : None

Gets the names of the Teamcenter roles in which the user may act, given the current group returned by PDM::SessionSettings::Group .

Returns:
the names of the roles
Created in NX4.0.0.

License requirements : None

Gets the names of the Teamcenter volumes which the user may use, given the current group returned by PDM::SessionSettings::Group .

Returns:
the names of the volumes
Created in NX4.0.0.

License requirements : None

Returns the Teamcenter group in which the user acts.

Should be one of those given by PDM::SessionSettings::GetGroups


Created in NX4.0.0.

License requirements : None

Returns a flag indicating if the user has Teamcenter administator privileges.

Some settings can are only available to administrators, and will raise errors if non-administrators try to access them.


Created in NX4.0.0.

License requirements : None

Returns a flag controlling Teamcenter journaling
Created in NX4.0.0.



License requirements : None

Returns the Teamcenter role in which the user acts.

Should be one of those given by PDM::SessionSettings::GetRoles


Created in NX4.0.0.

License requirements : None

Returns a flag controlling Teamcenter security logging.

Only available to administrators.
Created in NX4.0.0.

License requirements : None

Sets a flag controlling the Teamcenter administrator's bypass option.

Only available to administrators.
Created in NX4.0.0.

License requirements : None

Parameters:
adminBypassOnadmin bypass on

Sets a flag controlling Teamcenter administration logging.

Only available to administrators.
Created in NX4.0.0.

License requirements : None

Parameters:
adminLoggingOnadmin logging on

Sets a flag controlling Teamcenter application logging
Created in NX4.0.0.



License requirements : None

Parameters:
appLoggingOnapp logging on

Sets the Teamcenter group in which the user acts.

Should be one of those given by PDM::SessionSettings::GetGroups


Created in NX4.0.0.

License requirements : None

Parameters:
groupgroup
void NXOpen::PDM::SessionSettings::SetJournaling ( bool  journalingOn)

Sets a flag controlling Teamcenter journaling
Created in NX4.0.0.



License requirements : None

Parameters:
journalingOnjournaling on

Sets the Teamcenter role in which the user acts.

Should be one of those given by PDM::SessionSettings::GetRoles


Created in NX4.0.0.

License requirements : None

Parameters:
rolerole
void NXOpen::PDM::SessionSettings::SetSecurityLogging ( bool  securityLoggingOn)

Sets a flag controlling Teamcenter security logging.

Only available to administrators.
Created in NX4.0.0.

License requirements : None

Parameters:
securityLoggingOnsecurity logging on

Sets the Teamcenter role in which the user acts.

Should be one of those given by PDM::SessionSettings::GetVolumes


Created in NX4.0.0.

License requirements : None

Parameters:
volumevolume

Returns the Teamcenter role in which the user acts.

Should be one of those given by PDM::SessionSettings::GetVolumes


Created in NX4.0.0.

License requirements : None


The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.