oaVCOperation Class Reference


Public Methods
	oaVCOperation (oaVCOperationEnum valueIn)
	oaVCOperation (const oaString &name)
	~oaVCOperation ()
const oaString &	getName () const
	operator oaVCOperationEnum () const

Detailed Description

The oaVCOperation class is an enum wrapper class for oaVCOperationEnum values.

See Enum Wrappers in the Programmers Guide for a discussion of enum wrappers.

enum oaVCOperationEnum

This enumeration is a list of the operations to which a message passed through the IVCMessageObserver may be related. The operation in effect at the time the message was issued is passed in the form of a value from this enum to the IVCMessageObserver::onMessageOut() function. The values are self explanetory.
Enumeration values:

oacVCOperationGetStatus "GetStatus"

oacVCOperationGetControlledObjects "GetControlledObjects"

oacVCOperationGetControlledLibs "GetControlledLibs"

oacVCOperationGetVersions "GetVersions"

oacVCOperationGetWorkingVersion "GetWorkingVersion"

oacVCOperationGetWorkingVersions "GetWorkingVersions"

oacVCOperationUpdate "Update"

oacVCOperationMakeEditable "MakeEditable"

oacVCOperationCancelEdit "CancelEdit"

oacVCOperationCommitEdits "CommitEdits"

oacVCOperationSetControlled "SetControlled"

oacVCOperationUnsetControlled "UnsetControlled"

Constructor & Destructor Documentation

oaVCOperation::oaVCOperation ( oaVCOperationEnum valueIn ) [inline]

This oaVCOperation constructor takes an oaVCOperationEnum value.

Parameters:

valueIn an oaVCOperationEnum value

oaVCOperation::oaVCOperation ( const oaString & name )

This oaVCOperation constructor takes an oaVCOperationEnum name.

Parameters:

name the name associated with an oaVCOperationEnum value

Exceptions:

oacInvalidVCOperationName

oaVCOperation::~oaVCOperation ( ) [inline]

This is the oaVCOperation destructor.

Member Function Documentation

const oaString & oaVCOperation::getName ( ) const

This function returns the name of the oaVCOperationEnum value set on this oaVCOperation wrapper object.

oaVCOperation::operator oaVCOperationEnum ( ) const [inline]

This operator casts this oaVCOperation object into its corresponding oaVCOperationEnum value.

The documentation for this class was generated from the following files:

Return to top of page

oaVCOperation Class Reference

Public Methods

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation