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

Inheritance diagram for NXOpen::PDM::SessionSettings:

Public Member Functions
bool	AdministrationBypass ()
	Returns a flag controlling the Teamcenter administrator's bypass option. More...

bool	AdministrationLogging ()
	Returns a flag controlling Teamcenter administration logging. More...

bool	ApplicationLogging ()
	Returns a flag controlling Teamcenter application logging Created in NX4.0.0. More...

void	Apply ()
	Applies any changes to the settings Created in NX4.0.0. More...

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. More...

void	DumpValidationInfo (const char *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. More...

std::vector< NXString >	GetGroups ()
	Gets the names of the Teamcenter groups to which the user belongs. More...

std::vector< NXString >	GetLocalVolumes ()
	Gets the names of the Teamcenter local volumes which the user may use, given the current group returned by PDM::SessionSettings::Group . More...

std::vector< NXString >	GetLocationCodes ()
	Gets the names of the Teamcenter location codes which the user may use, given the current group returned by PDM::SessionSettings::Group . More...

std::vector< NXString >	GetProjects ()
	Gets the names of the Teamcenter projects to which the user belongs also the first entry of the returned projects list is always empty. More...

std::vector< NXString >	GetRoles ()
	Gets the names of the Teamcenter roles in which the user may act, given the current group returned by PDM::SessionSettings::Group . More...

std::vector< NXString >	GetVolumes ()
	Gets the names of the Teamcenter volumes which the user may use, given the current group returned by PDM::SessionSettings::Group . More...

NXString	Group ()
	Returns the Teamcenter group in which the user acts. More...

bool	IsAdministrator ()
	Returns a flag indicating if the user has Teamcenter administator privileges. More...

bool	Journaling ()
	Returns a flag controlling Teamcenter journaling Created in NX4.0.0. More...

NXString	LocalVolume ()
	Returns the Teamcenter local volume. More...

NXString	LocationCode ()
	Returns the Teamcenter location code. More...

NXString	Project ()
	Returns the Teamcenter project in which the user acts. More...

NXString	Role ()
	Returns the Teamcenter role in which the user acts. More...

bool	SecurityLogging ()
	Returns a flag controlling Teamcenter security logging. More...

void	SetAdministrationBypass (bool adminBypassOn)
	Sets a flag controlling the Teamcenter administrator's bypass option. More...

void	SetAdministrationLogging (bool adminLoggingOn)
	Sets a flag controlling Teamcenter administration logging. More...

void	SetApplicationLogging (bool appLoggingOn)
	Sets a flag controlling Teamcenter application logging Created in NX4.0.0. More...

void	SetGroup (const NXString &group)
	Sets the Teamcenter group in which the user acts. More...

void	SetGroup (const char *group)
	Sets the Teamcenter group in which the user acts. More...

void	SetJournaling (bool journalingOn)
	Sets a flag controlling Teamcenter journaling Created in NX4.0.0. More...

void	SetLocalVolume (const NXString &localvolume)
	Sets the Teamcenter local volume. More...

void	SetLocalVolume (const char *localvolume)
	Sets the Teamcenter local volume. More...

void	SetLocationCode (const NXString &locationCode)
	Sets the Teamcenter location code. More...

void	SetLocationCode (const char *locationCode)
	Sets the Teamcenter location code. More...

void	SetProject (const NXString &project)
	Sets the Teamcenter project in which the user acts. More...

void	SetProject (const char *project)
	Sets the Teamcenter project in which the user acts. More...

void	SetRole (const NXString &role)
	Sets the Teamcenter role in which the user acts. More...

void	SetRole (const char *role)
	Sets the Teamcenter role in which the user acts. More...

void	SetSecurityLogging (bool securityLoggingOn)
	Sets a flag controlling Teamcenter security logging. More...

void	SetVolume (const NXString &volume)
	Sets the Teamcenter role in which the user acts. More...

void	SetVolume (const char *volume)
	Sets the Teamcenter role in which the user acts. More...

NXString	Volume ()
	Returns the Teamcenter role in which the user acts. More...

virtual	~SessionSettings ()
	Free resources associated with the instance. More...

Public Member Functions inherited from NXOpen::TransientObject
void *	GetHandle ()
	Handle of the internal object represented by this object. More...

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

virtual NXOpen::PDM::SessionSettings::~SessionSettings ( )

virtual

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

bool NXOpen::PDM::SessionSettings::AdministrationBypass ( )

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

Only available to administrators.
Created in NX4.0.0.

License requirements : None

bool NXOpen::PDM::SessionSettings::AdministrationLogging ( )

Returns a flag controlling Teamcenter administration logging.

Only available to administrators.
Created in NX4.0.0.

License requirements : None

bool NXOpen::PDM::SessionSettings::ApplicationLogging ( )

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

License requirements : None

void NXOpen::PDM::SessionSettings::Apply ( )

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

License requirements : None

void NXOpen::PDM::SessionSettings::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.

Created in NX6.0.0.

License requirements : None

Parameters

logFileName log file name

void NXOpen::PDM::SessionSettings::DumpValidationInfo ( const char * 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.

Created in NX6.0.0.

License requirements : None

Parameters

logFileName log file name

std::vector<NXString> NXOpen::PDM::SessionSettings::GetGroups ( )

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

std::vector<NXString> NXOpen::PDM::SessionSettings::GetLocalVolumes ( )

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

Returns: the names of the local volumes
Created in NX12.0.0.

License requirements : None

std::vector<NXString> NXOpen::PDM::SessionSettings::GetLocationCodes ( )

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

Returns: the names of the location codes
Created in NX12.0.0.

License requirements : None

std::vector<NXString> NXOpen::PDM::SessionSettings::GetProjects ( )

Gets the names of the Teamcenter projects to which the user belongs also the first entry of the returned projects list is always empty.

Returns: the names of the projects
Created in NX8.5.0.

License requirements : None

std::vector<NXString> NXOpen::PDM::SessionSettings::GetRoles ( )

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

std::vector<NXString> NXOpen::PDM::SessionSettings::GetVolumes ( )

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

NXString NXOpen::PDM::SessionSettings::Group ( )

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

bool NXOpen::PDM::SessionSettings::IsAdministrator ( )

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

bool NXOpen::PDM::SessionSettings::Journaling ( )

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

License requirements : None

NXString NXOpen::PDM::SessionSettings::LocalVolume ( )

Returns the Teamcenter local volume.

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

Created in NX12.0.0.

License requirements : None

NXString NXOpen::PDM::SessionSettings::LocationCode ( )

Returns the Teamcenter location code.

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

Created in NX12.0.0.

License requirements : None

NXString NXOpen::PDM::SessionSettings::Project ( )

Returns the Teamcenter project in which the user acts.

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

Created in NX8.5.0.

License requirements : None

NXString NXOpen::PDM::SessionSettings::Role ( )

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

bool NXOpen::PDM::SessionSettings::SecurityLogging ( )

Returns a flag controlling Teamcenter security logging.

Only available to administrators.
Created in NX4.0.0.

License requirements : None

void NXOpen::PDM::SessionSettings::SetAdministrationBypass ( bool adminBypassOn )

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

Only available to administrators.
Created in NX4.0.0.

License requirements : None

Parameters

adminBypassOn admin bypass on

void NXOpen::PDM::SessionSettings::SetAdministrationLogging ( bool adminLoggingOn )

Sets a flag controlling Teamcenter administration logging.

Only available to administrators.
Created in NX4.0.0.

License requirements : None

Parameters

adminLoggingOn admin logging on

void NXOpen::PDM::SessionSettings::SetApplicationLogging ( bool appLoggingOn )

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

License requirements : None

Parameters

appLoggingOn app logging on

void NXOpen::PDM::SessionSettings::SetGroup ( const NXString & group )

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

group group

void NXOpen::PDM::SessionSettings::SetGroup ( const char * group )

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

group group

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

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

License requirements : None

Parameters

journalingOn journaling on

void NXOpen::PDM::SessionSettings::SetLocalVolume ( const NXString & localvolume )

Sets the Teamcenter local volume.

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

Created in NX12.0.0.

License requirements : None

Parameters

localvolume localvolume

void NXOpen::PDM::SessionSettings::SetLocalVolume ( const char * localvolume )

Sets the Teamcenter local volume.

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

Created in NX12.0.0.

License requirements : None

Parameters

localvolume localvolume

void NXOpen::PDM::SessionSettings::SetLocationCode ( const NXString & locationCode )

Sets the Teamcenter location code.

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

Created in NX12.0.0.

License requirements : None

Parameters

locationCode locationcode

void NXOpen::PDM::SessionSettings::SetLocationCode ( const char * locationCode )

Sets the Teamcenter location code.

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

Created in NX12.0.0.

License requirements : None

Parameters

locationCode locationcode

void NXOpen::PDM::SessionSettings::SetProject ( const NXString & project )

Sets the Teamcenter project in which the user acts.

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

Created in NX8.5.0.

License requirements : None

Parameters

project project

void NXOpen::PDM::SessionSettings::SetProject ( const char * project )

Sets the Teamcenter project in which the user acts.

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

Created in NX8.5.0.

License requirements : None

Parameters

project project

void NXOpen::PDM::SessionSettings::SetRole ( const NXString & role )

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

role role

void NXOpen::PDM::SessionSettings::SetRole ( const char * role )

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

role role

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

securityLoggingOn security logging on

void NXOpen::PDM::SessionSettings::SetVolume ( const NXString & volume )

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

volume volume

void NXOpen::PDM::SessionSettings::SetVolume ( const char * volume )

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

volume volume

NXString NXOpen::PDM::SessionSettings::Volume ( )

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:

PDM_SessionSettings.hxx

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation