HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Alembic::Abc::ALEMBIC_VERSION_NS::OTypedScalarProperty< TRAITS > Class Template Reference

#include <OTypedScalarProperty.h>

+ Inheritance diagram for Alembic::Abc::ALEMBIC_VERSION_NS::OTypedScalarProperty< TRAITS >:

Public Types

typedef TRAITS traits_type
 
typedef OTypedScalarProperty
< TRAITS > 
this_type
 
typedef TRAITS::value_type value_type
 
- Public Types inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OScalarProperty
typedef OScalarProperty this_type
 
- Public Types inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< AbcA::ScalarPropertyWriterPtr >
typedef OBasePropertyT
< AbcA::ScalarPropertyWriterPtr
this_type
 
typedef OBasePropertyT
< AbcA::ScalarPropertyWriterPtr
operator_bool_base_type
 

Public Member Functions

 OTypedScalarProperty ()
 
template<class COMPOUND_PTR >
 OTypedScalarProperty (COMPOUND_PTR iParent, const std::string &iName, const Argument &iArg0=Argument(), const Argument &iArg1=Argument(), const Argument &iArg2=Argument())
 
 OTypedScalarProperty (AbcA::ScalarPropertyWriterPtr iProp, WrapExistingFlag iWrapFlag, const Argument &iArg0=Argument(), const Argument &iArg1=Argument())
 
void set (const value_type &iVal)
 
- Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OScalarProperty
 OScalarProperty ()
 
template<class OBJECT_PTR >
 OScalarProperty (OBJECT_PTR iParentObject, const std::string &iName, const AbcA::DataType &iDataType, const Argument &iArg0=Argument(), const Argument &iArg1=Argument(), const Argument &iArg2=Argument())
 
 OScalarProperty (AbcA::ScalarPropertyWriterPtr iPtr, WrapExistingFlag iWrapFlag, ErrorHandler::Policy iPolicy=ErrorHandler::kThrowPolicy)
 
 ~OScalarProperty ()
 
size_t getNumSamples () const
 
void set (const void *iSample)
 
void setFromPrevious ()
 
void setTimeSampling (uint32_t iIndex)
 
void setTimeSampling (AbcA::TimeSamplingPtr iTime)
 
OCompoundProperty getParent () const
 
template<class CPROP_PTR >
 OScalarProperty (CPROP_PTR iParentProp, const std::string &iName, const AbcA::DataType &iDataType, const Argument &iArg0, const Argument &iArg1, const Argument &iArg2)
 
- Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< AbcA::ScalarPropertyWriterPtr >
const AbcA::PropertyHeadergetHeader () const
 
const std::stringgetName () const
 
AbcA::PropertyType getPropertyType () const
 
bool isScalar () const
 
bool isArray () const
 
bool isCompound () const
 
bool isSimple () const
 
const AbcA::MetaDatagetMetaData () const
 
const AbcA::DataTypegetDataType () const
 
AbcA::TimeSamplingPtr getTimeSampling () const
 
OObject getObject () const
 
AbcA::ScalarPropertyWriterPtr getPtr () const
 
void reset ()
 
bool valid () const
 
 ALEMBIC_OPERATOR_BOOL (valid())
 
- Public Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::Base
ErrorHandlergetErrorHandler () const
 
ErrorHandler::Policy getErrorHandlerPolicy () const
 

Static Public Member Functions

static const char * getInterpretation ()
 
static bool matches (const AbcA::MetaData &iMetaData, SchemaInterpMatching iMatching=kStrictMatching)
 
static bool matches (const AbcA::PropertyHeader &iHeader, SchemaInterpMatching iMatching=kStrictMatching)
 

Additional Inherited Members

- Protected Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< AbcA::ScalarPropertyWriterPtr >
 OBasePropertyT ()
 
 OBasePropertyT (AbcA::ScalarPropertyWriterPtriPtr, WrapExistingFlag, ErrorHandler::Policy iPolicy)
 
