OdMvdXml Namespace Reference

Classes
class	OdMvdApplicability
class	OdMvdOperator
class	OdMvdRequirement
class	OdMvdXmlApplicability
class	OdMvdXmlAttributeRule
class	OdMvdXmlAuditInfo
class	OdMvdXmlBody
class	OdMvdXmlConcept
class	OdMvdXmlConceptRoot
class	OdMvdXmlConceptTemplate
class	OdMvdXmlConstraint
class	OdMvdXmlDefinition
class	OdMvdXmlDefinitions
class	OdMvdXmlDefinitionsBase
class	OdMvdXmlElement
class	OdMvdXmlEntityRule
class	OdMvdXmlExchangeRequirement
class	OdMvdXmlFilter
class	OdMvdXmlIdentity
class	OdMvdXmlIdentityDefinitions
class	OdMvdXmlLink
class	OdMvdXmlModelView
class	OdMvdXmlProcessor
class	OdMvdXmlRequirement
class	OdMvdXmlRoot
class	OdMvdXmlRule
class	OdMvdXmlTemplateRef
class	OdMvdXmlTemplateRule
class	OdMvdXmlTemplateRules
class	OdMvdXmlValidator

Typedefs
typedef OdSmartPtr< OdMvdXmlProcessor >	OdMvdXmlProcessorPtr

Enumerations
enum	mvdXmlVersion { mvdXmlUnset , mvdXml1dot1 , mvdXml1dot2 , mvdXml1_1 }
enum	OdMvdStatus {   OdMvdStatusUnset = -1 , OdMvdSample = 0 , OdMvdProposal , OdMvdDraft ,   OdMvdCandidate , OdMvdFinal , OdMvdDeprecated }
enum	ProccesorType { kValidator , kFilter }

Functions
	SMARTPTR (OdMvdXmlApplicability)
	SMARTPTR (OdMvdXmlAttributeRule)
	SMARTPTR (OdMvdXmlEntityRule)
	SMARTPTR (OdMvdXmlConceptTemplate)
	SMARTPTR (OdMvdXmlBody)
	SMARTPTR (OdMvdXmlConcept)
	SMARTPTR (OdMvdXmlConceptRoot)
	SMARTPTR (OdMvdXmlConstraint)
	SMARTPTR (OdMvdXmlDefinition)
	SMARTPTR (OdMvdXmlElement)
	SMARTPTR (OdMvdXmlExchangeRequirement)
	SMARTPTR (OdMvdXmlIdentity)
	SMARTPTR (OdMvdXmlLink)
	SMARTPTR (OdMvdXmlModelView)
	SMARTPTR (OdMvdXmlRequirement)
	SMARTPTR (OdMvdXmlRoot)
	SMARTPTR (OdMvdXmlTemplateRef)
	SMARTPTR (OdMvdXmlTemplateRule)
	SMARTPTR (OdMvdXmlTemplateRules)
template<typename T>
OdResult	inFieldsArray (OdArray< OdSmartPtr< T > > &container, TiXmlNode *pParent, const char *pItemName)
template<typename T>
OdResult	outFieldsArray (OdArray< OdSmartPtr< T > > &container, TiXmlNode *pParent, const char *pGroupName)

Detailed Description

Contains declarations related to Model View Definition (MVD) functionality.

Typedef Documentation

OdMvdXmlProcessorPtr

typedef OdSmartPtr<OdMvdXmlProcessor> OdMvdXml::OdMvdXmlProcessorPtr

A data type that represents a smart pointer to an <<exref target="https://docs.opendesign.com/tifc_api_cpp/OdMvdXml__OdMvdXmlProcessor.html>OdMvdXmlProcessor</exref> OdMvdXmlProcessor> object.

Definition at line 114 of file MvdXmlProcessor.h.

Enumeration Type Documentation

mvdXmlVersion

enum OdMvdXml::mvdXmlVersion

Declarations of the mvdXML format versions.

Enumerator
mvdXmlUnset	Version is unset.
mvdXml1dot1	mvdXML format version 1.1.
mvdXml1dot2	mvdXML format version 1.2.
mvdXml1_1	mvdXML format version 1-1.

Definition at line 44 of file MvdXmlRoot.h.

OdMvdStatus

enum OdMvdXml::OdMvdStatus

