OdBcf::OdBcfVersion Class Reference

#include <BcfVersion.h>

Inheritance diagram for OdBcf::OdBcfVersion:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdBcfVersion)
	OdBcfVersion ()
virtual OdResult	inFields (TiXmlElement *pParent) ODRX_OVERRIDE
virtual OdResult	outFields (TiXmlElement *pParent) const ODRX_OVERRIDE
virtual bool	validate () const ODRX_OVERRIDE
Public Member Functions inherited from OdBcf::OdBcfElement
	ODRX_DECLARE_MEMBERS (OdBcfElement)
virtual OdResult	inFields (TiXmlElement *pParent)=0
virtual OdResult	outFields (TiXmlElement *pParent) const =0
virtual bool	validate () const =0
Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()
	OdRxObject ()
virtual	~OdRxObject ()
virtual OdRxObject *	queryX (const OdRxClass *pClass) const
virtual OdRxObject *	x (const OdRxClass *pClass) const
virtual OdRxClass *	isA () const
virtual void	addRef ()=0
virtual void	release ()=0
virtual long	numRefs () const
bool	isKindOf (const OdRxClass *pClass) const
virtual OdRxObjectPtr	clone () const
virtual void	copyFrom (const OdRxObject *pSource)
virtual OdRx::Ordering	comparedTo (const OdRxObject *pOther) const
virtual bool	isEqualTo (const OdRxObject *pOther) const

Protected Member Functions
void	setDetailedVersion (const OdString &detailedVersionValue)
OdString &	getDetailedVersion ()
const OdString &	getDetailedVersion () const
bool	isDetailedVersionUnset () const
void	setVersionId (const OdString &versionIdValue)
OdString &	getVersionId ()
const OdString &	getVersionId () const
bool	isVersionIdUnset () const

Protected Attributes
OdString	m_detailedVersion
OdString	m_versionId
friend	OdBcfSession

Additional Inherited Members
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Detailed Description

A class that stores and operates the information about a version.

Definition at line 41 of file BcfVersion.h.

Constructor & Destructor Documentation

OdBcfVersion()

OdBcf::OdBcfVersion::OdBcfVersion

(

)

Creates a new version object with default parameters.

Member Function Documentation

getDetailedVersion() [1/2]

OdString & OdBcf::OdBcfVersion::getDetailedVersion ( )

protected

Retrieves the detailed version information.

Returns

A string that contains the detailed version information.

Remarks

The string object returned by the method can be modified in the calling subroutine.

getDetailedVersion() [2/2]

const OdString & OdBcf::OdBcfVersion::getDetailedVersion ( ) const

protected

Retrieves the detailed version information.

Returns

A string that contains the detailed version information.

Remarks

The string object returned by the method can't be modified in the calling subroutine.

getVersionId() [1/2]

OdString & OdBcf::OdBcfVersion::getVersionId ( )

protected

Retrieves the version identifier.

Returns

A string that contains the version identifier.

Remarks

The identifier value returned by the method can be modified in the calling subroutine.

getVersionId() [2/2]

const OdString & OdBcf::OdBcfVersion::getVersionId ( ) const

protected

Retrieves the version identifier.

Returns

A string that contains the version identifier.

Remarks

The identifier value returned by the method can't be modified in the calling subroutine.

inFields()

virtual OdResult OdBcf::OdBcfVersion::inFields ( TiXmlElement *  pParent )

virtual

Reads XML data into ODA data structures.

Parameters

pParent

[in] A pointer to the parent element of the data structure.

Returns

eOk if data was successfully read; otherwise, the method returns an appropriate error code.

Implements OdBcf::OdBcfElement.

isDetailedVersionUnset()

bool OdBcf::OdBcfVersion::isDetailedVersionUnset ( ) const

protected

Defines whether the detailed version information is not initialized.

Returns

true if the detailed version information is not initialized; otherwise, the method returns false.

isVersionIdUnset()

bool OdBcf::OdBcfVersion::isVersionIdUnset ( ) const

protected

Defines whether the version identifier is not initialized.

Returns

true if the version identifier is not initialized; otherwise, the method returns false.

ODRX_DECLARE_MEMBERS()

OdBcf::OdBcfVersion::ODRX_DECLARE_MEMBERS

(

OdBcfVersion

)

outFields()

virtual OdResult OdBcf::OdBcfVersion::outFields ( TiXmlElement *  pParent ) const

virtual

Writes data into XML structures.

Parameters

pParent

[in] A pointer to the parent element of the data structure.

Returns

eOk if data was successfully written; otherwise, the method returns an appropriate error code.

Implements OdBcf::OdBcfElement.

setDetailedVersion()

void OdBcf::OdBcfVersion::setDetailedVersion ( const OdString &  detailedVersionValue )

protected

Sets the detailed version information.

Parameters

detailedVersionValue

[in] A string that contains the detailed version information.

setVersionId()

void OdBcf::OdBcfVersion::setVersionId ( const OdString &  versionIdValue )

protected

Sets the identifier of the version.

Parameters

versionIdValue

[in] A string that contains the identifier of the version.

validate()

virtual bool OdBcf::OdBcfVersion::validate ( ) const

virtual

Checks whether the version instance has all required fields initialized.

Returns

true if all required fields are initialized; otherwise the method returns false.

Implements OdBcf::OdBcfElement.

Member Data Documentation

m_detailedVersion

OdString OdBcf::OdBcfVersion::m_detailedVersion

protected

The detailed version.

Definition at line 77 of file BcfVersion.h.

m_versionId

OdString OdBcf::OdBcfVersion::m_versionId

protected

The identifier of the version.

Definition at line 79 of file BcfVersion.h.

OdBcfSession

friend OdBcf::OdBcfVersion::OdBcfSession

protected

Definition at line 138 of file BcfVersion.h.

---

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

• BcfVersion.h