- Protected Member Functions inherited from Alembic::Abc::ALEMBIC_VERSION_NS::Base
 Base ()
 
 Base (ErrorHandler::Policy iPolicy)
 
 Base (const Base &iCopy)
 
Baseoperator= (const Base &iCopy)
 
bool valid () const
 
void reset ()
 
- Protected Attributes inherited from Alembic::Abc::ALEMBIC_VERSION_NS::OBasePropertyT< AbcA::ScalarPropertyWriterPtr >
AbcA::ScalarPropertyWriterPtr m_property
 

Detailed Description

template<class TRAITS>
class Alembic::Abc::ALEMBIC_VERSION_NS::OTypedScalarProperty< TRAITS >

Definition at line 49 of file OTypedScalarProperty.h.

Member Typedef Documentation

Definition at line 56 of file OTypedScalarProperty.h.

template<class TRAITS>
typedef TRAITS Alembic::Abc::ALEMBIC_VERSION_NS::OTypedScalarProperty< TRAITS >::traits_type

Definition at line 55 of file OTypedScalarProperty.h.

template<class TRAITS>
typedef TRAITS::value_type Alembic::Abc::ALEMBIC_VERSION_NS::OTypedScalarProperty< TRAITS >::value_type

Definition at line 57 of file OTypedScalarProperty.h.

Constructor & Destructor Documentation

Create a default (empty) TypedScalarProperty ...

Definition at line 97 of file OTypedScalarProperty.h.

template<class TRAITS >
template<class COMPOUND_PTR >
Alembic::Abc::ALEMBIC_VERSION_NS::OTypedScalarProperty< TRAITS >::OTypedScalarProperty ( COMPOUND_PTR  iParent,
const std::string iName,
const Argument iArg0 = Argument(),
const Argument iArg1 = Argument(),
const Argument iArg2 = Argument() 
)

Create a new TypedScalarProperty as a child of the passed COMPOUND_PTR Arguments can specify metadata, timesampling, and error handling.

Definition at line 139 of file OTypedScalarProperty.h.

template<class TRAITS >
Alembic::Abc::ALEMBIC_VERSION_NS::OTypedScalarProperty< TRAITS >::OTypedScalarProperty ( AbcA::ScalarPropertyWriterPtr  iProp,
WrapExistingFlag  iWrapFlag,
const Argument iArg0 = Argument(),
const Argument iArg1 = Argument() 
)
inline

Wrap an existing scalar property, checking to make sure it matches data type and also (if requested) interpretation.

Definition at line 186 of file OTypedScalarProperty.h.

Member Function Documentation

template<class TRAITS>
static const char* Alembic::Abc::ALEMBIC_VERSION_NS::OTypedScalarProperty< TRAITS >::getInterpretation ( )
inlinestatic

Return the interpretation expected of this property. An empty interpretation matches everything

Definition at line 61 of file OTypedScalarProperty.h.

template<class TRAITS>
static bool Alembic::Abc::ALEMBIC_VERSION_NS::OTypedScalarProperty< TRAITS >::matches ( const AbcA::MetaData iMetaData,
SchemaInterpMatching  iMatching = kStrictMatching 
)
inlinestatic

This will check whether or not a given entity (as represented by a metadata) strictly matches the interpretation of this schema object

Definition at line 69 of file OTypedScalarProperty.h.

template<class TRAITS>
static bool Alembic::Abc::ALEMBIC_VERSION_NS::OTypedScalarProperty< TRAITS >::matches ( const AbcA::PropertyHeader iHeader,
SchemaInterpMatching  iMatching = kStrictMatching 
)
inlinestatic

This will check whether or not a given object (as represented by an object header) strictly matches the interpretation of this schema object, as well as the data type.

Definition at line 79 of file OTypedScalarProperty.h.

template<class TRAITS>
void Alembic::Abc::ALEMBIC_VERSION_NS::OTypedScalarProperty< TRAITS >::set ( const value_type iVal)
inline

Set a sample using a reference to a value-type, instead of a void*

Definition at line 126 of file OTypedScalarProperty.h.


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