Contains declarations of statuses of an element of model view definition element.

Enumerator
OdMvdStatusUnset	The status value is not set.
OdMvdSample	The definition element is a sample.
OdMvdProposal	The definition element is a proposal.
OdMvdDraft	The definition element is a draft.
OdMvdCandidate	The definition element is a candidate.
OdMvdFinal	The definition element is final.
OdMvdDeprecated	The definition element is deprecated.

Definition at line 58 of file MvdXmlCommon.h.

ProccesorType

enum OdMvdXml::ProccesorType

Types of MVDXML content processors.

Enumerator
kValidator	Data validation processor.
kFilter	Data filtering processor.

Definition at line 53 of file MvdXmlProcessor.h.

Function Documentation

inFieldsArray()

template<typename T>

OdResult OdMvdXml::inFieldsArray	(	OdArray< OdSmartPtr< T > > &	container,
		TiXmlNode *	pParent,
		const char *	pItemName )

A template function that reads data from mvdXML Document Object Model (DOM) into an array of objects.

Parameters

container	[out] An array of smart pointers to objects that is filled by the function.
pParent	[in] A raw pointer to the node object in the DOM tree.
pItemName	[in] A name of the item (node). Data from the item are read into the array element.

Returns

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

Definition at line 49 of file MvdXmlUtils.h.

outFieldsArray()

template<typename T>

OdResult OdMvdXml::outFieldsArray	(	OdArray< OdSmartPtr< T > > &	container,
		TiXmlNode *	pParent,
		const char *	pGroupName )

A template function that writes data from an array of objects into the mvdXML Document Object Model (DOM).

Parameters

container	[out] An array of smart pointers to objects. Data from these object should be written into mvdXML DOM nodes.
pParent	[in] A raw pointer to the node object in the DOM tree.
pGroupName	[in] A name of the group of items.

Returns

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

Definition at line 76 of file MvdXmlUtils.h.

SMARTPTR() [1/19]

OdMvdXml::SMARTPTR

(

OdMvdXmlApplicability

)

A data type that represents a smart pointer to an OdMvdXmlProcessor object.

SMARTPTR() [2/19]

OdMvdXml::SMARTPTR

(

OdMvdXmlAttributeRule

)

SMARTPTR() [3/19]

OdMvdXml::SMARTPTR

(

OdMvdXmlBody

)

SMARTPTR() [4/19]

OdMvdXml::SMARTPTR

(

OdMvdXmlConcept

)

SMARTPTR() [5/19]

OdMvdXml::SMARTPTR

(

OdMvdXmlConceptRoot

)

SMARTPTR() [6/19]

OdMvdXml::SMARTPTR

(

OdMvdXmlConceptTemplate

)

SMARTPTR() [7/19]

OdMvdXml::SMARTPTR

(

OdMvdXmlConstraint

)

SMARTPTR() [8/19]

OdMvdXml::SMARTPTR

(

OdMvdXmlDefinition

)

SMARTPTR() [9/19]

OdMvdXml::SMARTPTR

(

OdMvdXmlElement

)

SMARTPTR() [10/19]

OdMvdXml::SMARTPTR

(

OdMvdXmlEntityRule

)

SMARTPTR() [11/19]

OdMvdXml::SMARTPTR

(

OdMvdXmlExchangeRequirement

)

SMARTPTR() [12/19]

OdMvdXml::SMARTPTR

(

OdMvdXmlIdentity

)

SMARTPTR() [13/19]

OdMvdXml::SMARTPTR

(

OdMvdXmlLink

)

SMARTPTR() [14/19]

OdMvdXml::SMARTPTR

(

OdMvdXmlModelView

)

SMARTPTR() [15/19]

OdMvdXml::SMARTPTR

(

OdMvdXmlRequirement

)

SMARTPTR() [16/19]

OdMvdXml::SMARTPTR

(

OdMvdXmlRoot

)

SMARTPTR() [17/19]

OdMvdXml::SMARTPTR

(

OdMvdXmlTemplateRef

)

SMARTPTR() [18/19]

OdMvdXml::SMARTPTR

(

OdMvdXmlTemplateRule

)

SMARTPTR() [19/19]

OdMvdXml::SMARTPTR

(

OdMvdXmlTemplateRules

)